diff --git a/.changeset/fair-suns-behave.md b/.changeset/fair-suns-behave.md new file mode 100644 index 000000000..49d232356 --- /dev/null +++ b/.changeset/fair-suns-behave.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": patch +--- + +Bump Redocly Core diff --git a/biome.json b/biome.json index 0593aef9c..c54ad40dc 100644 --- a/biome.json +++ b/biome.json @@ -1,5 +1,5 @@ { - "$schema": "https://biomejs.dev/schemas/1.8.1/schema.json", + "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json", "organizeImports": { "enabled": false }, diff --git a/package.json b/package.json index 9cfd6fd59..5d6c40882 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "email": "drew@pow.rs" }, "scripts": { - "build": "pnpm run -r --parallel --filter \"!*docs\" --aggregate-output build", + "build": "pnpm run -r --filter \"!*docs\" --aggregate-output build", "lint": "pnpm run -r --parallel --aggregate-output lint", "format": "pnpm run -r --parallel --aggregate-output format", "test": "pnpm run -r --parallel --aggregate-output test", @@ -17,17 +17,17 @@ "version": "pnpm run build && changeset version && pnpm i" }, "devDependencies": { - "@biomejs/biome": "^1.8.3", + "@biomejs/biome": "^1.9.2", "@changesets/changelog-github": "^0.5.0", - "@changesets/cli": "^2.27.7", - "@playwright/test": "^1.46.1", - "@size-limit/preset-small-lib": "^11.1.4", - "@types/node": "^22.5.2", + "@changesets/cli": "^2.27.8", + "@playwright/test": "^1.47.1", + "@size-limit/preset-small-lib": "^11.1.5", + "@types/node": "^22.5.5", "del-cli": "^5.1.0", "prettier": "^3.3.3", - "size-limit": "^11.1.4", - "typescript": "^5.5.4", - "vitest": "^2.0.5" + "size-limit": "^11.1.5", + "typescript": "^5.6.2", + "vitest": "^2.1.1" }, "size-limit": [ { diff --git a/packages/openapi-fetch/biome.json b/packages/openapi-fetch/biome.json index 6ea8f6cf5..1c365083b 100644 --- a/packages/openapi-fetch/biome.json +++ b/packages/openapi-fetch/biome.json @@ -1,5 +1,5 @@ { - "$schema": "https://biomejs.dev/schemas/1.8.1/schema.json", + "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json", "extends": ["../../biome.json"], "files": { "include": ["./src/", "./test/"], diff --git a/packages/openapi-fetch/examples/nextjs/package.json b/packages/openapi-fetch/examples/nextjs/package.json index 2d784a08e..75da1f2dc 100644 --- a/packages/openapi-fetch/examples/nextjs/package.json +++ b/packages/openapi-fetch/examples/nextjs/package.json @@ -12,7 +12,7 @@ "react-dom": "^18.3.1" }, "devDependencies": { - "@types/react": "^18.3.3", + "@types/react": "^18.3.8", "@types/react-dom": "^18.3.0", "openapi-typescript": "workspace:^", "typescript": "5.4.5" diff --git a/packages/openapi-fetch/examples/react-query/package.json b/packages/openapi-fetch/examples/react-query/package.json index 268417b91..20c7df8aa 100644 --- a/packages/openapi-fetch/examples/react-query/package.json +++ b/packages/openapi-fetch/examples/react-query/package.json @@ -6,7 +6,7 @@ "dev": "vite dev" }, "dependencies": { - "@tanstack/react-query": "^5.53.3", + "@tanstack/react-query": "^5.56.2", "openapi-fetch": "workspace:^", "openapi-typescript": "workspace:^", "react": "^18.3.1", @@ -16,7 +16,7 @@ "@types/react": "18.3.1", "@types/react-dom": "18.3.0", "@vitejs/plugin-react-swc": "^3.7.0", - "typescript": "^5.5.4", - "vite": "^5.4.3" + "typescript": "^5.6.2", + "vite": "^5.4.6" } } diff --git a/packages/openapi-fetch/examples/sveltekit/package.json b/packages/openapi-fetch/examples/sveltekit/package.json index 5a6ee2fce..03198c381 100644 --- a/packages/openapi-fetch/examples/sveltekit/package.json +++ b/packages/openapi-fetch/examples/sveltekit/package.json @@ -11,14 +11,14 @@ "openapi-fetch": "workspace:^" }, "devDependencies": { - "@sveltejs/adapter-auto": "^3.2.4", - "@sveltejs/kit": "^2.5.25", + "@sveltejs/adapter-auto": "^3.2.5", + "@sveltejs/kit": "^2.5.28", "@sveltejs/vite-plugin-svelte": "^3.1.2", "openapi-typescript": "workspace:^", "svelte": "^4.2.19", "svelte-check": "^3.8.6", "tslib": "^2.7.0", - "typescript": "^5.5.4", - "vite": "^5.4.3" + "typescript": "^5.6.2", + "vite": "^5.4.6" } } diff --git a/packages/openapi-fetch/examples/vue-3/package.json b/packages/openapi-fetch/examples/vue-3/package.json index 1a83adf4c..23034b54c 100644 --- a/packages/openapi-fetch/examples/vue-3/package.json +++ b/packages/openapi-fetch/examples/vue-3/package.json @@ -12,15 +12,15 @@ }, "dependencies": { "openapi-fetch": "workspace:^", - "vue": "^3.5.0" + "vue": "^3.5.6" }, "devDependencies": { "@tsconfig/node20": "^20.1.4", - "@vitejs/plugin-vue": "^5.1.3", + "@vitejs/plugin-vue": "^5.1.4", "@vue/tsconfig": "^0.5.1", "openapi-typescript": "workspace:^", - "typescript": "^5.5.4", - "vite": "^5.4.3", - "vue-tsc": "^2.1.4" + "typescript": "^5.6.2", + "vite": "^5.4.6", + "vue-tsc": "^2.1.6" } } diff --git a/packages/openapi-fetch/package.json b/packages/openapi-fetch/package.json index 24e861299..64a0efa41 100644 --- a/packages/openapi-fetch/package.json +++ b/packages/openapi-fetch/package.json @@ -79,7 +79,7 @@ "openapi-typescript-codegen": "^0.25.0", "openapi-typescript-fetch": "^2.0.0", "superagent": "^10.1.0", - "typescript": "^5.5.4", - "vite": "^5.4.2" + "typescript": "^5.6.2", + "vite": "^5.4.6" } } diff --git a/packages/openapi-fetch/test/common/schemas/common.d.ts b/packages/openapi-fetch/test/common/schemas/common.d.ts index 6e4d561a8..b684c117e 100644 --- a/packages/openapi-fetch/test/common/schemas/common.d.ts +++ b/packages/openapi-fetch/test/common/schemas/common.d.ts @@ -4,779 +4,779 @@ */ export interface paths { - "/resources": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/resources/{id}": { - parameters: { - query?: { - version?: number; - format?: string; - }; - header?: never; - path: { - id: number; - }; - cookie?: never; - }; - get: { - parameters: { - query?: { - version?: number; - format?: string; - }; - header?: never; - path: { - id: number; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Resource"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/error-404": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/error-500": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - /** @description Internal server error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/error-default": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - /** @description Unexpected error */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/media-json": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/media-vnd-json": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/vnd.api+json": components["schemas"]["ResourceList"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/media-text": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "text/html": string; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/media-multiple": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - foo: string; - }; - "application/ld+json": { - bar: string; - }; - "application/json5": { - baz: string; - }; - "text/html": string; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/mismatched-response": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Resource"]; - }; - }; - /** @description Created */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResourceList"]; - }; - }; - /** @description Unexpected error */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/mismatched-errors": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Resource"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Internal server error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/path-params/{string}": { - parameters: { - query?: never; - header?: never; - path: { - string: string; - }; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path: { - string: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - success?: boolean; - }; - }; - }; - /** @description Unexpected error */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/path-params/{simple_primitive}/{simple_obj_flat}/{simple_arr_flat}/{simple_obj_explode*}/{simple_arr_explode*}/{.label_primitive}/{.label_obj_flat}/{.label_arr_flat}/{.label_obj_explode*}/{.label_arr_explode*}/{;matrix_primitive}/{;matrix_obj_flat}/{;matrix_arr_flat}/{;matrix_obj_explode*}/{;matrix_arr_explode*}": { - parameters: { - query?: never; - header?: never; - path: { - simple_primitive: string; - simple_obj_flat: { - a: string; - c: string; - }; - simple_arr_flat: number[]; - simple_obj_explode: { - e: string; - g: string; - }; - simple_arr_explode: number[]; - label_primitive: string; - label_obj_flat: { - a: string; - c: string; - }; - label_arr_flat: number[]; - label_obj_explode: { - e: string; - g: string; - }; - label_arr_explode: number[]; - matrix_primitive: string; - matrix_obj_flat: { - a: string; - c: string; - }; - matrix_arr_flat: number[]; - matrix_obj_explode: { - e: string; - g: string; - }; - matrix_arr_explode: number[]; - }; - cookie?: never; - }; - get: { - parameters: { - query?: never; - header?: never; - path: { - simple_primitive: string; - simple_obj_flat: { - a: string; - c: string; - }; - simple_arr_flat: number[]; - simple_obj_explode: { - e: string; - g: string; - }; - simple_arr_explode: number[]; - label_primitive: string; - label_obj_flat: { - a: string; - c: string; - }; - label_arr_flat: number[]; - label_obj_explode: { - e: string; - g: string; - }; - label_arr_explode: number[]; - matrix_primitive: string; - matrix_obj_flat: { - a: string; - c: string; - }; - matrix_arr_flat: number[]; - matrix_obj_explode: { - e: string; - g: string; - }; - matrix_arr_explode: number[]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - status: string; - }; - }; - }; - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/header-params": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get: operations["getHeaderParams"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/query-params": { - parameters: { - query?: { - string?: string; - number?: number; - boolean?: boolean; - array?: string[]; - object?: { - foo: string; - bar: string; - }; - }; - header?: never; - path?: never; - cookie?: never; - }; - get: { - parameters: { - query?: { - string?: string; - number?: number; - boolean?: boolean; - array?: string[]; - object?: { - foo: string; - bar: string; - }; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - status: string; - }; - }; - }; - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; - }; + "/resources": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + /** @description Internal Server Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/resources/{id}": { + parameters: { + query?: { + version?: number; + format?: string; + }; + header?: never; + path: { + id: number; + }; + cookie?: never; + }; + get: { + parameters: { + query?: { + version?: number; + format?: string; + }; + header?: never; + path: { + id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Resource"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/error-404": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/error-500": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/error-default": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + /** @description Unexpected error */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/media-json": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/media-vnd-json": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["ResourceList"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/media-text": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "text/html": string; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/media-multiple": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + foo: string; + }; + "application/ld+json": { + bar: string; + }; + "application/json5": { + baz: string; + }; + "text/html": string; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/mismatched-response": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Resource"]; + }; + }; + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ResourceList"]; + }; + }; + /** @description Unexpected error */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/mismatched-errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Resource"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/path-params/{string}": { + parameters: { + query?: never; + header?: never; + path: { + string: string; + }; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + string: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + success?: boolean; + }; + }; + }; + /** @description Unexpected error */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/path-params/{simple_primitive}/{simple_obj_flat}/{simple_arr_flat}/{simple_obj_explode*}/{simple_arr_explode*}/{.label_primitive}/{.label_obj_flat}/{.label_arr_flat}/{.label_obj_explode*}/{.label_arr_explode*}/{;matrix_primitive}/{;matrix_obj_flat}/{;matrix_arr_flat}/{;matrix_obj_explode*}/{;matrix_arr_explode*}": { + parameters: { + query?: never; + header?: never; + path: { + simple_primitive: string; + simple_obj_flat: { + a: string; + c: string; + }; + simple_arr_flat: number[]; + simple_obj_explode: { + e: string; + g: string; + }; + simple_arr_explode: number[]; + label_primitive: string; + label_obj_flat: { + a: string; + c: string; + }; + label_arr_flat: number[]; + label_obj_explode: { + e: string; + g: string; + }; + label_arr_explode: number[]; + matrix_primitive: string; + matrix_obj_flat: { + a: string; + c: string; + }; + matrix_arr_flat: number[]; + matrix_obj_explode: { + e: string; + g: string; + }; + matrix_arr_explode: number[]; + }; + cookie?: never; + }; + get: { + parameters: { + query?: never; + header?: never; + path: { + simple_primitive: string; + simple_obj_flat: { + a: string; + c: string; + }; + simple_arr_flat: number[]; + simple_obj_explode: { + e: string; + g: string; + }; + simple_arr_explode: number[]; + label_primitive: string; + label_obj_flat: { + a: string; + c: string; + }; + label_arr_flat: number[]; + label_obj_explode: { + e: string; + g: string; + }; + label_arr_explode: number[]; + matrix_primitive: string; + matrix_obj_flat: { + a: string; + c: string; + }; + matrix_arr_flat: number[]; + matrix_obj_explode: { + e: string; + g: string; + }; + matrix_arr_explode: number[]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + status: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/header-params": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get: operations["getHeaderParams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/query-params": { + parameters: { + query?: { + string?: string; + number?: number; + boolean?: boolean; + array?: string[]; + object?: { + foo: string; + bar: string; + }; + }; + header?: never; + path?: never; + cookie?: never; + }; + get: { + parameters: { + query?: { + string?: string; + number?: number; + boolean?: boolean; + array?: string[]; + object?: { + foo: string; + bar: string; + }; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + status: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; } export type webhooks = Record; export interface components { - schemas: { - Error: { - code: number; - message: string; - }; - Resource: { - id: number; + schemas: { + Error: { + code: number; + message: string; + }; + Resource: { + id: number; + }; + ResourceList: components["schemas"]["Resource"][]; }; - ResourceList: components["schemas"]["Resource"][]; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; } export type $defs = Record; export interface operations { - getHeaderParams: { - parameters: { - query?: never; - header: { - "x-required-header": string; - }; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - status: string; - }; - }; - }; - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["Error"]; - }; - }; + getHeaderParams: { + parameters: { + query?: never; + header: { + "x-required-header": string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + status: string; + }; + }; + }; + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; }; - }; } diff --git a/packages/openapi-fetch/test/examples/schemas/github.d.ts b/packages/openapi-fetch/test/examples/schemas/github.d.ts index 054f0d22d..9f2016e9e 100644 --- a/packages/openapi-fetch/test/examples/schemas/github.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/github.d.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ post: operations["repos/create-attestation"]; delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/codeowners/errors": { parameters: { query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -17305,6 +17431,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export interface components { repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -20025,6 +20092,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export interface components { * "192.0.2.1" * ] */ actions_macos?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + codespaces?: string[]; /** @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + artifact_attestations?: { + /** @example [ + * "example" + * ] */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -21686,8 +21768,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export interface components { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export interface components { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -24354,8 +24455,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; @@ -26417,6 +26519,7 @@ export interface components { site_admin?: boolean; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -26820,6 +26923,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -27382,6 +27486,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -31600,6 +31729,21 @@ export interface components { type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -35372,7 +35516,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -38649,6 +38793,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -38890,6 +39036,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39131,6 +39279,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -40132,7 +40282,7 @@ export interface components { "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export interface components { "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -81847,6 +81998,70 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ created_at: string; event: string; @@ -85137,7 +85352,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; @@ -85476,6 +85690,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + epss_percentile?: 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 results before this cursor. 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)." */ before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85485,7 +85705,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; header?: never; path?: never; @@ -86460,7 +86680,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86501,6 +86721,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "activity/list-public-events": { parameters: { query?: { @@ -89660,6 +89918,20 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -89696,6 +89968,12 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89853,6 +90131,16 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -89883,6 +90171,11 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93466,7 +93759,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93487,7 +93780,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -93498,7 +93791,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93525,7 +93818,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93572,7 +93865,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93903,7 +94196,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -93920,7 +94215,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94007,9 +94304,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94039,8 +94334,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94156,9 +94450,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94216,7 +94507,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94435,6 +94726,44 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "teams/list": { parameters: { query?: { @@ -96628,7 +96957,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ status?: string; @@ -96693,7 +97022,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -96710,7 +97041,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99467,7 +99800,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -99937,7 +100269,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101724,6 +102055,35 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "repos/codeowners-errors": { parameters: { query?: { @@ -103115,7 +103475,15 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -104926,7 +105294,15 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; "git/get-blob": { @@ -110049,6 +110425,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -110764,9 +111141,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -110796,8 +111171,7 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -110922,9 +111296,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -110984,7 +111355,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111168,6 +111539,60 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -116165,7 +116590,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116182,7 +116609,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts index e1f03ff19..8fd2077d5 100644 --- a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts @@ -106,7 +106,7 @@ export interface paths { * *

Test-mode accounts can be deleted at any time.

* - *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

+ *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

* *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ delete: operations["DeleteAccountsAccount"]; @@ -627,6 +627,92 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/billing/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists billing active and inactive alerts

*/ + get: operations["GetBillingAlerts"]; + put?: never; + /** @description

Creates a billing alert

*/ + post: operations["PostBillingAlerts"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a billing alert given an ID

*/ + get: operations["GetBillingAlertsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/activate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Reactivates this alert, allowing it to trigger again.

*/ + post: operations["PostBillingAlertsIdActivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Archives this alert, removing it from the list view and APIs. This is non-reversible.

*/ + post: operations["PostBillingAlertsIdArchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/deactivate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Deactivates this alert, preventing it from triggering.

*/ + post: operations["PostBillingAlertsIdDeactivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/billing/meter_event_adjustments": { parameters: { query?: never; @@ -2549,6 +2635,74 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoice_rendering_templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

List all templates, ordered by creation date, with the most recently created template appearing first.

*/ + get: operations["GetInvoiceRenderingTemplates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

*/ + get: operations["GetInvoiceRenderingTemplatesTemplate"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

*/ + post: operations["PostInvoiceRenderingTemplatesTemplateArchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}/unarchive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

*/ + post: operations["PostInvoiceRenderingTemplatesTemplateUnarchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoiceitems": { parameters: { query?: never; @@ -3548,7 +3702,10 @@ export interface paths { * return to the requires_confirmation state * after those actions are completed. Your server needs to then * explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt.

*/ + * attempt. + * There is a variable upper limit on how many times a PaymentIntent can be confirmed. + * After this limit is reached, any further calls to this endpoint will + * transition the PaymentIntent to the canceled state.

*/ post: operations["PostPaymentIntentsIntentConfirm"]; delete?: never; options?: never; @@ -4270,7 +4427,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ + /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ get: operations["GetQuotesQuotePdf"]; put?: never; post?: never; @@ -5164,6 +5321,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/tax/calculations/{calculation}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

*/ + get: operations["GetTaxCalculationsCalculation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/tax/calculations/{calculation}/line_items": { parameters: { query?: never; @@ -5880,6 +6054,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/settlements": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Allows the user to create an Issuing settlement.

*/ + post: operations["PostTestHelpersIssuingSettlements"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/transactions/create_force_capture": { parameters: { query?: never; @@ -7378,13 +7569,13 @@ export interface components { account_payments_settings: { /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. */ statement_descriptor?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ + /** @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ + /** @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_kanji?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. */ + /** @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. */ + /** @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountPayoutSettings */ @@ -7430,7 +7621,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration"; + code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration" | "verification_supportability"; /** @description An informative message that indicates the error type and provides additional details about the error. */ reason: string; /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ @@ -8049,6 +8240,37 @@ export interface components { */ void_at?: number | null; }; + /** + * ThresholdsResourceAlert + * @description A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests. + */ + "billing.alert": { + /** + * @description Defines the type of the alert. + * @enum {string} + */ + alert_type: "usage_threshold"; + /** @description Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers). */ + filter?: components["schemas"]["thresholds_resource_alert_filter"] | null; + /** @description Unique identifier for the object. */ + id: string; + /** @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 String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.alert"; + /** + * @description Status of the alert. This can be active, inactive or archived. + * @enum {string|null} + */ + status?: "active" | "archived" | "inactive" | null; + /** @description Title of the alert. */ + title: string; + /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ + usage_threshold_config?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; + }; /** * BillingMeter * @description A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. @@ -8181,6 +8403,18 @@ export interface components { */ start_time: number; }; + /** BillingClocksResourceStatusDetailsAdvancingStatusDetails */ + billing_clocks_resource_status_details_advancing_status_details: { + /** + * Format: unix-time + * @description The `frozen_time` that the Test Clock is advancing towards. + */ + target_frozen_time: number; + }; + /** BillingClocksResourceStatusDetailsStatusDetails */ + billing_clocks_resource_status_details_status_details: { + advancing?: components["schemas"]["billing_clocks_resource_status_details_advancing_status_details"]; + }; /** billing_details */ billing_details: { /** @description Billing address. */ @@ -8393,11 +8627,11 @@ export interface components { address_zip_check?: string | null; /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ available_payout_methods?: ("instant" | "standard")[] | null; - /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ + /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; - /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ currency?: string | null; /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -8498,7 +8732,7 @@ export interface components { /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; billing_details: components["schemas"]["billing_details"]; - /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This only works for card payments. */ + /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. */ calculated_statement_descriptor?: string | null; /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ captured: boolean; @@ -8580,11 +8814,13 @@ export interface components { review?: (string | components["schemas"]["review"]) | null; /** @description Shipping information for the charge. */ shipping?: components["schemas"]["shipping"] | null; - /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ + /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ source_transfer?: (string | components["schemas"]["transfer"]) | null; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string | null; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string | null; /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. @@ -8779,7 +9015,7 @@ export interface components { /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ recovered_from?: string | null; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; @@ -8856,11 +9092,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -8875,11 +9111,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8889,11 +9125,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8903,11 +9139,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8917,11 +9153,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -8931,11 +9167,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8945,11 +9181,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -8959,11 +9195,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8975,11 +9211,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9000,11 +9236,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9018,11 +9254,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9051,11 +9287,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9065,11 +9301,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9079,11 +9315,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9093,11 +9329,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9107,11 +9343,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9121,11 +9357,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9135,11 +9371,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9151,11 +9387,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9165,11 +9401,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9179,11 +9415,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9193,11 +9429,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9209,11 +9445,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9223,11 +9459,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9237,11 +9473,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9260,11 +9496,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9279,11 +9515,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9293,11 +9529,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9342,11 +9578,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9362,11 +9598,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -10462,6 +10698,10 @@ export interface components { * CustomerSessionResourceCustomerSession * @description A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access * control over a Customer. + * + * Related guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), + * [Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session), + * [Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer). */ customer_session: { /** @description The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`. @@ -10530,7 +10770,7 @@ export interface components { * @enum {string} */ payment_method_redisplay: "disabled" | "enabled"; - /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `10`. */ + /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ payment_method_redisplay_limit?: number | null; /** * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. @@ -11158,6 +11398,7 @@ export interface components { }; /** DisputePaymentMethodDetails */ dispute_payment_method_details: { + amazon_pay?: components["schemas"]["dispute_payment_method_details_amazon_pay"]; card?: components["schemas"]["dispute_payment_method_details_card"]; klarna?: components["schemas"]["dispute_payment_method_details_klarna"]; paypal?: components["schemas"]["dispute_payment_method_details_paypal"]; @@ -11165,7 +11406,15 @@ export interface components { * @description Payment method type. * @enum {string} */ - type: "card" | "klarna" | "paypal"; + type: "amazon_pay" | "card" | "klarna" | "paypal"; + }; + /** DisputePaymentMethodDetailsAmazonPay */ + dispute_payment_method_details_amazon_pay: { + /** + * @description The AmazonPay dispute type, chargeback or claim + * @enum {string|null} + */ + dispute_type?: "chargeback" | "claim" | null; }; /** DisputePaymentMethodDetailsCard */ dispute_payment_method_details_card: { @@ -11487,7 +11736,7 @@ export interface components { * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ - purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @description The size of the file object in bytes. */ size: number; /** @description A suitable title for the document. */ @@ -12413,6 +12662,8 @@ export interface components { provided_details?: components["schemas"]["gelato_provided_details"] | null; /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ redaction?: components["schemas"]["verification_session_redaction"] | null; + /** @description Token referencing a Customer resource. */ + related_customer?: string | null; /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} @@ -12542,6 +12793,11 @@ export interface components { /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ auto_advance?: boolean; automatic_tax: components["schemas"]["automatic_tax"]; + /** + * Format: unix-time + * @description The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. + */ + automatically_finalizes_at?: number | null; /** * @description Indicates the reason why the invoice was created. * @@ -12866,6 +13122,40 @@ export interface components { */ page_size?: "a4" | "auto" | "letter" | null; }; + /** + * InvoiceRenderingTemplate + * @description Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates + * can be created from within the Dashboard, and they can be used over the API when creating invoices. + */ + invoice_rendering_template: { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Unique identifier for the object. */ + id: string; + /** @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 A brief description of the template, hidden from customers */ + nickname?: string | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "invoice_rendering_template"; + /** + * @description The status of the template, one of `active` or `archived`. + * @enum {string} + */ + status: "active" | "archived"; + /** @description Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering */ + version: number; + }; /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ @@ -12877,6 +13167,8 @@ export interface components { invoice_setting_customer_rendering_options: { /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ amount_tax_display?: string | null; + /** @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. */ + template?: string | null; }; /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { @@ -13056,14 +13348,18 @@ export interface components { amount_tax_display?: string | null; /** @description Invoice pdf rendering options */ pdf?: components["schemas"]["invoice_rendering_pdf"] | null; + /** @description ID of the rendering template that the invoice is formatted by. */ + template?: string | null; + /** @description Version of the rendering template that the invoice is using. */ + template_version?: number | null; }; /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -13438,7 +13734,10 @@ export interface components { "issuing.settlement": { /** @description The Bank Identification Number reflecting this settlement record. */ bin: string; - /** @description The date that the transactions are cleared and posted to user's accounts. */ + /** + * Format: unix-time + * @description The date that the transactions are cleared and posted to user's accounts. + */ clearing_date: number; /** * Format: unix-time @@ -13460,10 +13759,10 @@ export interface components { /** @description The total net amount required to settle with the network. */ net_total: number; /** - * @description The card network for this settlement report. One of ["visa"] + * @description The card network for this settlement report. One of ["visa", "maestro"] * @enum {string} */ - network: "visa"; + network: "maestro" | "visa"; /** @description The total amount of fees owed to the network. */ network_fees: number; /** @description The Settlement Identification Number assigned by the network. */ @@ -13475,6 +13774,11 @@ export interface components { object: "issuing.settlement"; /** @description One of `international` or `uk_national_net`. */ settlement_service: string; + /** + * @description The current processing status of this settlement. + * @enum {string} + */ + status: "complete" | "pending"; /** @description The total number of transactions reflected in this settlement. */ transaction_count: number; /** @description The total transaction amount reflected in this settlement. */ @@ -13907,7 +14211,7 @@ export interface components { * @description The delivery status of the card. * @enum {string|null} */ - status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | null; + status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | "submitted" | null; /** @description A tracking number for a card shipment. */ tracking_number?: string | null; /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ @@ -14531,7 +14835,7 @@ export interface components { /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description?: string; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; /** @description Unique identifier for the object. */ @@ -14548,6 +14852,16 @@ export interface components { /** @description The taxes applied to the line item. */ taxes?: components["schemas"]["line_items_tax_amount"][]; }; + /** klarna_address */ + klarna_address: { + /** @description The payer address country */ + country?: string | null; + }; + /** klarna_payer_details */ + klarna_payer_details: { + /** @description The payer's address */ + address?: components["schemas"]["klarna_address"] | null; + }; /** LegalEntityCompany */ legal_entity_company: { address?: components["schemas"]["address"]; @@ -14665,7 +14979,12 @@ export interface components { /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ user_agent?: string | null; }; - /** InvoiceLineItem */ + /** + * InvoiceLineItem + * @description Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice. + * + * Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items). + */ line_item: { /** @description The amount, in cents (or local equivalent). */ amount: number; @@ -14712,9 +15031,9 @@ export interface components { /** @description The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ subscription_item?: string | components["schemas"]["subscription_item"]; /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts: components["schemas"]["invoice_tax_amount"][]; /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates: components["schemas"]["tax_rate"][]; /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} @@ -15111,6 +15430,14 @@ export interface components { */ status: "available" | "unavailable"; }; + /** PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet */ + payment_flows_private_payment_methods_card_present_common_wallet: { + /** + * @description The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. + * @enum {string} + */ + type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"; + }; /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ @@ -15190,7 +15517,7 @@ export interface components { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -15234,19 +15561,21 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; /** @description Shipping information for this PaymentIntent. */ shipping?: components["schemas"]["shipping"] | null; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string | null; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string | null; /** * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). @@ -15550,7 +15879,7 @@ export interface components { alipay?: components["schemas"]["payment_method_options_alipay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["payment_method_options_amazon_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; au_becs_debit?: components["schemas"]["payment_intent_payment_method_options_au_becs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; - bacs_debit?: components["schemas"]["payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + bacs_debit?: components["schemas"]["payment_intent_payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; bancontact?: components["schemas"]["payment_method_options_bancontact"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; blik?: components["schemas"]["payment_intent_payment_method_options_blik"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; boleto?: components["schemas"]["payment_method_options_boleto"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -15590,11 +15919,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15609,11 +15938,26 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session" | "on_session"; + }; + /** payment_intent_payment_method_options_bacs_debit */ + payment_intent_payment_method_options_bacs_debit: { + mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_bacs_debit"]; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15623,11 +15967,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15649,7 +15993,7 @@ export interface components { * @description Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. * @enum {string} @@ -15680,11 +16024,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15698,11 +16042,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15717,11 +16061,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -15743,6 +16087,8 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; + /** payment_intent_payment_method_options_mandate_options_bacs_debit */ + payment_intent_payment_method_options_mandate_options_bacs_debit: Record; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ payment_intent_payment_method_options_mandate_options_sepa_debit: Record; /** payment_intent_payment_method_options_mobilepay */ @@ -15755,11 +16101,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15770,11 +16116,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15786,11 +16132,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15807,11 +16153,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15856,11 +16202,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -16134,9 +16480,9 @@ export interface components { * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. */ + /** @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. */ statement_descriptor?: string | null; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ statement_descriptor_suffix?: string | null; /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ transfer_group?: string | null; @@ -16194,6 +16540,8 @@ export interface components { payment_links_resource_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session. */ enabled: boolean; + /** @enum {string} */ + required: "if_supported" | "never"; }; /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { @@ -16406,6 +16754,8 @@ export interface components { last4?: string | null; /** @description Contains information about card networks that can be used to process the payment. */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; + /** @description Details about payment methods collected offline. */ + offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ preferred_locales?: string[] | null; /** @@ -16413,6 +16763,7 @@ export interface components { * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; + wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_card_present_networks */ payment_method_card_present_networks: { @@ -16753,6 +17104,8 @@ export interface components { payment_method_details_card: { /** @description The authorized amount. */ amount_authorized?: number | null; + /** @description Authorization code on the charge. */ + authorization_code?: string | null; /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** @@ -16871,10 +17224,7 @@ export interface components { last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. - * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. - * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). - * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; /** @description Details about payments collected offline. */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; @@ -16889,6 +17239,7 @@ export interface components { read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ receipt?: components["schemas"]["payment_method_details_card_present_receipt"] | null; + wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_details_card_present_offline */ payment_method_details_card_present_offline: { @@ -16897,6 +17248,11 @@ export interface components { * @description Time at which the payment was collected while offline */ stored_at?: number | null; + /** + * @description The method used to process this payment method offline. Only deferred is allowed. + * @enum {string|null} + */ + type?: "deferred" | null; }; /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { @@ -17072,10 +17428,7 @@ export interface components { last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. - * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. - * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). - * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ preferred_locales?: string[] | null; @@ -17113,6 +17466,8 @@ export interface components { }; /** payment_method_details_klarna */ payment_method_details_klarna: { + /** @description The payer details for this transaction. */ + payer_details?: components["schemas"]["klarna_payer_details"] | null; /** @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ payment_method_category?: string | null; @@ -17438,11 +17793,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17460,11 +17815,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17474,11 +17829,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17493,29 +17848,15 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; }; - /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { - /** - * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. - * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. - * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). - * @enum {string} - */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** @@ -17526,11 +17867,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17542,11 +17883,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -17619,11 +17960,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -17639,11 +17980,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17674,11 +18015,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17688,11 +18029,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17702,11 +18043,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17716,11 +18057,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17739,11 +18080,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17764,11 +18105,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17778,11 +18119,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17794,11 +18135,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17808,11 +18149,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17822,11 +18163,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17845,11 +18186,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17863,11 +18204,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17877,11 +18218,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17896,11 +18237,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17915,11 +18256,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17929,11 +18270,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17958,11 +18299,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17972,11 +18313,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -18340,10 +18681,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -18351,6 +18692,11 @@ export interface components { payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ enabled: boolean; + /** + * @description Indicates whether a tax ID is required on the payment page + * @enum {string} + */ + required: "if_supported" | "never"; }; /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { @@ -18561,7 +18907,8 @@ export interface components { }; /** PersonAdditionalTOSAcceptances */ person_additional_tos_acceptances: { - account: components["schemas"]["person_additional_tos_acceptance"]; + /** @description Details on the legal guardian's acceptance of the main Stripe service agreement. */ + account?: components["schemas"]["person_additional_tos_acceptance"] | null; }; /** PersonFutureRequirements */ person_future_requirements: { @@ -20198,7 +20545,7 @@ export interface components { object: "setup_intent"; /** @description The account (if any) for which the setup is intended. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ + /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; /** @description Information about the payment method configuration used for this Setup Intent. */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; @@ -20254,6 +20601,7 @@ export interface components { setup_intent_payment_method_options: { acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["setup_intent_payment_method_options_amazon_pay"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; + bacs_debit?: components["schemas"]["setup_intent_payment_method_options_bacs_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["setup_intent_payment_method_options_card"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card_present?: components["schemas"]["setup_intent_payment_method_options_card_present"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; @@ -20277,6 +20625,10 @@ export interface components { }; /** setup_intent_payment_method_options_amazon_pay */ setup_intent_payment_method_options_amazon_pay: Record; + /** setup_intent_payment_method_options_bacs_debit */ + setup_intent_payment_method_options_bacs_debit: { + mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_bacs_debit"]; + }; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** @description Configuration options for setting up an eMandate for cards issued in India. */ @@ -20285,7 +20637,7 @@ export interface components { * @description Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -20350,6 +20702,8 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; + /** setup_intent_payment_method_options_mandate_options_bacs_debit */ + setup_intent_payment_method_options_mandate_options_bacs_debit: Record; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ setup_intent_payment_method_options_mandate_options_sepa_debit: Record; /** setup_intent_payment_method_options_paypal */ @@ -21208,7 +21562,7 @@ export interface components { * @description Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -21906,10 +22260,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -22039,6 +22393,7 @@ export interface components { local_lease_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_local_lease_tax"]; /** @description Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ state: string; + state_sales_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_state_sales_tax"]; /** * @description Type of registration in the US. * @enum {string} @@ -22055,6 +22410,21 @@ export interface components { /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ jurisdiction: string; }; + /** TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax */ + tax_product_registrations_resource_country_options_us_state_sales_tax: { + /** @description Elections for the state sales tax registration. */ + elections?: components["schemas"]["tax_product_registrations_resource_country_options_us_state_sales_tax_election"][]; + }; + /** TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection */ + tax_product_registrations_resource_country_options_us_state_sales_tax_election: { + /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + jurisdiction?: string; + /** + * @description The type of the election for the state sales tax registration. + * @enum {string} + */ + type: "local_use_tax" | "simplified_sellers_use_tax" | "single_local_use_tax"; + }; /** TaxProductResourceCustomerDetails */ tax_product_resource_customer_details: { /** @description The customer's postal address (for example, home or business location). */ @@ -22077,10 +22447,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value: string; }; @@ -22410,7 +22780,7 @@ export interface components { /** @description Serial number of the reader. */ serial_number: string; /** - * @description The networking status of the reader. + * @description The networking status of the reader. We do not recommend using this field in flows that may block taking payments. * @enum {string|null} */ status?: "offline" | "online" | null; @@ -22642,6 +23012,7 @@ export interface components { * @enum {string} */ status: "advancing" | "internal_failure" | "ready"; + status_details: components["schemas"]["billing_clocks_resource_status_details_status_details"]; }; /** three_d_secure_details */ three_d_secure_details: { @@ -22724,6 +23095,26 @@ export interface components { /** @description Whether 3D Secure is supported on this card. */ supported: boolean; }; + /** ThresholdsResourceAlertFilter */ + thresholds_resource_alert_filter: { + /** @description Limit the scope of the alert to this customer ID */ + customer?: (string | components["schemas"]["customer"]) | null; + }; + /** + * ThresholdsResourceUsageThresholdConfig + * @description The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. + */ + thresholds_resource_usage_threshold_config: { + /** @description The value at which this alert will trigger. */ + gte: number; + /** @description The [Billing Meter](/api/billing/meter) ID whose usage is monitored. */ + meter: string | components["schemas"]["billing.meter"]; + /** + * @description Defines how the alert will behave. + * @enum {string} + */ + recurrence: "one_time"; + }; /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -22894,7 +23285,7 @@ export interface components { }; /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ reversed: boolean; - /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ + /** @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. */ source_transaction?: (string | components["schemas"]["charge"]) | null; /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ source_type?: string; @@ -23090,7 +23481,7 @@ export interface components { */ "treasury.financial_account": { /** @description The array of paths to active Features in the Features hash. */ - active_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + active_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; balance: components["schemas"]["treasury_financial_accounts_resource_balance"]; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; @@ -23116,11 +23507,11 @@ export interface components { */ object: "treasury.financial_account"; /** @description The array of paths to pending Features in the Features hash. */ - pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; /** @description The set of functionalities that the platform can restrict on the FinancialAccount. */ platform_restrictions?: components["schemas"]["treasury_financial_accounts_resource_platform_restrictions"] | null; /** @description The array of paths to restricted Features in the Features hash. */ - restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; /** * @description The enum specifying what state the account is in. * @enum {string} @@ -23151,7 +23542,9 @@ export interface components { }; /** * TreasuryInboundTransfersResourceInboundTransfer - * @description Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + * @description Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + * + * Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) */ "treasury.inbound_transfer": { /** @description Amount (in cents) transferred. */ @@ -23206,9 +23599,11 @@ export interface components { }; /** * TreasuryOutboundPaymentsResourceOutboundPayment - * @description Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + * @description Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). * * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. + * + * Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) */ "treasury.outbound_payment": { /** @description Amount (in cents) transferred. */ @@ -23271,9 +23666,11 @@ export interface components { }; /** * TreasuryOutboundTransfersResourceOutboundTransfer - * @description Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + * @description Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. * * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. + * + * Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) */ "treasury.outbound_transfer": { /** @description Amount (in cents) transferred. */ @@ -23400,7 +23797,7 @@ export interface components { * @description Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. * @enum {string|null} */ - failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "other" | null; + failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "international_transaction" | "other" | null; /** @description The FinancialAccount that funds were pulled from. */ financial_account?: string | null; /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ @@ -23796,8 +24193,10 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails */ treasury_outbound_payments_resource_us_domestic_wire_tracking_details: { + /** @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + chips?: string | null; /** @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ - imad: string; + imad?: string | null; /** @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ omad?: string | null; }; @@ -23851,8 +24250,10 @@ export interface components { }; /** TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails */ treasury_outbound_transfers_resource_us_domestic_wire_tracking_details: { + /** @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + chips?: string | null; /** @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ - imad: string; + imad?: string | null; /** @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ omad?: string | null; }; @@ -24193,7 +24594,7 @@ export interface operations { */ collection_options?: { /** @enum {string} */ - fields: "currently_due" | "eventually_due"; + fields?: "currently_due" | "eventually_due"; /** @enum {string} */ future_requirements?: "include" | "omit"; }; @@ -26426,7 +26827,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -26658,7 +27059,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -26949,7 +27350,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -27181,7 +27582,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -28373,6 +28774,277 @@ export interface operations { }; }; }; + GetBillingAlerts: { + parameters: { + query?: { + /** @description Filter results to only include this type of alert. */ + alert_type?: "usage_threshold"; + /** @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; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description Filter results to only include alerts with the given meter. */ + meter?: string; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["billing.alert"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlerts: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * @description The type of alert to create. + * @enum {string} + */ + alert_type: "usage_threshold"; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * alert_filter + * @description Filters to limit the scope of an alert. + */ + filter?: { + customer?: string; + subscription?: string; + subscription_item?: string; + }; + /** @description The title of the alert. */ + title: string; + /** + * usage_threshold_config + * @description The configuration of the usage threshold. + */ + usage_threshold_config?: { + gte: number; + meter?: string; + /** @enum {string} */ + recurrence: "one_time"; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingAlertsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdActivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdArchive: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdDeactivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostBillingMeterEventAdjustments: { parameters: { query?: never; @@ -29241,7 +29913,7 @@ export interface operations { payment_intent?: string; /** @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 Only return charges for this transfer group. */ + /** @description Only return charges for this transfer group, limited to 100. */ transfer_group?: string; }; header?: never; @@ -29369,9 +30041,11 @@ export interface operations { }; /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ source?: string; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string; /** * transfer_data_specs @@ -29598,9 +30272,11 @@ export interface operations { expand?: string[]; /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ receipt_email?: string; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string; /** * transfer_data_specs @@ -30164,7 +30840,7 @@ export interface operations { * @enum {string} */ billing_address_collection?: "auto" | "required"; - /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ + /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`. */ cancel_url?: string; /** @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the @@ -30687,7 +31363,7 @@ export interface operations { enabled: boolean; }; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; @@ -30826,6 +31502,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; /** * @description The UI mode of the Session. Defaults to `hosted`. @@ -32541,6 +33219,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; /** @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`. */ @@ -32590,7 +33269,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -32811,6 +33490,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; /** @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`. */ @@ -34723,7 +35403,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -34764,7 +35444,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -35056,7 +35736,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -35097,7 +35777,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. @@ -35342,10 +36022,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -36303,7 +36983,7 @@ export interface operations { * @description The link isn't usable after this future timestamp. */ expires_at?: number; - /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ + /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ file: string; /** @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?: { @@ -36432,7 +37112,7 @@ export interface operations { /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; /** @description Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. */ - purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @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; }; @@ -36510,7 +37190,7 @@ export interface operations { * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ - purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "pci_document" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "issuing_regulatory_reporting" | "pci_document" | "tax_document_user_upload" | "terminal_reader_splashscreen"; }; }; }; @@ -37366,6 +38046,7 @@ export interface operations { expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; + related_customer?: string; /** @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 Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ @@ -37450,6 +38131,8 @@ export interface operations { email?: string; phone?: string; }; + /** @description Token referencing a Customer resource. */ + related_customer?: string; /** @description The URL that the user will be redirected to upon completing the verification flow. */ return_url?: string; /** @@ -37664,6 +38347,176 @@ export interface operations { }; }; }; + GetInvoiceRenderingTemplates: { + parameters: { + query?: { + /** @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; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + status?: "active" | "archived"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Details about each object. */ + data: components["schemas"]["invoice_rendering_template"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetInvoiceRenderingTemplatesTemplate: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + version?: number; + }; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostInvoiceRenderingTemplatesTemplateArchive: { + parameters: { + query?: never; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostInvoiceRenderingTemplatesTemplateUnarchive: { + parameters: { + query?: never; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetInvoiceitems: { parameters: { query?: { @@ -38202,9 +39055,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -38258,6 +39111,8 @@ export interface operations { /** @enum {string} */ page_size?: "a4" | "auto" | "letter"; }; + template?: string; + template_version?: number | ""; }; /** * shipping_cost @@ -38421,7 +39276,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38433,7 +39288,7 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -38797,7 +39652,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38809,7 +39664,7 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -39170,7 +40025,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -39184,7 +40039,7 @@ export interface operations { ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -39660,9 +40515,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -39711,6 +40566,8 @@ export interface operations { /** @enum {string} */ page_size?: "a4" | "auto" | "letter"; }; + template?: string; + template_version?: number | ""; }; /** @description Settings for the cost of shipping for this invoice. */ shipping_cost?: { @@ -42951,7 +43808,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -43192,6 +44049,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -43219,9 +44078,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -43243,7 +44102,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -43485,11 +44344,11 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "off_session" | "on_session"; @@ -43512,9 +44371,11 @@ export interface operations { phone?: string; tracking_number?: string; }; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_creation_params @@ -43674,7 +44535,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -43888,6 +44749,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -43915,9 +44778,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -43939,7 +44802,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44172,13 +45035,13 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -44198,9 +45061,11 @@ export interface operations { phone?: string; tracking_number?: string; } | ""; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_update_params @@ -44350,9 +45215,11 @@ export interface operations { metadata?: { [key: string]: string; } | ""; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_update_params @@ -44646,6 +45513,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -44673,9 +45542,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -44697,7 +45566,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44941,13 +45810,13 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -45017,7 +45886,7 @@ export interface operations { metadata?: { [key: string]: string; }; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). */ statement_descriptor?: string; /** * transfer_data_update_params @@ -45418,6 +46287,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; /** * transfer_data_params @@ -45707,6 +46578,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; }; }; @@ -49562,7 +50435,7 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ description?: string | ""; - /** @description The discounts applied to the quote. You can only set up to one discount. */ + /** @description The discounts applied to the quote. */ discounts?: { coupon?: string; discount?: string; @@ -49755,7 +50628,7 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. */ description?: string | ""; - /** @description The discounts applied to the quote. You can only set up to one discount. */ + /** @description The discounts applied to the quote. */ discounts?: { coupon?: string; discount?: string; @@ -51638,6 +52511,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -51658,7 +52536,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52015,6 +52893,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -52035,7 +52918,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52391,6 +53274,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -52411,7 +53299,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -54462,12 +55350,14 @@ export interface operations { lt?: number; lte?: number; } | number; + /** @description Only return subscriptions whose current_period_end falls within the given date interval. */ current_period_end?: { gt?: number; gte?: number; lt?: number; lte?: number; } | number; + /** @description Only return subscriptions whose current_period_start falls within the given date interval. */ current_period_start?: { gt?: number; gte?: number; @@ -54738,7 +55628,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -54779,7 +55669,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -55127,7 +56017,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -55168,7 +56058,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. @@ -55396,7 +56286,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @enum {string} */ @@ -55466,6 +56356,44 @@ export interface operations { }; }; }; + GetTaxCalculationsCalculation: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + calculation: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax.calculation"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetTaxCalculationsCalculationLineItems: { parameters: { query?: { @@ -56011,6 +56939,14 @@ export interface operations { jurisdiction: string; }; state: string; + /** state_sales_tax */ + state_sales_tax?: { + elections: { + jurisdiction?: string; + /** @enum {string} */ + type: "local_use_tax" | "simplified_sellers_use_tax" | "single_local_use_tax"; + }[]; + }; /** @enum {string} */ type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; }; @@ -56620,10 +57556,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -57494,7 +58430,7 @@ export interface operations { }; /** @description The ID of a configuration that will be used to customize all readers in this location. */ configuration_overrides?: string; - /** @description A name for the location. */ + /** @description A name for the location. Maximum length is 1000 characters. */ display_name: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -57985,7 +58921,7 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** @description Customer Consent Collected */ - customer_consent_collected: boolean; + customer_consent_collected?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -59170,6 +60106,58 @@ export interface operations { }; }; }; + PostTestHelpersIssuingSettlements: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description The Bank Identification Number reflecting this settlement record. */ + bin: string; + /** @description The date that the transactions are cleared and posted to user's accounts. */ + clearing_date: number; + /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + currency: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The total interchange received as reimbursement for the transactions. */ + interchange_fees?: number; + /** @description The total net amount required to settle with the network. */ + net_total: number; + /** @description The Settlement Identification Number assigned by the network. */ + network_settlement_identifier?: string; + /** @description The total number of transactions reflected in this settlement. */ + transaction_count?: number; + /** @description The total transaction amount reflected in this settlement. */ + transaction_volume?: number; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.settlement"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingTransactionsCreateForceCapture: { parameters: { query?: never; @@ -59950,6 +60938,7 @@ export interface operations { type: "ach" | "us_domestic_wire"; /** us_domestic_wire_tracking_details_params */ us_domestic_wire?: { + chips?: string; imad?: string; omad?: string; }; @@ -60127,6 +61116,7 @@ export interface operations { type: "ach" | "us_domestic_wire"; /** us_domestic_wire_tracking_details_params */ us_domestic_wire?: { + chips?: string; imad?: string; omad?: string; }; @@ -61121,7 +62111,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; - /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ + /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; diff --git a/packages/openapi-fetch/vitest.config.ts b/packages/openapi-fetch/vitest.config.ts index 3cdd106a6..3ac7efb64 100644 --- a/packages/openapi-fetch/vitest.config.ts +++ b/packages/openapi-fetch/vitest.config.ts @@ -2,6 +2,7 @@ import { defineConfig } from "vitest/config"; export default defineConfig({ test: { + environment: "node", globals: true, typecheck: { enabled: true, diff --git a/packages/openapi-react-query/biome.json b/packages/openapi-react-query/biome.json index 684920f12..b53df374b 100644 --- a/packages/openapi-react-query/biome.json +++ b/packages/openapi-react-query/biome.json @@ -1,5 +1,5 @@ { - "$schema": "https://biomejs.dev/schemas/1.8.1/schema.json", + "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json", "extends": ["../../biome.json"], "files": { "ignore": ["./test/fixtures/"] diff --git a/packages/openapi-react-query/package.json b/packages/openapi-react-query/package.json index ae2ddc12b..7d0604404 100644 --- a/packages/openapi-react-query/package.json +++ b/packages/openapi-react-query/package.json @@ -72,6 +72,7 @@ "esbuild": "^0.20.2", "execa": "^8.0.1", "msw": "^2.4.1", + "openapi-fetch": "workspace:^", "openapi-typescript": "workspace:^", "react": "^18.3.1", "react-error-boundary": "^4.0.13" diff --git a/packages/openapi-typescript/biome.json b/packages/openapi-typescript/biome.json index cd15331eb..f3ab913c1 100644 --- a/packages/openapi-typescript/biome.json +++ b/packages/openapi-typescript/biome.json @@ -1,5 +1,5 @@ { - "$schema": "https://biomejs.dev/schemas/1.8.1/schema.json", + "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json", "extends": ["../../biome.json"], "files": { "include": ["./bin/", "./src/", "./test/"], diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index e04ea094b..a2a213b96 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -364,54 +364,6 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/apps/tiers": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List App Tiers - * @deprecated - * @description List all app tiers. - * This endpoint has been deprecated because app tiers are not tied to instance sizes anymore. - * The concept of tiers will be retired in the future. - * - */ - get: operations["apps_list_tiers"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/apps/tiers/{slug}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Retrieve an App Tier - * @deprecated - * @description Retrieve information about a specific app tier. - * This endpoint has been deprecated because app tiers are not tied to instance sizes anymore. - * The concept of tiers will be retired in the future. - * - */ - get: operations["apps_get_tier"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v2/apps/tiers/instance_sizes": { parameters: { query?: never; @@ -1245,6 +1197,27 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/install_update": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Start Database Maintenance + * @description To start the installation of updates for a database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/install_update`. + * A successful request will receive a 204 No Content status code with no body in response. + */ + put: operations["databases_install_update"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/{database_cluster_uuid}/backups": { parameters: { query?: never; @@ -1892,6 +1865,55 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/indexes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Indexes for a OpenSearch Cluster + * @description To list all of a OpenSearch cluster's indexes, send a GET request to + * `/v2/databases/$DATABASE_ID/indexes`. + * + * The result will be a JSON object with a `indexes` key. + * + */ + get: operations["databases_list_opeasearch_indexes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/indexes/{index_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete Index for OpenSearch Cluster + * @description To delete a single index within OpenSearch cluster, send a DELETE request + * to `/v2/databases/$DATABASE_ID/indexes/$INDEX_NAME`. + * + * A status of 204 will be given. This indicates that the request was + * processed successfully, but that no response body is needed. + * + */ + delete: operations["databases_delete_opensearch_index"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/domains": { parameters: { query?: never; @@ -2156,6 +2178,72 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/droplets/{droplet_id}/backups/policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve the Backup Policy for an Existing Droplet + * @description To show information about an individual Droplet's backup policy, send a GET + * request to `/v2/droplets/$DROPLET_ID/backups/policy`. + * + */ + get: operations["droplets_get_backup_policy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/backups/policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Backup Policies for All Existing Droplets + * @description To list information about the backup policies for all Droplets in the account, + * send a GET request to `/v2/droplets/backups/policies`. + * + */ + get: operations["droplets_list_backup_policies"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/backups/supported_policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Supported Droplet Backup Policies + * @description To retrieve a list of all supported Droplet backup policies, send a GET + * request to `/v2/droplets/backups/supported_policies`. + * + */ + get: operations["droplets_list_supported_backup_policies"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/droplets/{droplet_id}/snapshots": { parameters: { query?: never; @@ -2211,6 +2299,7 @@ export interface paths { * | ---------------------------------------- | ----------- | * | `enable_backups` | Enables backups for a Droplet | * | `disable_backups` | Disables backups for a Droplet | + * | `change_backup_policy` | Update the backup policy for a Droplet | * | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | * | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | * | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | @@ -4043,7 +4132,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects": { + "/v2/monitoring/metrics/load_balancer/frontend_connections_current": { parameters: { query?: never; header?: never; @@ -4051,23 +4140,19 @@ export interface paths { cookie?: never; }; /** - * List All Projects - * @description To list all your projects, send a GET request to `/v2/projects`. + * Get Load Balancer Frontend Total Current Active Connections Metrics + * @description To retrieve frontend total current active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_current`. */ - get: operations["projects_list"]; + get: operations["monitoring_get_lb_frontend_connections_current"]; put?: never; - /** - * Create a Project - * @description To create a project, send a POST request to `/v2/projects`. - */ - post: operations["projects_create"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/default": { + "/v2/monitoring/metrics/load_balancer/frontend_connections_limit": { parameters: { query?: never; header?: never; @@ -4075,27 +4160,19 @@ export interface paths { cookie?: never; }; /** - * Retrieve the Default Project - * @description To get your default project, send a GET request to `/v2/projects/default`. - */ - get: operations["projects_get_default"]; - /** - * Update the Default Project - * @description To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. + * Get Load Balancer Frontend Max Connections Limit Metrics + * @description To retrieve frontend max connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_limit`. */ - put: operations["projects_update_default"]; + get: operations["monitoring_get_lb_frontend_connections_limit"]; + put?: never; post?: never; delete?: never; options?: never; head?: never; - /** - * Patch the Default Project - * @description To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. - */ - patch: operations["projects_patch_default"]; + patch?: never; trace?: never; }; - "/v2/projects/{project_id}": { + "/v2/monitoring/metrics/load_balancer/frontend_cpu_utilization": { parameters: { query?: never; header?: never; @@ -4103,37 +4180,19 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Project - * @description To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. - */ - get: operations["projects_get"]; - /** - * Update a Project - * @description To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. + * Get Load Balancer Frontend Average Percentage CPU Utilization Metrics + * @description To retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_cpu_utilization`. */ - put: operations["projects_update"]; + get: operations["monitoring_get_lb_frontend_cpu_utilization"]; + put?: never; post?: never; - /** - * Delete an Existing Project - * @description To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To - * be deleted, a project must not have any resources assigned to it. Any existing - * resources must first be reassigned or destroyed, or you will receive a 412 error. - * - * A successful request will receive a 204 status code with no body in response. - * This indicates that the request was processed successfully. - * - */ - delete: operations["projects_delete"]; + delete?: never; options?: never; head?: never; - /** - * Patch a Project - * @description To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. - */ - patch: operations["projects_patch"]; + patch?: never; trace?: never; }; - "/v2/projects/{project_id}/resources": { + "/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes": { parameters: { query?: never; header?: never; @@ -4141,23 +4200,19 @@ export interface paths { cookie?: never; }; /** - * List Project Resources - * @description To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. + * Get Load Balancer Frontend Firewall Dropped Bytes Metrics + * @description To retrieve firewall dropped bytes for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes`. This is currently only supported for network load balancers. */ - get: operations["projects_list_resources"]; + get: operations["monitoring_get_lb_frontend_firewall_dropped_bytes"]; put?: never; - /** - * Assign Resources to a Project - * @description To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. - */ - post: operations["projects_assign_resources"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/default/resources": { + "/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets": { parameters: { query?: never; header?: never; @@ -4165,23 +4220,19 @@ export interface paths { cookie?: never; }; /** - * List Default Project Resources - * @description To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. + * Get Load Balancer Frontend Firewall Dropped Packets Metrics + * @description To retrieve firewall dropped packets per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets`. This is currently only supported for network load balancers. */ - get: operations["projects_list_resources_default"]; + get: operations["monitoring_get_lb_frontend_firewall_dropped_packets"]; put?: never; - /** - * Assign Resources to Default Project - * @description To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. - */ - post: operations["projects_assign_resources_default"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/regions": { + "/v2/monitoring/metrics/load_balancer/frontend_http_responses": { parameters: { query?: never; header?: never; @@ -4189,11 +4240,10 @@ export interface paths { cookie?: never; }; /** - * List All Data Center Regions - * @description To list all of the regions that are available, send a GET request to `/v2/regions`. - * The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes. + * Get Load Balancer Frontend HTTP Rate Of Response Code Metrics + * @description To retrieve frontend HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_responses`. */ - get: operations["regions_list"]; + get: operations["monitoring_get_lb_frontend_http_responses"]; put?: never; post?: never; delete?: never; @@ -4202,7 +4252,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry": { + "/v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second": { parameters: { query?: never; header?: never; @@ -4210,32 +4260,19 @@ export interface paths { cookie?: never; }; /** - * Get Container Registry Information - * @description To get information about your container registry, send a GET request to `/v2/registry`. + * Get Load Balancer Frontend HTTP Requests Metrics + * @description To retrieve frontend HTTP requests per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second`. */ - get: operations["registry_get"]; + get: operations["monitoring_get_lb_frontend_http_requests_per_second"]; put?: never; - /** - * Create Container Registry - * @description To create your container registry, send a POST request to `/v2/registry`. - * - * The `name` becomes part of the URL for images stored in the registry. For - * example, if your registry is called `example`, an image in it will have the - * URL `registry.digitalocean.com/example/image:tag`. - * - */ - post: operations["registry_create"]; - /** - * Delete Container Registry - * @description To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. - */ - delete: operations["registry_delete"]; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/subscription": { + "/v2/monitoring/metrics/load_balancer/frontend_network_throughput_http": { parameters: { query?: never; header?: never; @@ -4243,23 +4280,19 @@ export interface paths { cookie?: never; }; /** - * Get Subscription Information - * @description A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. + * Get Load Balancer Frontend HTTP Throughput Metrics + * @description To retrieve frontend HTTP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_http`. */ - get: operations["registry_get_subscription"]; + get: operations["monitoring_get_lb_frontend_network_throughput_http"]; put?: never; - /** - * Update Subscription Tier - * @description After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. - */ - post: operations["registry_update_subscription"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/docker-credentials": { + "/v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp": { parameters: { query?: never; header?: never; @@ -4267,32 +4300,10 @@ export interface paths { cookie?: never; }; /** - * Get Docker Credentials for Container Registry - * @description In order to access your container registry with the Docker client or from a - * Kubernetes cluster, you will need to configure authentication. The necessary - * JSON configuration can be retrieved by sending a GET request to - * `/v2/registry/docker-credentials`. - * - * The response will be in the format of a Docker `config.json` file. To use the - * config in your Kubernetes cluster, create a Secret with: - * - * kubectl create secret generic docr \ - * --from-file=.dockerconfigjson=config.json \ - * --type=kubernetes.io/dockerconfigjson - * - * By default, the returned credentials have read-only access to your registry - * and cannot be used to push images. This is appropriate for most Kubernetes - * clusters. To retrieve read/write credentials, suitable for use with the Docker - * client or in a CI system, read_write may be provided as query parameter. For - * example: `/v2/registry/docker-credentials?read_write=true` - * - * By default, the returned credentials will not expire. To retrieve credentials - * with an expiry set, expiry_seconds may be provided as a query parameter. For - * example: `/v2/registry/docker-credentials?expiry_seconds=3600` will return - * credentials that expire after one hour. - * + * Get Load Balancer Frontend UDP Throughput Metrics + * @description To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp`. */ - get: operations["registry_get_dockerCredentials"]; + get: operations["monitoring_get_lb_frontend_network_throughput_udp"]; put?: never; post?: never; delete?: never; @@ -4301,33 +4312,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/validate-name": { + "/v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Validate a Container Registry Name - * @description To validate that a container registry name is available for use, send a POST - * request to `/v2/registry/validate-name`. - * - * If the name is both formatted correctly and available, the response code will - * be 204 and contain no body. If the name is already in use, the response will - * be a 409 Conflict. - * + * Get Load Balancer Frontend TCP Throughput Metrics + * @description To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp`. */ - post: operations["registry_validate_name"]; + get: operations["monitoring_get_lb_frontend_network_throughput_tcp"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositories": { + "/v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput": { parameters: { query?: never; header?: never; @@ -4335,15 +4340,10 @@ export interface paths { cookie?: never; }; /** - * List All Container Registry Repositories - * @deprecated - * @description This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. - * - * To list all repositories in your container registry, send a GET - * request to `/v2/registry/$REGISTRY_NAME/repositories`. - * + * Get Network Load Balancer Frontend TCP Throughput Metrics + * @description To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput`. */ - get: operations["registry_list_repositories"]; + get: operations["monitoring_get_lb_frontend_nlb_tcp_network_throughput"]; put?: never; post?: never; delete?: never; @@ -4352,7 +4352,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositoriesV2": { + "/v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput": { parameters: { query?: never; header?: never; @@ -4360,10 +4360,10 @@ export interface paths { cookie?: never; }; /** - * List All Container Registry Repositories (V2) - * @description To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. + * Get Network Load Balancer Frontend UDP Throughput Metrics + * @description To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput`. */ - get: operations["registry_list_repositoriesV2"]; + get: operations["monitoring_get_lb_frontend_nlb_udp_network_throughput"]; put?: never; post?: never; delete?: never; @@ -4372,7 +4372,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositories/{repository_name}/tags": { + "/v2/monitoring/metrics/load_balancer/frontend_tls_connections_current": { parameters: { query?: never; header?: never; @@ -4380,17 +4380,10 @@ export interface paths { cookie?: never; }; /** - * List All Container Registry Repository Tags - * @description To list all tags in your container registry repository, send a GET - * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. - * - * Note that if your repository name contains `/` characters, it must be - * URL-encoded in the request URL. For example, to list tags for - * `registry.digitalocean.com/example/my/repo`, the path would be - * `/v2/registry/example/repositories/my%2Frepo/tags`. - * + * Get Load Balancer Frontend Current TLS Connections Rate Metrics + * @description To retrieve frontend current TLS connections rate for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_current`. */ - get: operations["registry_list_repositoryTags"]; + get: operations["monitoring_get_lb_frontend_tls_connections_current"]; put?: never; post?: never; delete?: never; @@ -4399,37 +4392,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositories/{repository_name}/tags/{repository_tag}": { + "/v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - post?: never; /** - * Delete Container Registry Repository Tag - * @description To delete a container repository tag, send a DELETE request to - * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. - * - * Note that if your repository name contains `/` characters, it must be - * URL-encoded in the request URL. For example, to delete - * `registry.digitalocean.com/example/my/repo:mytag`, the path would be - * `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. - * - * A successful request will receive a 204 status code with no body in response. - * This indicates that the request was processed successfully. - * + * Get Load Balancer Frontend Max TLS Connections Limit Metrics + * @description To retrieve frontend max TLS connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit`. */ - delete: operations["registry_delete_repositoryTag"]; + get: operations["monitoring_get_lb_frontend_tls_connections_limit"]; + put?: never; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositories/{repository_name}/digests": { + "/v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit": { parameters: { query?: never; header?: never; @@ -4437,17 +4420,10 @@ export interface paths { cookie?: never; }; /** - * List All Container Registry Repository Manifests - * @description To list all manifests in your container registry repository, send a GET - * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. - * - * Note that if your repository name contains `/` characters, it must be - * URL-encoded in the request URL. For example, to list manifests for - * `registry.digitalocean.com/example/my/repo`, the path would be - * `/v2/registry/example/repositories/my%2Frepo/digests`. - * + * Get Load Balancer Frontend Closed TLS Connections For Exceeded Rate Limit Metrics + * @description To retrieve frontend closed TLS connections for exceeded rate limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit`. */ - get: operations["registry_list_repositoryManifests"]; + get: operations["monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit"]; put?: never; post?: never; delete?: never; @@ -4456,37 +4432,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/repositories/{repository_name}/digests/{manifest_digest}": { + "/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - post?: never; /** - * Delete Container Registry Repository Manifest - * @description To delete a container repository manifest by digest, send a DELETE request to - * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. - * - * Note that if your repository name contains `/` characters, it must be - * URL-encoded in the request URL. For example, to delete - * `registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be - * `/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`. - * - * A successful request will receive a 204 status code with no body in response. - * This indicates that the request was processed successfully. - * + * Get Load Balancer Droplets Average HTTP Session Duration Metrics + * @description To retrieve Droplets average HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg`. */ - delete: operations["registry_delete_repositoryManifest"]; + get: operations["monitoring_get_lb_droplets_http_session_duration_avg"]; + put?: never; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/garbage-collection": { + "/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p": { parameters: { query?: never; header?: never; @@ -4494,44 +4460,19 @@ export interface paths { cookie?: never; }; /** - * Get Active Garbage Collection - * @description To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. + * Get Load Balancer Droplets 50th Percentile HTTP Session Duration Metrics + * @description To retrieve Droplets 50th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p`. */ - get: operations["registry_get_garbageCollection"]; + get: operations["monitoring_get_lb_droplets_http_session_duration_50p"]; put?: never; - /** - * Start Garbage Collection - * @description Garbage collection enables users to clear out unreferenced blobs (layer & - * manifest data) after deleting one or more manifests from a repository. If - * there are no unreferenced blobs resulting from the deletion of one or more - * manifests, garbage collection is effectively a noop. - * [See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/) - * about how and why you should clean up your container registry periodically. - * - * To request a garbage collection run on your registry, send a POST request to - * `/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the - * following sequence of events on your registry. - * - * * Set the registry to read-only mode, meaning no further write-scoped - * JWTs will be issued to registry clients. Existing write-scoped JWTs will - * continue to work until they expire which can take up to 15 minutes. - * * Wait until all existing write-scoped JWTs have expired. - * * Scan all registry manifests to determine which blobs are unreferenced. - * * Delete all unreferenced blobs from the registry. - * * Record the number of blobs deleted and bytes freed, mark the garbage - * collection status as `success`. - * * Remove the read-only mode restriction from the registry, meaning write-scoped - * JWTs will once again be issued to registry clients. - * - */ - post: operations["registry_run_garbageCollection"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/garbage-collections": { + "/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p": { parameters: { query?: never; header?: never; @@ -4539,10 +4480,10 @@ export interface paths { cookie?: never; }; /** - * List Garbage Collections - * @description To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. + * Get Load Balancer Droplets 95th Percentile HTTP Session Duration Metrics + * @description To retrieve Droplets 95th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p`. */ - get: operations["registry_list_garbageCollections"]; + get: operations["monitoring_get_lb_droplets_http_session_duration_95p"]; put?: never; post?: never; delete?: never; @@ -4551,19 +4492,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}": { + "/v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; /** - * Update Garbage Collection - * @description To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. + * Get Load Balancer Droplets Average HTTP Response Time Metrics + * @description To retrieve Droplets average HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg`. */ - put: operations["registry_update_garbageCollection"]; + get: operations["monitoring_get_lb_droplets_http_response_time_avg"]; + put?: never; post?: never; delete?: never; options?: never; @@ -4571,7 +4512,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/registry/options": { + "/v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p": { parameters: { query?: never; header?: never; @@ -4579,13 +4520,10 @@ export interface paths { cookie?: never; }; /** - * List Registry Options (Subscription Tiers and Available Regions) - * @description This endpoint serves to provide additional information as to which option values are available when creating a container registry. - * There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. - * There are multiple regions available for container registry and controls where your data is stored. - * To list the available options, send a GET request to `/v2/registry/options`. + * Get Load Balancer Droplets 50th Percentile HTTP Response Time Metrics + * @description To retrieve Droplets 50th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p`. */ - get: operations["registry_get_options"]; + get: operations["monitoring_get_lb_droplets_http_response_time_50p"]; put?: never; post?: never; delete?: never; @@ -4594,7 +4532,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/reports/droplet_neighbors_ids": { + "/v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p": { parameters: { query?: never; header?: never; @@ -4602,18 +4540,10 @@ export interface paths { cookie?: never; }; /** - * List All Droplet Neighbors - * @description To retrieve a list of all Droplets that are co-located on the same physical - * hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`. - * - * The results will be returned as a JSON object with a key of `neighbor_ids`. - * This will be set to an array of arrays. Each array will contain a set of - * Droplet IDs for Droplets that share a physical server. An empty array - * indicates that all Droplets associated with your account are located on - * separate physical hardware. - * + * Get Load Balancer Droplets 95th Percentile HTTP Response Time Metrics + * @description To retrieve Droplets 95th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p`. */ - get: operations["droplets_list_neighborsIds"]; + get: operations["monitoring_get_lb_droplets_http_response_time_95p"]; put?: never; post?: never; delete?: never; @@ -4622,7 +4552,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/reserved_ips": { + "/v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p": { parameters: { query?: never; header?: never; @@ -4630,30 +4560,19 @@ export interface paths { cookie?: never; }; /** - * List All Reserved IPs - * @description To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. + * Get Load Balancer Droplets 99th Percentile HTTP Response Time Metrics + * @description To retrieve Droplets 99th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p`. */ - get: operations["reservedIPs_list"]; + get: operations["monitoring_get_lb_droplets_http_response_time_99p"]; put?: never; - /** - * Create a New Reserved IP - * @description On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. - * * To create a new reserved IP assigned to a Droplet, send a POST - * request to `/v2/reserved_ips` with the `droplet_id` attribute. - * - * * To create a new reserved IP reserved to a region, send a POST request to - * `/v2/reserved_ips` with the `region` attribute. - * - * **Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. - */ - post: operations["reservedIPs_create"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/reserved_ips/{reserved_ip}": { + "/v2/monitoring/metrics/load_balancer/droplets_queue_size": { parameters: { query?: never; header?: never; @@ -4661,28 +4580,19 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Reserved IP - * @description To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. + * Get Load Balancer Droplets Queue Size Metrics + * @description To retrieve Droplets queue size for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_queue_size`. */ - get: operations["reservedIPs_get"]; + get: operations["monitoring_get_lb_droplets_queue_size"]; put?: never; post?: never; - /** - * Delete a Reserved IP - * @description To delete a reserved IP and remove it from your account, send a DELETE request - * to `/v2/reserved_ips/$RESERVED_IP_ADDR`. - * - * A successful request will receive a 204 status code with no body in response. - * This indicates that the request was processed successfully. - * - */ - delete: operations["reservedIPs_delete"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/reserved_ips/{reserved_ip}/actions": { + "/v2/monitoring/metrics/load_balancer/droplets_http_responses": { parameters: { query?: never; header?: never; @@ -4690,31 +4600,19 @@ export interface paths { cookie?: never; }; /** - * List All Actions for a Reserved IP - * @description To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. + * Get Load Balancer Droplets HTTP Rate Of Response Code Metrics + * @description To retrieve Droplets HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_responses`. */ - get: operations["reservedIPsActions_list"]; + get: operations["monitoring_get_lb_droplets_http_responses"]; put?: never; - /** - * Initiate a Reserved IP Action - * @description To initiate an action on a reserved IP send a POST request to - * `/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request, - * set the `type` attribute to on of the supported action types: - * - * | Action | Details - * |------------|-------- - * | `assign` | Assigns a reserved IP to a Droplet - * | `unassign` | Unassign a reserved IP from a Droplet - * - */ - post: operations["reservedIPsActions_post"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/reserved_ips/{reserved_ip}/actions/{action_id}": { + "/v2/monitoring/metrics/load_balancer/droplets_connections": { parameters: { query?: never; header?: never; @@ -4722,10 +4620,10 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Reserved IP Action - * @description To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. + * Get Load Balancer Droplets Active Connections Metrics + * @description To retrieve Droplets active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_connections`. */ - get: operations["reservedIPsActions_get"]; + get: operations["monitoring_get_lb_droplets_connections"]; put?: never; post?: never; delete?: never; @@ -4734,7 +4632,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sizes": { + "/v2/monitoring/metrics/load_balancer/droplets_health_checks": { parameters: { query?: never; header?: never; @@ -4742,11 +4640,10 @@ export interface paths { cookie?: never; }; /** - * List All Droplet Sizes - * @description To list all of available Droplet sizes, send a GET request to `/v2/sizes`. - * The response will be 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. + * Get Load Balancer Droplets Health Check Status Metrics + * @description To retrieve Droplets health check status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_health_checks`. */ - get: operations["sizes_list"]; + get: operations["monitoring_get_lb_droplets_health_checks"]; put?: never; post?: never; delete?: never; @@ -4755,7 +4652,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/snapshots": { + "/v2/monitoring/metrics/load_balancer/droplets_downtime": { parameters: { query?: never; header?: never; @@ -4763,30 +4660,10 @@ export interface paths { cookie?: never; }; /** - * List All Snapshots - * @description To list all of the snapshots available on your account, send a GET request to - * `/v2/snapshots`. - * - * The response will be a JSON object with a key called `snapshots`. This will be - * set to an array of `snapshot` objects, each of which will contain the standard - * snapshot attributes. - * - * ### Filtering Results by Resource Type - * - * It's possible to request filtered results by including certain query parameters. - * - * #### List Droplet Snapshots - * - * To retrieve only snapshots based on Droplets, include the `resource_type` - * query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. - * - * #### List Volume Snapshots - * - * To retrieve only snapshots based on volumes, include the `resource_type` - * query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. - * + * Get Load Balancer Droplets Downtime Status Metrics + * @description To retrieve Droplets downtime status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_downtime`. */ - get: operations["snapshots_list"]; + get: operations["monitoring_get_lb_droplets_downtime"]; put?: never; post?: never; delete?: never; @@ -4795,7 +4672,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/snapshots/{snapshot_id}": { + "/v2/projects": { parameters: { query?: never; header?: never; @@ -4803,34 +4680,23 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Snapshot - * @description To retrieve information about a snapshot, send a GET request to - * `/v2/snapshots/$SNAPSHOT_ID`. - * - * The response will be a JSON object with a key called `snapshot`. The value of - * this will be an snapshot object containing the standard snapshot attributes. - * + * List All Projects + * @description To list all your projects, send a GET request to `/v2/projects`. */ - get: operations["snapshots_get"]; + get: operations["projects_list"]; put?: never; - post?: never; /** - * Delete a Snapshot - * @description Both Droplet and volume snapshots are managed through the `/v2/snapshots/` - * endpoint. To delete a snapshot, send a DELETE request to - * `/v2/snapshots/$SNAPSHOT_ID`. - * - * A status of 204 will be given. This indicates that the request was processed - * successfully, but that no response body is needed. - * + * Create a Project + * @description To create a project, send a POST request to `/v2/projects`. */ - delete: operations["snapshots_delete"]; + post: operations["projects_create"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/tags": { + "/v2/projects/default": { parameters: { query?: never; header?: never; @@ -4838,23 +4704,27 @@ export interface paths { cookie?: never; }; /** - * List All Tags - * @description To list all of your tags, you can send a GET request to `/v2/tags`. + * Retrieve the Default Project + * @description To get your default project, send a GET request to `/v2/projects/default`. */ - get: operations["tags_list"]; - put?: never; + get: operations["projects_get_default"]; /** - * Create a New Tag - * @description To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. + * Update the Default Project + * @description To update you default project, send a PUT request to `/v2/projects/default`. All of the following attributes must be sent. */ - post: operations["tags_create"]; + put: operations["projects_update_default"]; + post?: never; delete?: never; options?: never; head?: never; - patch?: never; + /** + * Patch the Default Project + * @description To update only specific attributes of your default project, send a PATCH request to `/v2/projects/default`. At least one of the following attributes needs to be sent. + */ + patch: operations["projects_patch_default"]; trace?: never; }; - "/v2/tags/{tag_id}": { + "/v2/projects/{project_id}": { parameters: { query?: never; header?: never; @@ -4862,49 +4732,61 @@ export interface paths { cookie?: never; }; /** - * Retrieve a Tag - * @description To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. + * Retrieve an Existing Project + * @description To get a project, send a GET request to `/v2/projects/$PROJECT_ID`. */ - get: operations["tags_get"]; - put?: never; + get: operations["projects_get"]; + /** + * Update a Project + * @description To update a project, send a PUT request to `/v2/projects/$PROJECT_ID`. All of the following attributes must be sent. + */ + put: operations["projects_update"]; post?: never; /** - * Delete a Tag - * @description A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag + * Delete an Existing Project + * @description To delete a project, send a DELETE request to `/v2/projects/$PROJECT_ID`. To + * be deleted, a project must not have any resources assigned to it. Any existing + * resources must first be reassigned or destroyed, or you will receive a 412 error. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + * */ - delete: operations["tags_delete"]; + delete: operations["projects_delete"]; options?: never; head?: never; - patch?: never; + /** + * Patch a Project + * @description To update only specific attributes of a project, send a PATCH request to `/v2/projects/$PROJECT_ID`. At least one of the following attributes needs to be sent. + */ + patch: operations["projects_patch"]; trace?: never; }; - "/v2/tags/{tag_id}/resources": { + "/v2/projects/{project_id}/resources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Tag a Resource - * @description Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. - * Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + * List Project Resources + * @description To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. */ - post: operations["tags_assign_resources"]; + get: operations["projects_list_resources"]; + put?: never; /** - * Untag a Resource - * @description Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. - * Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + * Assign Resources to a Project + * @description To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. */ - delete: operations["tags_unassign_resources"]; + post: operations["projects_assign_resources"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes": { + "/v2/projects/default/resources": { parameters: { query?: never; header?: never; @@ -4912,89 +4794,44 @@ export interface paths { cookie?: never; }; /** - * List All Block Storage Volumes - * @description To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. - * ## Filtering Results - * ### By Region - * The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` - * ### By Name - * It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. - * **Note:** You can only create one volume per region with the same name. - * ### By Name and Region - * It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. - * - * - * + * List Default Project Resources + * @description To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. */ - get: operations["volumes_list"]; + get: operations["projects_list_resources_default"]; put?: never; /** - * Create a New Block Storage Volume - * @description To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. - */ - post: operations["volumes_create"]; - /** - * Delete a Block Storage Volume by Name - * @description Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. - * No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. - * - * + * Assign Resources to Default Project + * @description To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. */ - delete: operations["volumes_delete_byName"]; + post: operations["projects_assign_resources_default"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/actions": { + "/v2/regions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Initiate A Block Storage Action By Volume Name - * @description To initiate an action on a block storage volume by Name, send a POST request to - * `~/v2/volumes/actions`. The body should contain the appropriate - * attributes for the respective action. - * - * ## Attach a Block Storage Volume to a Droplet - * - * | Attribute | Details | - * | ----------- | ------------------------------------------------------------------- | - * | type | This must be `attach` | - * | volume_name | The name of the block storage volume | - * | droplet_id | Set to the Droplet's ID | - * | region | Set to the slug representing the region where the volume is located | - * - * Each volume may only be attached to a single Droplet. However, up to five - * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be - * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS - * Droplets created on or after April 26, 2018 when attached. On older Droplets, - * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) - * is required. - * - * ## Remove a Block Storage Volume from a Droplet - * - * | Attribute | Details | - * | ----------- | ------------------------------------------------------------------- | - * | type | This must be `detach` | - * | volume_name | The name of the block storage volume | - * | droplet_id | Set to the Droplet's ID | - * | region | Set to the slug representing the region where the volume is located | - * + * List All Data Center Regions + * @description To list all of the regions that are available, send a GET request to `/v2/regions`. + * The response will be a JSON object with a key called `regions`. The value of this will be an array of `region` objects, each of which will contain the standard region attributes. */ - post: operations["volumeActions_post"]; + get: operations["regions_list"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/snapshots/{snapshot_id}": { + "/v2/registry": { parameters: { query?: never; header?: never; @@ -5002,30 +4839,32 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Volume Snapshot - * @description To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. - * - * + * Get Container Registry Information + * @description To get information about your container registry, send a GET request to `/v2/registry`. */ - get: operations["volumeSnapshots_get_byId"]; + get: operations["registry_get"]; put?: never; - post?: never; /** - * Delete a Volume Snapshot - * @description To delete a volume snapshot, send a DELETE request to - * `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. + * Create Container Registry + * @description To create your container registry, send a POST request to `/v2/registry`. * - * A status of 204 will be given. This indicates that the request was processed - * successfully, but that no response body is needed. + * The `name` becomes part of the URL for images stored in the registry. For + * example, if your registry is called `example`, an image in it will have the + * URL `registry.digitalocean.com/example/image:tag`. * */ - delete: operations["volumeSnapshots_delete_byId"]; + post: operations["registry_create"]; + /** + * Delete Container Registry + * @description To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. + */ + delete: operations["registry_delete"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/{volume_id}": { + "/v2/registry/subscription": { parameters: { query?: never; header?: never; @@ -5033,28 +4872,23 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Block Storage Volume - * @description To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`. - * - * + * Get Subscription Information + * @description A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. */ - get: operations["volumes_get"]; + get: operations["registry_get_subscription"]; put?: never; - post?: never; /** - * Delete a Block Storage Volume - * @description To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`. - * No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. - * - * + * Update Subscription Tier + * @description After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. */ - delete: operations["volumes_delete"]; + post: operations["registry_update_subscription"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/{volume_id}/actions": { + "/v2/registry/docker-credentials": { parameters: { query?: never; header?: never; @@ -5062,83 +4896,67 @@ export interface paths { cookie?: never; }; /** - * List All Actions for a Volume - * @description To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. - * + * Get Docker Credentials for Container Registry + * @description In order to access your container registry with the Docker client or from a + * Kubernetes cluster, you will need to configure authentication. The necessary + * JSON configuration can be retrieved by sending a GET request to + * `/v2/registry/docker-credentials`. * - */ - get: operations["volumeActions_list"]; - put?: never; - /** - * Initiate A Block Storage Action By Volume Id - * @description To initiate an action on a block storage volume by Id, send a POST request to - * `~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate - * attributes for the respective action. + * The response will be in the format of a Docker `config.json` file. To use the + * config in your Kubernetes cluster, create a Secret with: * - * ## Attach a Block Storage Volume to a Droplet + * kubectl create secret generic docr \ + * --from-file=.dockerconfigjson=config.json \ + * --type=kubernetes.io/dockerconfigjson * - * | Attribute | Details | - * | ---------- | ------------------------------------------------------------------- | - * | type | This must be `attach` | - * | droplet_id | Set to the Droplet's ID | - * | region | Set to the slug representing the region where the volume is located | + * By default, the returned credentials have read-only access to your registry + * and cannot be used to push images. This is appropriate for most Kubernetes + * clusters. To retrieve read/write credentials, suitable for use with the Docker + * client or in a CI system, read_write may be provided as query parameter. For + * example: `/v2/registry/docker-credentials?read_write=true` * - * Each volume may only be attached to a single Droplet. However, up to seven - * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be - * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS - * Droplets created on or after April 26, 2018 when attached. On older Droplets, - * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) - * is required. - * - * ## Remove a Block Storage Volume from a Droplet - * - * | Attribute | Details | - * | ---------- | ------------------------------------------------------------------- | - * | type | This must be `detach` | - * | droplet_id | Set to the Droplet's ID | - * | region | Set to the slug representing the region where the volume is located | - * - * ## Resize a Volume - * - * | Attribute | Details | - * | -------------- | ------------------------------------------------------------------- | - * | type | This must be `resize` | - * | size_gigabytes | The new size of the block storage volume in GiB (1024^3) | - * | region | Set to the slug representing the region where the volume is located | - * - * Volumes may only be resized upwards. The maximum size for a volume is 16TiB. + * By default, the returned credentials will not expire. To retrieve credentials + * with an expiry set, expiry_seconds may be provided as a query parameter. For + * example: `/v2/registry/docker-credentials?expiry_seconds=3600` will return + * credentials that expire after one hour. * */ - post: operations["volumeActions_post_byId"]; + get: operations["registry_get_dockerCredentials"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/{volume_id}/actions/{action_id}": { + "/v2/registry/validate-name": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Retrieve an Existing Volume Action - * @description To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`. + * Validate a Container Registry Name + * @description To validate that a container registry name is available for use, send a POST + * request to `/v2/registry/validate-name`. * + * If the name is both formatted correctly and available, the response code will + * be 204 and contain no body. If the name is already in use, the response will + * be a 409 Conflict. * */ - get: operations["volumeActions_get"]; - put?: never; - post?: never; + post: operations["registry_validate_name"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes/{volume_id}/snapshots": { + "/v2/registry/{registry_name}/repositories": { parameters: { query?: never; header?: never; @@ -5146,25 +4964,24 @@ export interface paths { cookie?: never; }; /** - * List Snapshots for a Volume - * @description To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. + * List All Container Registry Repositories + * @deprecated + * @description This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. * + * To list all repositories in your container registry, send a GET + * request to `/v2/registry/$REGISTRY_NAME/repositories`. * */ - get: operations["volumeSnapshots_list"]; + get: operations["registry_list_repositories"]; put?: never; - /** - * Create Snapshot from a Volume - * @description To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. - */ - post: operations["volumeSnapshots_create"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/vpcs": { + "/v2/registry/{registry_name}/repositoriesV2": { parameters: { query?: never; header?: never; @@ -5172,71 +4989,76 @@ export interface paths { cookie?: never; }; /** - * List All VPCs - * @description To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. + * List All Container Registry Repositories (V2) + * @description To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. */ - get: operations["vpcs_list"]; + get: operations["registry_list_repositoriesV2"]; put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registry/{registry_name}/repositories/{repository_name}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Create a New VPC - * @description To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes - * in the table below in the JSON body. + * List All Container Registry Repository Tags + * @description To list all tags in your container registry repository, send a GET + * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. * - * **Note:** If you do not currently have a VPC network in a specific datacenter - * region, the first one that you create will be set as the default for that - * region. The default VPC for a region cannot be changed or deleted. + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to list tags for + * `registry.digitalocean.com/example/my/repo`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/tags`. * */ - post: operations["vpcs_create"]; + get: operations["registry_list_repositoryTags"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/vpcs/{vpc_id}": { + "/v2/registry/{registry_name}/repositories/{repository_name}/tags/{repository_tag}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Retrieve an Existing VPC - * @description To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. - */ - get: operations["vpcs_get"]; - /** - * Update a VPC - * @description To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`. - * - */ - put: operations["vpcs_update"]; + get?: never; + put?: never; post?: never; /** - * Delete a VPC - * @description To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status - * code with no body will be returned in response to a successful request. + * Delete Container Registry Repository Tag + * @description To delete a container repository tag, send a DELETE request to + * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. * - * The default VPC for a region can not be deleted. Additionally, a VPC can only - * be deleted if it does not contain any member resources. Attempting to delete - * a region's default VPC or a VPC that still has members will result in a - * 403 Forbidden error response. + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to delete + * `registry.digitalocean.com/example/my/repo:mytag`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. * */ - delete: operations["vpcs_delete"]; + delete: operations["registry_delete_repositoryTag"]; options?: never; head?: never; - /** - * Partially Update a VPC - * @description To update a subset of information about a VPC, send a PATCH request to - * `/v2/vpcs/$VPC_ID`. - * - */ - patch: operations["vpcs_patch"]; + patch?: never; trace?: never; }; - "/v2/vpcs/{vpc_id}/members": { + "/v2/registry/{registry_name}/repositories/{repository_name}/digests": { parameters: { query?: never; header?: never; @@ -5244,16 +5066,17 @@ export interface paths { cookie?: never; }; /** - * List the Member Resources of a VPC - * @description To list all of the resources that are members of a VPC, send a GET request to - * `/v2/vpcs/$VPC_ID/members`. + * List All Container Registry Repository Manifests + * @description To list all manifests in your container registry repository, send a GET + * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. * - * To only list resources of a specific type that are members of the VPC, - * included a `resource_type` query parameter. For example, to only list Droplets - * in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to list manifests for + * `registry.digitalocean.com/example/my/repo`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/digests`. * */ - get: operations["vpcs_list_members"]; + get: operations["registry_list_repositoryManifests"]; put?: never; post?: never; delete?: never; @@ -5262,33 +5085,37 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/uptime/checks": { + "/v2/registry/{registry_name}/repositories/{repository_name}/digests/{manifest_digest}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * List All Checks - * @description To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. - */ - get: operations["uptime_list_checks"]; + get?: never; put?: never; + post?: never; /** - * Create a New Check - * @description To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes - * in the table below in the JSON body. + * Delete Container Registry Repository Manifest + * @description To delete a container repository manifest by digest, send a DELETE request to + * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. + * + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to delete + * `registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. * */ - post: operations["uptime_create_check"]; - delete?: never; + delete: operations["registry_delete_repositoryManifest"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/uptime/checks/{check_id}": { + "/v2/registry/{registry_name}/garbage-collection": { parameters: { query?: never; header?: never; @@ -5296,33 +5123,44 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Check - * @description To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. - */ - get: operations["uptime_get_check"]; - /** - * Update a Check - * @description To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`. - * + * Get Active Garbage Collection + * @description To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. */ - put: operations["uptime_update_check"]; - post?: never; + get: operations["registry_get_garbageCollection"]; + put?: never; /** - * Delete a Check - * @description To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status - * code with no body will be returned in response to a successful request. + * Start Garbage Collection + * @description Garbage collection enables users to clear out unreferenced blobs (layer & + * manifest data) after deleting one or more manifests from a repository. If + * there are no unreferenced blobs resulting from the deletion of one or more + * manifests, garbage collection is effectively a noop. + * [See here for more information](https://www.digitalocean.com/docs/container-registry/how-to/clean-up-container-registry/) + * about how and why you should clean up your container registry periodically. * + * To request a garbage collection run on your registry, send a POST request to + * `/v2/registry/$REGISTRY_NAME/garbage-collection`. This will initiate the + * following sequence of events on your registry. * - * Deleting a check will also delete alerts associated with the check. + * * Set the registry to read-only mode, meaning no further write-scoped + * JWTs will be issued to registry clients. Existing write-scoped JWTs will + * continue to work until they expire which can take up to 15 minutes. + * * Wait until all existing write-scoped JWTs have expired. + * * Scan all registry manifests to determine which blobs are unreferenced. + * * Delete all unreferenced blobs from the registry. + * * Record the number of blobs deleted and bytes freed, mark the garbage + * collection status as `success`. + * * Remove the read-only mode restriction from the registry, meaning write-scoped + * JWTs will once again be issued to registry clients. * */ - delete: operations["uptime_delete_check"]; + post: operations["registry_run_garbageCollection"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/uptime/checks/{check_id}/state": { + "/v2/registry/{registry_name}/garbage-collections": { parameters: { query?: never; header?: never; @@ -5330,10 +5168,10 @@ export interface paths { cookie?: never; }; /** - * Retrieve Check State - * @description To show information about an existing check's state, send a GET request to `/v2/uptime/checks/$CHECK_ID/state`. + * List Garbage Collections + * @description To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. */ - get: operations["uptime_get_checkState"]; + get: operations["registry_list_garbageCollections"]; put?: never; post?: never; delete?: never; @@ -5342,33 +5180,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/uptime/checks/{check_id}/alerts": { + "/v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List All Alerts - * @description To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. - */ - get: operations["uptime_list_alerts"]; - put?: never; - /** - * Create a New Alert - * @description To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes - * in the table below in the JSON body. - * + * Update Garbage Collection + * @description To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. */ - post: operations["uptime_create_alert"]; - delete?: never; + put: operations["registry_update_garbageCollection"]; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/uptime/checks/{check_id}/alerts/{alert_id}": { + "/v2/registry/options": { parameters: { query?: never; header?: never; @@ -5376,183 +5208,980 @@ export interface paths { cookie?: never; }; /** - * Retrieve an Existing Alert - * @description To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. + * List Registry Options (Subscription Tiers and Available Regions) + * @description This endpoint serves to provide additional information as to which option values are available when creating a container registry. + * There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. + * There are multiple regions available for container registry and controls where your data is stored. + * To list the available options, send a GET request to `/v2/registry/options`. */ - get: operations["uptime_get_alert"]; + get: operations["registry_get_options"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/reports/droplet_neighbors_ids": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Update an Alert - * @description To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. + * List All Droplet Neighbors + * @description To retrieve a list of all Droplets that are co-located on the same physical + * hardware, send a GET request to `/v2/reports/droplet_neighbors_ids`. + * + * The results will be returned as a JSON object with a key of `neighbor_ids`. + * This will be set to an array of arrays. Each array will contain a set of + * Droplet IDs for Droplets that share a physical server. An empty array + * indicates that all Droplets associated with your account are located on + * separate physical hardware. * */ - put: operations["uptime_update_alert"]; + get: operations["droplets_list_neighborsIds"]; + put?: never; post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/reserved_ips": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Delete an Alert - * @description To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status - * code with no body will be returned in response to a successful request. + * List All Reserved IPs + * @description To list all of the reserved IPs available on your account, send a GET request to `/v2/reserved_ips`. + */ + get: operations["reservedIPs_list"]; + put?: never; + /** + * Create a New Reserved IP + * @description On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. + * * To create a new reserved IP assigned to a Droplet, send a POST + * request to `/v2/reserved_ips` with the `droplet_id` attribute. + * + * * To create a new reserved IP reserved to a region, send a POST request to + * `/v2/reserved_ips` with the `region` attribute. * + * **Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. */ - delete: operations["uptime_delete_alert"]; + post: operations["reservedIPs_create"]; + delete?: never; options?: never; head?: never; 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/reserved_ips/{reserved_ip}": { + 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 + * Retrieve an Existing Reserved IP + * @description To show information about a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP_ADDR`. */ - ssh_key_id: number; + get: operations["reservedIPs_get"]; + put?: never; + post?: 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 + * Delete a Reserved IP + * @description To delete a reserved IP and remove it from your account, send a DELETE request + * to `/v2/reserved_ips/$RESERVED_IP_ADDR`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + * */ - ssh_key_fingerprint: string; + delete: operations["reservedIPs_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/reserved_ips/{reserved_ip}/actions": { + 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 All Actions for a Reserved IP + * @description To retrieve all actions that have been executed on a reserved IP, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions`. */ - 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. + get: operations["reservedIPsActions_list"]; + put?: never; + /** + * Initiate a Reserved IP Action + * @description To initiate an action on a reserved IP send a POST request to + * `/v2/reserved_ips/$RESERVED_IP/actions`. In the JSON body to the request, + * set the `type` attribute to on of the supported action types: + * + * | Action | Details + * |------------|-------- + * | `assign` | Assigns a reserved IP to a Droplet + * | `unassign` | Unassign a reserved IP from a Droplet + * + */ + post: operations["reservedIPsActions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/reserved_ips/{reserved_ip}/actions/{action_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Reserved IP Action + * @description To retrieve the status of a reserved IP action, send a GET request to `/v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID`. + */ + get: operations["reservedIPsActions_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Droplet Sizes + * @description To list all of available Droplet sizes, send a GET request to `/v2/sizes`. + * The response will be 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. + */ + get: operations["sizes_list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Snapshots + * @description To list all of the snapshots available on your account, send a GET request to + * `/v2/snapshots`. + * + * The response will be a JSON object with a key called `snapshots`. This will be + * set to an array of `snapshot` objects, each of which will contain the standard + * snapshot attributes. + * + * ### Filtering Results by Resource Type + * + * It's possible to request filtered results by including certain query parameters. + * + * #### List Droplet Snapshots + * + * To retrieve only snapshots based on Droplets, include the `resource_type` + * query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. + * + * #### List Volume Snapshots + * + * To retrieve only snapshots based on volumes, include the `resource_type` + * query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. + * + */ + get: operations["snapshots_list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/snapshots/{snapshot_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Snapshot + * @description To retrieve information about a snapshot, send a GET request to + * `/v2/snapshots/$SNAPSHOT_ID`. + * + * The response will be a JSON object with a key called `snapshot`. The value of + * this will be an snapshot object containing the standard snapshot attributes. + * + */ + get: operations["snapshots_get"]; + put?: never; + post?: never; + /** + * Delete a Snapshot + * @description Both Droplet and volume snapshots are managed through the `/v2/snapshots/` + * endpoint. To delete a snapshot, send a DELETE request to + * `/v2/snapshots/$SNAPSHOT_ID`. + * + * A status of 204 will be given. This indicates that the request was processed + * successfully, but that no response body is needed. + * + */ + delete: operations["snapshots_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Tags + * @description To list all of your tags, you can send a GET request to `/v2/tags`. + */ + get: operations["tags_list"]; + put?: never; + /** + * Create a New Tag + * @description To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. + */ + post: operations["tags_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/tags/{tag_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a Tag + * @description To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. + */ + get: operations["tags_get"]; + put?: never; + post?: never; + /** + * Delete a Tag + * @description A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag + */ + delete: operations["tags_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/tags/{tag_id}/resources": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Tag a Resource + * @description Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. + * Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + */ + post: operations["tags_assign_resources"]; + /** + * Untag a Resource + * @description Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. + * Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + */ + delete: operations["tags_unassign_resources"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Block Storage Volumes + * @description To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. + * ## Filtering Results + * ### By Region + * The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` + * ### By Name + * It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. + * **Note:** You can only create one volume per region with the same name. + * ### By Name and Region + * It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. + * + * + * + */ + get: operations["volumes_list"]; + put?: never; + /** + * Create a New Block Storage Volume + * @description To create a new volume, send a POST request to `/v2/volumes`. Optionally, a `filesystem_type` attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to Droplets without support for auto-mounting is not recommended. + */ + post: operations["volumes_create"]; + /** + * Delete a Block Storage Volume by Name + * @description Block storage volumes may also be deleted by name by sending a DELETE request with the volume's **name** and the **region slug** for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. + * No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. + * + * + */ + delete: operations["volumes_delete_byName"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Initiate A Block Storage Action By Volume Name + * @description To initiate an action on a block storage volume by Name, send a POST request to + * `~/v2/volumes/actions`. The body should contain the appropriate + * attributes for the respective action. + * + * ## Attach a Block Storage Volume to a Droplet + * + * | Attribute | Details | + * | ----------- | ------------------------------------------------------------------- | + * | type | This must be `attach` | + * | volume_name | The name of the block storage volume | + * | droplet_id | Set to the Droplet's ID | + * | region | Set to the slug representing the region where the volume is located | + * + * Each volume may only be attached to a single Droplet. However, up to fifteen + * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be + * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS + * Droplets created on or after April 26, 2018 when attached. On older Droplets, + * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + * is required. + * + * ## Remove a Block Storage Volume from a Droplet + * + * | Attribute | Details | + * | ----------- | ------------------------------------------------------------------- | + * | type | This must be `detach` | + * | volume_name | The name of the block storage volume | + * | droplet_id | Set to the Droplet's ID | + * | region | Set to the slug representing the region where the volume is located | + * + */ + post: operations["volumeActions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/snapshots/{snapshot_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Volume Snapshot + * @description To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. + * + * + */ + get: operations["volumeSnapshots_get_byId"]; + put?: never; + post?: never; + /** + * Delete a Volume Snapshot + * @description To delete a volume snapshot, send a DELETE request to + * `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. + * + * A status of 204 will be given. This indicates that the request was processed + * successfully, but that no response body is needed. + * + */ + delete: operations["volumeSnapshots_delete_byId"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/{volume_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Block Storage Volume + * @description To show information about a block storage volume, send a GET request to `/v2/volumes/$VOLUME_ID`. + * + * + */ + get: operations["volumes_get"]; + put?: never; + post?: never; + /** + * Delete a Block Storage Volume + * @description To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to `/v2/volumes/$VOLUME_ID`. + * No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. + * + * + */ + delete: operations["volumes_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/{volume_id}/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Actions for a Volume + * @description To retrieve all actions that have been executed on a volume, send a GET request to `/v2/volumes/$VOLUME_ID/actions`. + * + * + */ + get: operations["volumeActions_list"]; + put?: never; + /** + * Initiate A Block Storage Action By Volume Id + * @description To initiate an action on a block storage volume by Id, send a POST request to + * `~/v2/volumes/$VOLUME_ID/actions`. The body should contain the appropriate + * attributes for the respective action. + * + * ## Attach a Block Storage Volume to a Droplet + * + * | Attribute | Details | + * | ---------- | ------------------------------------------------------------------- | + * | type | This must be `attach` | + * | droplet_id | Set to the Droplet's ID | + * | region | Set to the slug representing the region where the volume is located | + * + * Each volume may only be attached to a single Droplet. However, up to fifteen + * volumes may be attached to a Droplet at a time. Pre-formatted volumes will be + * automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS + * Droplets created on or after April 26, 2018 when attached. On older Droplets, + * [additional configuration](https://www.digitalocean.com/community/tutorials/how-to-partition-and-format-digitalocean-block-storage-volumes-in-linux#mounting-the-filesystems) + * is required. + * + * ## Remove a Block Storage Volume from a Droplet + * + * | Attribute | Details | + * | ---------- | ------------------------------------------------------------------- | + * | type | This must be `detach` | + * | droplet_id | Set to the Droplet's ID | + * | region | Set to the slug representing the region where the volume is located | + * + * ## Resize a Volume + * + * | Attribute | Details | + * | -------------- | ------------------------------------------------------------------- | + * | type | This must be `resize` | + * | size_gigabytes | The new size of the block storage volume in GiB (1024^3) | + * | region | Set to the slug representing the region where the volume is located | + * + * Volumes may only be resized upwards. The maximum size for a volume is 16TiB. + * + */ + post: operations["volumeActions_post_byId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/{volume_id}/actions/{action_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Volume Action + * @description To retrieve the status of a volume action, send a GET request to `/v2/volumes/$VOLUME_ID/actions/$ACTION_ID`. + * + * + */ + get: operations["volumeActions_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes/{volume_id}/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Snapshots for a Volume + * @description To retrieve the snapshots that have been created from a volume, send a GET request to `/v2/volumes/$VOLUME_ID/snapshots`. + * + * + */ + get: operations["volumeSnapshots_list"]; + put?: never; + /** + * Create Snapshot from a Volume + * @description To create a snapshot from a volume, sent a POST request to `/v2/volumes/$VOLUME_ID/snapshots`. + */ + post: operations["volumeSnapshots_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/vpcs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All VPCs + * @description To list all of the VPCs on your account, send a GET request to `/v2/vpcs`. + */ + get: operations["vpcs_list"]; + put?: never; + /** + * Create a New VPC + * @description To create a VPC, send a POST request to `/v2/vpcs` specifying the attributes + * in the table below in the JSON body. + * + * **Note:** If you do not currently have a VPC network in a specific datacenter + * region, the first one that you create will be set as the default for that + * region. The default VPC for a region cannot be changed or deleted. + * + */ + post: operations["vpcs_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/vpcs/{vpc_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing VPC + * @description To show information about an existing VPC, send a GET request to `/v2/vpcs/$VPC_ID`. + */ + get: operations["vpcs_get"]; + /** + * Update a VPC + * @description To update information about a VPC, send a PUT request to `/v2/vpcs/$VPC_ID`. + * + */ + put: operations["vpcs_update"]; + post?: never; + /** + * Delete a VPC + * @description To delete a VPC, send a DELETE request to `/v2/vpcs/$VPC_ID`. A 204 status + * code with no body will be returned in response to a successful request. + * + * The default VPC for a region can not be deleted. Additionally, a VPC can only + * be deleted if it does not contain any member resources. Attempting to delete + * a region's default VPC or a VPC that still has members will result in a + * 403 Forbidden error response. + * + */ + delete: operations["vpcs_delete"]; + options?: never; + head?: never; + /** + * Partially Update a VPC + * @description To update a subset of information about a VPC, send a PATCH request to + * `/v2/vpcs/$VPC_ID`. + * + */ + patch: operations["vpcs_patch"]; + trace?: never; + }; + "/v2/vpcs/{vpc_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List the Member Resources of a VPC + * @description To list all of the resources that are members of a VPC, send a GET request to + * `/v2/vpcs/$VPC_ID/members`. + * + * To only list resources of a specific type that are members of the VPC, + * included a `resource_type` query parameter. For example, to only list Droplets + * in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. + * + */ + get: operations["vpcs_list_members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/uptime/checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Checks + * @description To list all of the Uptime checks on your account, send a GET request to `/v2/uptime/checks`. + */ + get: operations["uptime_list_checks"]; + put?: never; + /** + * Create a New Check + * @description To create an Uptime check, send a POST request to `/v2/uptime/checks` specifying the attributes + * in the table below in the JSON body. + * + */ + post: operations["uptime_create_check"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/uptime/checks/{check_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Check + * @description To show information about an existing check, send a GET request to `/v2/uptime/checks/$CHECK_ID`. + */ + get: operations["uptime_get_check"]; + /** + * Update a Check + * @description To update the settings of an Uptime check, send a PUT request to `/v2/uptime/checks/$CHECK_ID`. + * + */ + put: operations["uptime_update_check"]; + post?: never; + /** + * Delete a Check + * @description To delete an Uptime check, send a DELETE request to `/v2/uptime/checks/$CHECK_ID`. A 204 status + * code with no body will be returned in response to a successful request. + * + * + * Deleting a check will also delete alerts associated with the check. + * + */ + delete: operations["uptime_delete_check"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/uptime/checks/{check_id}/state": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Check State + * @description To show information about an existing check's state, send a GET request to `/v2/uptime/checks/$CHECK_ID/state`. + */ + get: operations["uptime_get_checkState"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/uptime/checks/{check_id}/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Alerts + * @description To list all of the alerts for an Uptime check, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts`. + */ + get: operations["uptime_list_alerts"]; + put?: never; + /** + * Create a New Alert + * @description To create an Uptime alert, send a POST request to `/v2/uptime/checks/$CHECK_ID/alerts` specifying the attributes + * in the table below in the JSON body. + * + */ + post: operations["uptime_create_alert"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/uptime/checks/{check_id}/alerts/{alert_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Alert + * @description To show information about an existing alert, send a GET request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. + */ + get: operations["uptime_get_alert"]; + /** + * Update an Alert + * @description To update the settings of an Uptime alert, send a PUT request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. + * + */ + put: operations["uptime_update_alert"]; + post?: never; + /** + * Delete an Alert + * @description To delete an Uptime alert, send a DELETE request to `/v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID`. A 204 status + * code with no body will be returned in response to a successful request. + * + */ + delete: operations["uptime_delete_alert"]; + options?: never; + head?: never; + 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; + }; + }; + /** + * @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; @@ -6094,7 +6723,8 @@ export interface components { * @example node-js */ environment_slug?: string; - log_destinations?: components["schemas"]["app_log_destination_definition"]; + /** @description A list of configured log forwarding destinations. */ + log_destinations?: components["schemas"]["app_log_destination_definition"][]; }; app_component_instance_base: { /** @@ -6424,7 +7054,8 @@ export interface components { git?: components["schemas"]["apps_git_source_spec"]; github?: components["schemas"]["apps_github_source_spec"]; gitlab?: components["schemas"]["apps_gitlab_source_spec"]; - log_destinations?: components["schemas"]["app_log_destination_definition"]; + /** @description A list of configured log forwarding destinations. */ + log_destinations?: components["schemas"]["app_log_destination_definition"][]; }; app_database_spec: { /** @@ -6856,6 +7487,12 @@ export interface components { }; apps_update_app_request: { spec: components["schemas"]["app_spec"]; + /** + * @description Whether or not to update the source versions (for example fetching a new commit or image digest) of all components. By default (when this is false) only newly added sources will be updated to avoid changes like updating the scale of a component from also updating the respective code. + * @default false + * @example true + */ + update_all_source_versions: boolean; }; apps_delete_app_response: { /** @@ -6887,42 +7524,6 @@ export interface components { apps_deployment_response: { deployment?: components["schemas"]["apps_deployment"]; }; - apps_tier: { - /** - * The amount of included build time in seconds - * Format: int64 - * @example 233 - */ - build_seconds?: string; - /** - * The amount of included outbound bandwidth in bytes - * Format: int64 - * @example 123 - */ - egress_bandwidth_bytes?: string; - /** - * A human-readable name of the tier - * @example test - */ - name?: string; - /** - * The slug of the tier - * @example test - */ - slug?: string; - /** - * The allotted disk space in bytes - * Format: int64 - * @example 10000000 - */ - storage_bytes?: string; - }; - apps_list_tiers_response: { - tiers?: components["schemas"]["apps_tier"][]; - }; - apps_get_tier_response: { - tier?: components["schemas"]["apps_tier"]; - }; /** * - SHARED: Shared vCPU cores * - DEDICATED: Dedicated vCPU cores @@ -7889,7 +8490,7 @@ export interface components { opensearch_connection: { /** * @description This is provided as a convenience and should be able to be constructed by the other attributes. - * @example opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + * @example https://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060 */ readonly uri?: string; /** @@ -7976,6 +8577,20 @@ export interface components { * @example true */ pg_allow_replication?: boolean; + /** @description ACLs (Access Control Lists) specifying permissions on index within a OpenSearch cluster. */ + opensearch_acl?: { + /** + * @description A regex for matching the indexes that this ACL should apply to. + * @example index-abc.* + */ + index?: string; + /** + * @description Permission set applied to the ACL. 'read' allows user to read from the index. 'write' allows for user to write to the index. 'readwrite' allows for both 'read' and 'write' permission. 'deny'(default) restricts user from performing any operation over an index. 'admin' allows for 'readwrite' as well as any operations to administer the index. + * @example read + * @enum {string} + */ + permission?: "deny" | "admin" | "read" | "readwrite" | "write"; + }[]; /** @description ACLs (Access Control Lists) specifying permissions on topics within a Kafka cluster. */ acl?: { /** @@ -9961,6 +10576,48 @@ export interface components { database_metrics_credentials: { credentials?: components["schemas"]["databases_basic_auth_credentials"]; }; + opensearch_index_base: { + /** + * @description The name of the opensearch index. + * @example events + */ + index_name?: string; + /** + * @description The number of shards for the index. + * @example 2 + */ + number_of_shards?: number; + /** + * @description The number of replicas for the index. + * @example 3 + */ + number_of_replicas?: number; + /** + * @description The size of the index. + * @example 208 + */ + size?: number; + /** + * Format: date-time + * @description The date and time the index was created. + * @example 2021-01-01T00:00:00Z + */ + created_time?: string; + }; + opensearch_index: components["schemas"]["opensearch_index_base"] & { + /** + * @description The status of the OpenSearch index. + * @example open + * @enum {string} + */ + status?: "unknown" | "open" | "close" | "none"; + /** + * @description The health of the OpenSearch index. + * @example green + * @enum {string} + */ + health?: "unknown" | "green" | "yellow" | "red" | "red*"; + }; domain: { /** * @description The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. @@ -10078,6 +10735,20 @@ export interface components { */ version?: string; } | null; + droplet_next_backup_window: { + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window. + * @example 2019-12-04T00:00:00Z + */ + start?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window. + * @example 2019-12-04T23:00:00Z + */ + end?: string; + } | null; /** * @description The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. * @example Nifty New Snapshot @@ -10361,21 +11032,7 @@ export interface components { * ] */ backup_ids: number[]; - /** @description The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. */ - next_backup_window: { - /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window. - * @example 2019-12-04T00:00:00Z - */ - start?: string; - /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window. - * @example 2019-12-04T23:00:00Z - */ - end?: string; - } | null; + next_backup_window: components["schemas"]["droplet_next_backup_window"] & unknown; /** * @description An array of snapshot IDs of any snapshots created from the Droplet instance. * @example [ @@ -10417,6 +11074,36 @@ export interface components { */ vpc_uuid?: string; }; + droplet_backup_policy: { + /** + * @description The backup plan used for the Droplet. The plan can be either `daily` or `weekly`. + * @example daily + * @enum {string} + */ + plan?: "daily" | "weekly"; + /** + * @description The day of the week on which the backup will occur. + * @example SUN + * @enum {string} + */ + weekday?: "SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT"; + /** + * @description The hour of the day that the backup window will start. + * @example 0 + * @enum {integer} + */ + hour?: 0 | 4 | 8 | 12 | 16 | 20; + /** + * @description The length of the backup window starting from `hour`. + * @example 4 + */ + readonly window_length_hours?: number; + /** + * @description The number of days the backup will be retained. + * @example 7 + */ + readonly retention_period_days?: number; + }; droplet_create: { /** * @description The slug identifier for the region that you wish to deploy the Droplet in. If the specific datacenter is not not important, a slug prefix (e.g. `nyc`) can be used to deploy the Droplet in any of the that region's locations (`nyc1`, `nyc2`, or `nyc3`). If the region is omitted from the create request completely, the Droplet may deploy in any region. @@ -10448,6 +11135,7 @@ export interface components { * @example true */ backups: boolean; + backup_policy?: components["schemas"]["droplet_backup_policy"] & unknown; /** * @description A boolean indicating whether to enable IPv6 on the Droplet. * @default false @@ -10587,6 +11275,64 @@ export interface components { */ type: "snapshot" | "backup"; }; + droplet_backup_policy_record: { + /** + * @description The unique identifier for the Droplet. + * @example 7101383 + */ + droplet_id?: number; + /** + * @description A boolean value indicating whether backups are enabled for the Droplet. + * @example true + */ + backup_enabled?: boolean; + backup_policy?: components["schemas"]["droplet_backup_policy"] & unknown; + next_backup_window?: components["schemas"]["droplet_next_backup_window"] & unknown; + }; + supported_droplet_backup_policy: { + /** + * @description The name of the Droplet backup plan. + * @example daily + */ + name?: string; + /** + * @description An array of integers representing the hours of the day that a backup can + * start. + * + * @example [ + * 0, + * 4, + * 8, + * 12, + * 16, + * 20 + * ] + */ + possible_window_starts?: number[]; + /** + * @description The number of hours that a backup window is open. + * @example 4 + */ + window_length_hours?: number; + /** + * @description The number of days that a backup will be kept. + * @example 7 + */ + retention_period_days?: number; + /** + * @description The day of the week the backup will occur. + * @example [ + * "SUN", + * "MON", + * "TUE", + * "WED", + * "THU", + * "FRI", + * "SAT" + * ] + */ + possible_days?: string[]; + }; /** @description Specifies the action that will be taken on the Droplet. */ droplet_action: { /** @@ -10595,6 +11341,27 @@ export interface components { */ type: "enable_backups" | "disable_backups" | "power_cycle" | "shutdown" | "power_off" | "power_on" | "enable_ipv6"; }; + /** @example { + * "type": "enable_backups", + * "backup_policy": { + * "plan": "daily", + * "hour": 20 + * } + * } */ + droplet_action_enable_backups: components["schemas"]["droplet_action"] & { + backup_policy?: components["schemas"]["droplet_backup_policy"] & unknown; + }; + /** @example { + * "type": "enable_backups", + * "backup_policy": { + * "plan": "weekly", + * "day": "SUN", + * "hour": 20 + * } + * } */ + droplet_action_change_backup_policy: components["schemas"]["droplet_action"] & { + backup_policy: components["schemas"]["droplet_backup_policy"] & unknown; + }; droplet_action_restore: components["schemas"]["droplet_action"] & { /** * @description The ID of a backup of the current Droplet instance to restore from. @@ -12070,7 +12837,7 @@ export interface components { }; metrics_result: { /** - * @description An object containing the metric labels. + * @description An object containing the metric's labels. These labels are key/value pairs that vary depending on the metric being queried. For example, load balancer metrics contain a `lb_id` label, while Droplet metrics contain a `host_id` label, and App Platform metrics contain a `app_component` label. * @example { * "host_id": "19201920" * } @@ -12078,7 +12845,9 @@ export interface components { metric: { [key: string]: string; }; - /** @example [ + /** + * @description An array of values for the metric. + * @example [ * [ * 1435781430, * "1" @@ -12087,7 +12856,8 @@ export interface components { * 1435781445, * "1" * ] - * ] */ + * ] + */ values: (number | string)[][]; }; metrics_data: { @@ -13409,30 +14179,6 @@ export interface components { "application/json": components["schemas"]["apps_deployment_response"]; }; }; - /** @description A JSON object with a `tiers` key. This will be a list of all app tiers */ - all_tiers: { - 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_tiers_response"]; - }; - }; - /** @description A JSON with the key `tier` */ - get_tier: { - 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_tier_response"]; - }; - }; /** @description A JSON with key `instance_sizes` */ list_instance: { headers: { @@ -14031,7 +14777,9 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["logsink_verbose"]; + "application/json": { + sink?: components["schemas"]["logsink_verbose"]; + }; }; }; /** @description A JSON object with a key of `credentials`. */ @@ -14048,6 +14796,20 @@ export interface components { }; }; }; + /** @description A JSON object with a key of `indexes`. */ + opensearch_indexes: { + 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": { + indexes?: components["schemas"]["opensearch_index"][]; + }; + }; + }; /** @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: { @@ -14210,6 +14972,55 @@ export interface components { } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; + /** @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: { + 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": { + policy?: components["schemas"]["droplet_backup_policy_record"]; + }; + }; + }; + /** @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"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [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"]; + }; + }; + /** @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"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + supported_policies?: components["schemas"]["supported_droplet_backup_policy"][]; + }; + }; + }; /** @description A JSON object with an `snapshots` key. */ all_droplet_snapshots: { headers: { @@ -15869,11 +16680,6 @@ export interface components { * @example 3aa4d20e-5527-4c00-b496-601fbd22520a */ deployment_id: string; - /** - * @description The slug of the tier - * @example basic - */ - slug_tier: string; /** * @description The slug of the instance size * @example apps-s-1vcpu-0.5gb @@ -15949,6 +16755,11 @@ export interface components { * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 */ logsink_id: string; + /** + * @description The name of the OpenSearch index. + * @example logs-* + */ + opensearch_index_name: string; /** * @description The name of the domain itself. * @example example.com @@ -16114,6 +16925,11 @@ export interface components { * @example sample-application */ app_component: string; + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + parameters_load_balancer_id: string; /** * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 @@ -16225,164 +17041,574 @@ 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"]; + }; }; - pathItems: never; -} -export type $defs = Record; -export interface operations { - oneClicks_list: { + actions_list: { parameters: { query?: { /** - * @description Restrict results to a certain type of 1-Click. - * @example kubernetes + * @description Number of items returned per page + * @example 2 */ - type?: components["parameters"]["oneClicks_type"]; + 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; + 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"]["oneClicks_all"]; + 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"]; }; }; - oneClicks_install_kubernetes: { + apps_delete: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["oneClicks_create"]; + 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"]["oneClicks_create"]; + 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"]; }; }; - account_get: { + apps_get_logs_active_deployment: { 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?: 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"]["account"]; + 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_list: { + apps_list_deployments: { 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"]; + }; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - page?: components["parameters"]["page"]; + app_id: components["parameters"]["app_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sshKeys_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"]; }; }; - sshKeys_create: { + 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"]["sshKeys"]; + "application/json": components["schemas"]["apps_create_deployment_request"]; }; }; responses: { - 201: components["responses"]["sshKeys_new"]; + 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"]; }; }; - sshKeys_get: { + apps_get_deployment: { 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_deployment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16390,29 +17616,80 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_update: { + apps_cancel_deployment: { 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; }; - /** @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"]["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"]; + }; + }; + apps_get_logs: { + 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 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_existing"]; + 200: components["responses"]["list_logs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16420,22 +17697,90 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_delete: { + apps_get_logs_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 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"]["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_logs_active_deployment_aggregate: { + 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 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"]; @@ -16443,49 +17788,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"]; @@ -16493,53 +17827,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; }; @@ -16567,45 +17874,69 @@ 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?: { + query?: never; + header?: never; + path: { /** - * @description The name of the app to retrieve. - * @example myApp + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - name?: components["parameters"]["app_name"]; + app_id: components["parameters"]["app_id"]; }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_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"]; + }; + }; + 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?: never; + requestBody: { + content: { + "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; + }; + }; responses: { - 200: components["responses"]["apps_get"]; + 200: components["responses"]["assign_alert_destinations"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16613,26 +17944,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_update: { + 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: { content: { - "application/json": components["schemas"]["apps_update_app_request"]; + "application/json": components["schemas"]["apps_rollback_app_request"]; }; }; responses: { - 200: components["responses"]["update_app"]; + 200: components["responses"]["new_app_deployment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16640,22 +17971,129 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_delete: { + apps_validate_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: { + content: { + "application/json": components["schemas"]["apps_rollback_app_request"]; + }; + }; + responses: { + 200: components["responses"]["apps_validate_rollback"]; + 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_commit_rollback: { + 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?: never; responses: { - 200: components["responses"]["delete_app"]; + 200: 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_revert_rollback: { + 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?: never; + 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_metrics_bandwidth_daily: { + 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 + */ + date?: string; + }; + header?: 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"]["get_metrics_bandwidth_usage"]; + 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_metrics_bandwidth_daily: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + 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"]; + }; + }; + responses: { + 200: components["responses"]["list_metrics_bandwidth_usage"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16663,81 +18101,69 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment: { + cdn_list_endpoints: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; + query?: { /** - * @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 Number of items returned per page + * @example 2 */ - type: components["parameters"]["log_type"]; + per_page?: components["parameters"]["per_page"]; /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m + * @description Which 'page' of paginated results to return. + * @example 1 */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + page?: components["parameters"]["page"]; }; 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"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 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_list_deployments: { + cdn_create_endpoint: { 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"]; + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["cdn_endpoint"]; }; + }; + responses: { + 201: components["responses"]["existing_endpoint"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + cdn_get_endpoint: { + parameters: { + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - app_id: components["parameters"]["app_id"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_deployments"]; + 200: components["responses"]["existing_endpoint"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16745,26 +18171,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_create_deployment: { + cdn_update_endpoints: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - app_id: components["parameters"]["app_id"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["apps_create_deployment_request"]; + "application/json": components["schemas"]["update_endpoint"]; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["existing_endpoint"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16772,27 +18198,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_deployment: { + 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_deployment"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16800,27 +18221,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_cancel_deployment: { + 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 + * @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; + requestBody: { + content: { + "application/json": components["schemas"]["purge_cache"]; + }; + }; responses: { - 200: components["responses"]["cancel_deployment"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16828,100 +18248,74 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs: { + 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"]; - /** - * @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"]; - }; + 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_get_logs_aggregate: { + certificates_create: { 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?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; }; + }; + responses: { + 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"]; + }; + }; + certificates_get: { + 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 certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - deployment_id: components["parameters"]["deployment_id"]; + certificate_id: components["parameters"]["certificate_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["existing_certificate"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -16929,42 +18323,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment_aggregate: { + certificates_delete: { 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 + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - app_id: components["parameters"]["app_id"]; + certificate_id: components["parameters"]["certificate_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"]; @@ -16972,7 +18346,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_tiers: { + balance_get: { parameters: { query?: never; header?: never; @@ -16981,29 +18355,24 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_tiers"]; + 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_get_tier: { + billingHistory_list: { parameters: { query?: never; header?: never; - path: { - /** - * @description The slug of the tier - * @example basic - */ - slug: components["parameters"]["slug_tier"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_tier"]; + 200: components["responses"]["billing_history"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17011,38 +18380,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_instanceSizes: { + invoices_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?: never; responses: { - 200: components["responses"]["list_instance"]; + 200: components["responses"]["invoices"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_get_instanceSize: { + invoices_get_byUUID: { parameters: { query?: never; header?: never; path: { /** - * @description The slug of the instance size - * @example apps-s-1vcpu-0.5gb + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - slug: components["parameters"]["slug_size"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_instance"]; + 200: components["responses"]["invoice"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17050,84 +18430,68 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_regions: { + invoices_get_csvByUUID: { parameters: { query?: never; header?: never; - path?: 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"]["list_regions"]; + 200: components["responses"]["invoice_csv"]; 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: { + invoices_get_pdfByUUID: { 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"]; + 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"]["propose_app"]; + 200: components["responses"]["invoice_pdf"]; 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: { + 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"]["list_alerts"]; + 200: components["responses"]["invoice_summary"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17135,31 +18499,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_assign_alertDestinations: { + 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"]; - /** - * @description The alert ID - * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d - */ - alert_id: components["parameters"]["alert_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["assign_alert_destinations"]; + 200: components["responses"]["options"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17167,26 +18516,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_create_rollback: { + databases_list_clusters: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description Limits the results to database clusters with a specific tag. + * @example production */ - app_id: components["parameters"]["app_id"]; + tag_name?: components["parameters"]["tag_name"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_rollback_app_request"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["database_clusters"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17194,26 +18539,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_validate_rollback: { + databases_create_cluster: { 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_rollback_app_request"]; + "application/json": components["schemas"]["database_cluster"] & { + backup_restore?: components["schemas"]["database_backup"]; + }; }; }; responses: { - 200: components["responses"]["apps_validate_rollback"]; + 201: components["responses"]["database_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17221,22 +18562,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_commit_rollback: { + databases_get_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - app_id: components["parameters"]["app_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["database_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17244,22 +18585,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_revert_rollback: { + databases_destroy_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - app_id: components["parameters"]["app_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["new_app_deployment"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17267,28 +18608,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_metrics_bandwidth_daily: { + databases_get_config: { 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 - */ - date?: string; - }; + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - app_id: components["parameters"]["app_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_metrics_bandwidth_usage"]; + 200: components["responses"]["database_config"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17296,27 +18631,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_metrics_bandwidth_daily: { + databases_patch_config: { 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: { /** @example { - * "app_ids": [ - * "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", - * "c2a93513-8d9b-4223-9d61-5e7272c81cf5" - * ], - * "date": "2023-01-17T00:00:00Z" + * "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"]["app_metrics_bandwidth_usage_request"]; + "application/json": components["schemas"]["database_config"]; }; }; responses: { - 200: components["responses"]["list_metrics_bandwidth_usage"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17324,69 +18664,86 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_list_endpoints: { + databases_get_ca: { 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"]; - }; - header?: never; - path?: never; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_cdn_endpoints"]; + 200: components["responses"]["ca"]; 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_get_migrationStatus: { 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"]; + 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"]; }; }; - cdn_get_endpoint: { + databases_update_onlineMigration: { 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; + 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" + * ] + * } */ + "application/json": components["schemas"]["source_database"]; + }; + }; responses: { - 200: components["responses"]["existing_endpoint"]; + 200: components["responses"]["online_migration"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17394,26 +18751,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_update_endpoints: { + databases_delete_onlineMigration: { 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"]; + /** + * @description A unique identifier assigned to the online migration. + * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 + */ + migration_id: components["parameters"]["migration_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["update_endpoint"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_endpoint"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17421,22 +18779,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_delete_endpoint: { + databases_update_region: { 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; + requestBody: { + content: { + "application/json": { + /** + * @description A slug identifier for the region to which the database cluster will be migrated. + * @example lon1 + */ + region: 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"]; @@ -17444,26 +18812,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_purge_cache: { + databases_update_clusterSize: { 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"]["purge_cache"]; + /** @example { + * "size": "db-s-4vcpu-8gb", + * "num_nodes": 3, + * "storage_size_mib": 163840 + * } */ + "application/json": components["schemas"]["database_cluster_resize"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17471,74 +18844,102 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - certificates_list: { + databases_list_firewall_rules: { 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 Name of expected certificate - * @example certificate-name + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - name?: components["parameters"]["certificate_name"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_certificates"]; + 200: components["responses"]["firewall_rules"]; 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_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: { content: { - "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; + /** @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: { - 201: components["responses"]["new_certificate"]; + 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_get: { + databases_update_maintenanceWindow: { 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 { + * "day": "tuesday", + * "hour": "14:00" + * } */ + "application/json": components["schemas"]["database_maintenance_window"]; + }; + }; responses: { - 200: components["responses"]["existing_certificate"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17546,16 +18947,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - certificates_delete: { + databases_install_update: { 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; }; @@ -17569,16 +18970,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - balance_get: { + databases_list_backups: { 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"]["balance"]; + 200: components["responses"]["database_backups"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17586,16 +18993,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - billingHistory_list: { + databases_list_replicas: { 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"]["billing_history"]; + 200: components["responses"]["database_replicas"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17603,49 +19016,55 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_list: { + databases_create_replica: { 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"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** @example { + * "name": "read-nyc3-01", + * "region": "nyc3", + * "size": "db-s-2vcpu-4gb", + * "storage_size_mib": 61440 + * } */ + "application/json": WithRequired; }; - header?: never; - path?: never; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["invoices"]; + 201: components["responses"]["database_replica"]; 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_list_events_logs: { 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"]; + 200: components["responses"]["events_logs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17653,22 +19072,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_csvByUUID: { + databases_get_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"]; + /** + * @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"]["invoice_csv"]; + 200: components["responses"]["database_replica"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17676,22 +19100,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_pdfByUUID: { + databases_destroy_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"]; + /** + * @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"]["invoice_pdf"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17699,22 +19128,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_summaryByUUID: { + databases_promote_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"]; + /** + * @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"]["invoice_summary"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17722,39 +19156,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_options: { + databases_list_users: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["options"]; - 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_clusters: { - parameters: { - query?: { + 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"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_clusters"]; + 200: components["responses"]["users"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17762,22 +19179,34 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_cluster: { + databases_add_user: { 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"]["database_cluster"] & { - backup_restore?: components["schemas"]["database_backup"]; + "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: { - 201: components["responses"]["database_cluster"]; + 201: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17785,7 +19214,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_cluster: { + databases_get_user: { parameters: { query?: never; header?: never; @@ -17795,12 +19224,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"]["database_cluster"]; + 200: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17808,7 +19242,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_cluster: { + databases_update_user: { parameters: { query?: never; header?: never; @@ -17818,12 +19252,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: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17831,7 +19276,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_config: { + databases_delete_user: { parameters: { query?: never; header?: never; @@ -17841,12 +19286,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"]["database_config"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17854,7 +19304,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_patch_config: { + databases_reset_auth: { parameters: { query?: never; header?: never; @@ -17864,45 +19314,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 { - * "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 + * "mysql_settings": { + * "auth_plugin": "caching_sha2_password" * } * } */ - "application/json": components["schemas"]["database_config"]; - }; - }; - responses: { - 200: 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_ca: { - 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"]; + "application/json": { + mysql_settings?: components["schemas"]["mysql_settings"]; + }; }; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["ca"]; + 200: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17910,7 +19343,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_migrationStatus: { + databases_list: { parameters: { query?: never; header?: never; @@ -17925,7 +19358,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["online_migration"]; + 200: components["responses"]["databases"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17933,7 +19366,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_onlineMigration: { + databases_add: { parameters: { query?: never; header?: never; @@ -17949,24 +19382,13 @@ export interface operations { 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" - * ] + * "name": "alpha" * } */ - "application/json": components["schemas"]["source_database"]; + "application/json": components["schemas"]["database"]; }; }; responses: { - 200: components["responses"]["online_migration"]; + 201: components["responses"]["database"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -17974,7 +19396,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_onlineMigration: { + databases_get: { parameters: { query?: never; header?: never; @@ -17985,16 +19407,16 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description A unique identifier assigned to the online migration. - * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 + * @description The name of the database. + * @example alpha */ - migration_id: components["parameters"]["migration_id"]; + database_name: components["parameters"]["database_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["database"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18002,7 +19424,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_region: { + databases_delete: { parameters: { query?: never; header?: never; @@ -18012,22 +19434,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: { - "application/json": { - /** - * @description A slug identifier for the region to which the database cluster will be migrated. - * @example lon1 - */ - region: string; - }; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18035,7 +19452,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_clusterSize: { + databases_list_connectionPools: { parameters: { query?: never; header?: never; @@ -18048,18 +19465,9 @@ export interface operations { }; 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"]["connection_pools"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18067,7 +19475,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_firewall_rules: { + databases_add_connectionPool: { parameters: { query?: never; header?: never; @@ -18080,9 +19488,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "name": "backend-pool", + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" + * } */ + "application/json": components["schemas"]["connection_pool"]; + }; + }; responses: { - 200: components["responses"]["firewall_rules"]; + 201: components["responses"]["connection_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18090,7 +19509,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_firewall_rules: { + databases_get_connectionPool: { parameters: { query?: never; header?: never; @@ -18100,38 +19519,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: { - 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_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18139,7 +19537,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_maintenanceWindow: { + databases_update_connectionPool: { parameters: { query?: never; header?: never; @@ -18149,16 +19547,23 @@ 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: { content: { /** @example { - * "day": "tuesday", - * "hour": "14:00" + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" * } */ - "application/json": components["schemas"]["database_maintenance_window"]; + "application/json": components["schemas"]["connection_pool_update"]; }; }; responses: { @@ -18170,7 +19575,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_backups: { + databases_delete_connectionPool: { parameters: { query?: never; header?: never; @@ -18180,12 +19585,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_backups"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18193,7 +19603,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_replicas: { + databases_get_evictionPolicy: { parameters: { query?: never; header?: never; @@ -18208,7 +19618,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["database_replicas"]; + 200: components["responses"]["eviction_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18216,7 +19626,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_replica: { + databases_update_evictionPolicy: { parameters: { query?: never; header?: never; @@ -18229,19 +19639,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { /** @example { - * "name": "read-nyc3-01", - * "region": "nyc3", - * "size": "db-s-2vcpu-4gb", - * "storage_size_mib": 61440 + * "eviction_policy": "allkeys_lru" * } */ - "application/json": WithRequired; + "application/json": { + eviction_policy: components["schemas"]["eviction_policy_model"]; + }; }; }; responses: { - 201: components["responses"]["database_replica"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18249,7 +19658,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_events_logs: { + databases_get_sql_mode: { parameters: { query?: never; header?: never; @@ -18264,7 +19673,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["events_logs"]; + 200: components["responses"]["sql_mode"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18272,7 +19681,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_replica: { + databases_update_sql_mode: { parameters: { query?: never; header?: never; @@ -18282,17 +19691,19 @@ 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 { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE" + * } */ + "application/json": components["schemas"]["sql_mode"]; + }; + }; responses: { - 200: components["responses"]["database_replica"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18300,7 +19711,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_replica: { + databases_update_major_version: { parameters: { query?: never; header?: never; @@ -18310,15 +19721,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"]; @@ -18328,7 +19741,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_promote_replica: { + databases_list_kafka_topics: { parameters: { query?: never; header?: never; @@ -18338,17 +19751,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: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["kafka_topics"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18356,7 +19764,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_users: { + databases_create_kafka_topic: { parameters: { query?: never; header?: never; @@ -18369,9 +19777,22 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "name": "customer-events", + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } */ + "application/json": components["schemas"]["kafka_topic_create"]; + }; + }; responses: { - 200: components["responses"]["users"]; + 201: components["responses"]["kafka_topic"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18379,7 +19800,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add_user: { + databases_get_kafka_topic: { parameters: { query?: never; header?: never; @@ -18389,24 +19810,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 Kafka topic. + * @example customer-events + */ + topic_name: components["parameters"]["kafka_topic_name"]; }; cookie?: 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; - }; - }; - }; + requestBody?: never; 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"]; @@ -18414,7 +19828,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_user: { + databases_update_kafka_topic: { parameters: { query?: never; header?: never; @@ -18425,16 +19839,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?: never; + requestBody?: { + content: { + /** @example { + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } */ + "application/json": components["schemas"]["kafka_topic_update"]; + }; + }; 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"]; @@ -18442,7 +19868,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_user: { + databases_delete_kafka_topic: { parameters: { query?: never; header?: never; @@ -18453,22 +19879,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: { - content: { - "application/json": { - settings: components["schemas"]["user_settings"]; - }; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["user"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18476,7 +19896,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_user: { + databases_list_logsink: { parameters: { query?: never; header?: never; @@ -18486,17 +19906,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?: never; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["logsinks"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18504,7 +19919,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_reset_auth: { + databases_create_logsink: { parameters: { query?: never; header?: never; @@ -18514,28 +19929,16 @@ 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"]; - }; + content: { + "application/json": components["schemas"]["logsink_create"]; }; }; responses: { - 200: components["responses"]["user"]; + 201: components["responses"]["logsink"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18543,7 +19946,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list: { + databases_get_logsink: { parameters: { query?: never; header?: never; @@ -18553,12 +19956,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?: never; responses: { - 200: components["responses"]["databases"]; + 201: components["responses"]["logsink"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18566,7 +19974,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add: { + databases_update_logsink: { parameters: { query?: never; header?: never; @@ -18576,19 +19984,29 @@ 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" + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc3164" + * } * } */ - "application/json": components["schemas"]["database"]; + "application/json": components["schemas"]["logsink_update"]; }; }; responses: { - 201: components["responses"]["database"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18596,7 +20014,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get: { + databases_delete_logsink: { parameters: { query?: never; header?: never; @@ -18607,16 +20025,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: { - 200: components["responses"]["database"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18624,27 +20042,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete: { + 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"]; - /** - * @description The name of the database. - * @example alpha - */ - database_name: components["parameters"]["database_name"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["database_metrics_auth"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18652,30 +20059,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_connectionPools: { + 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?: never; + requestBody?: { + content: { + /** @example { + * "credentials": { + * "basic_auth_username": "new_username", + * "basic_auth_password": "new_password" + * } + * } */ + "application/json": components["schemas"]["database_metrics_credentials"]; + }; + }; responses: { - 200: components["responses"]["connection_pools"]; + 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_add_connectionPool: { + databases_list_opeasearch_indexes: { parameters: { query?: never; header?: never; @@ -18688,20 +20098,9 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "name": "backend-pool", - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" - * } */ - "application/json": components["schemas"]["connection_pool"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["connection_pool"]; + 200: components["responses"]["opensearch_indexes"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18709,7 +20108,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_connectionPool: { + databases_delete_opensearch_index: { parameters: { query?: never; header?: never; @@ -18720,16 +20119,16 @@ 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?: never; responses: { - 200: components["responses"]["connection_pool"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18737,65 +20136,72 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_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: { + requestBody?: never; + responses: { + 200: components["responses"]["all_domains_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + domains_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { content: { /** @example { - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" + * "name": "example.com" * } */ - "application/json": components["schemas"]["connection_pool_update"]; + "application/json": components["schemas"]["domain"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 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_delete_connectionPool: { + domains_get: { 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 connection pool. - * @example backend-pool + * @description The name of the domain itself. + * @example example.com */ - pool_name: components["parameters"]["pool_name"]; + domain_name: components["parameters"]["domain_name"]; }; cookie?: never; }; 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"]; @@ -18803,22 +20209,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_evictionPolicy: { + 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"]["eviction_policy_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18826,31 +20232,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_evictionPolicy: { + 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 { - * "eviction_policy": "allkeys_lru" - * } */ - "application/json": { - eviction_policy: components["schemas"]["eviction_policy_model"]; - }; - }; - }; + 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"]; @@ -18858,22 +20276,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_sql_mode: { + 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?: 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"]; + }; + }; responses: { - 200: components["responses"]["sql_mode"]; + 201: components["responses"]["created_domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18881,29 +20314,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_sql_mode: { + 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 + */ + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_record_id: components["parameters"]["domain_record_id"]; }; 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"]["domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18911,29 +20342,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_major_version: { + 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: { + requestBody?: { content: { /** @example { - * "version": "14" + * "name": "blog", + * "type": "CNAME" * } */ - "application/json": components["schemas"]["version-2"]; + "application/json": components["schemas"]["domain_record"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18941,22 +20378,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_kafka_topics: { + 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 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"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18964,35 +20406,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_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 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": "A" * } */ - "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"]; @@ -19000,95 +20442,79 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_kafka_topic: { + droplets_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 Kafka topic. - * @example customer-events + * @description Which 'page' of paginated results to return. + * @example 1 */ - topic_name: components["parameters"]["kafka_topic_name"]; + page?: components["parameters"]["page"]; + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. + * @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"]; }; + 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_update_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?: { content: { - /** @example { - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } - * } */ - "application/json": components["schemas"]["kafka_topic_update"]; + "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; }; }; responses: { - 200: components["responses"]["kafka_topic"]; + 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_delete_kafka_topic: { + droplets_destroy_byTag: { 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"]; + query: { /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description Specifies Droplets to be deleted by tag. + * @example env:test */ - topic_name: components["parameters"]["kafka_topic_name"]; + tag_name: components["parameters"]["droplet_delete_tag_name"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 204: components["responses"]["no_content_with_content_type"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19096,22 +20522,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_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?: never; responses: { - 201: components["responses"]["logsinks"]; + 200: components["responses"]["existing_droplet"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19119,26 +20545,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_logsink: { + droplets_destroy: { 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"]; + 204: components["responses"]["no_content_with_content_type"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19146,27 +20568,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_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"]; + }; + header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["logsink"]; + 200: components["responses"]["all_droplet_backups"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19174,39 +20602,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_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: { - content: { - /** @example { - * "config": { - * "server": "192.168.0.1", - * "port": 514, - * "tls": false, - * "format": "rfc3164" - * } - * } */ - "application/json": components["schemas"]["logsink_update"]; - }; - }; + 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"]; @@ -19214,27 +20625,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_logsink: { + droplets_list_backup_policies: { 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"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["all_droplet_backup_policies"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19242,7 +20653,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_cluster_metrics_credentials: { + droplets_list_supported_backup_policies: { parameters: { query?: never; header?: never; @@ -19251,7 +20662,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["database_metrics_auth"]; + 200: components["responses"]["droplets_supported_backup_policies"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19259,33 +20670,41 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_cluster_metrics_credentials: { + 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?: never; - cookie?: never; - }; - requestBody?: { - content: { - /** @example { - * "credentials": { - * "basic_auth_username": "new_username", - * "basic_auth_password": "new_password" - * } - * } */ - "application/json": components["schemas"]["database_metrics_credentials"]; + 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_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"]; }; }; - domains_list: { + dropletActions_list: { parameters: { query?: { /** @@ -19300,57 +20719,107 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path?: 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"]["all_domains_response"]; + 200: components["responses"]["all_droplet_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"]; }; }; - domains_create: { + dropletActions_post: { parameters: { query?: never; header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_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"]; + }; + }; + responses: { + 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"]; + }; + }; + dropletActions_post_byTag: { + parameters: { + query?: { + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. + * @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"]; @@ -19358,22 +20827,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"]; @@ -19381,19 +20861,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 @@ -19408,16 +20878,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"]; @@ -19425,37 +20895,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"]; @@ -19463,27 +20918,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"]; @@ -19491,35 +20941,55 @@ 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: { + 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"]; + }; + }; + droplets_destroy_withAssociatedResourcesDangerous: { + parameters: { + query?: never; + header: { + /** + * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. + * @example true + */ + "X-Dangerous": components["parameters"]["x_dangerous"]; + }; + 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"]; 429: components["responses"]["too_many_requests"]; @@ -19527,27 +20997,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_delete_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?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["associated_resources_status"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19555,43 +21020,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_patch_record: { + droplets_destroy_retryWithAssociatedResources: { 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"]["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: { + firewalls_list: { parameters: { query?: { /** @@ -19604,16 +21057,6 @@ export interface operations { * @example 1 */ page?: components["parameters"]["page"]; - /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name`. - * @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"]; }; header?: never; path?: never; @@ -19621,14 +21064,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_droplets"]; + 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"]; }; }; - droplets_create: { + firewalls_create: { parameters: { query?: never; header?: never; @@ -19637,33 +21080,75 @@ export interface operations { }; requestBody?: { content: { - "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; + /** @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"]["droplet_create"]; + 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"]; }; }; - droplets_destroy_byTag: { + firewalls_get: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description Specifies Droplets to be deleted by tag. - * @example env:test + * @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_delete_tag_name"]; + firewall_id: components["parameters"]["firewall_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content_with_content_type"]; + 200: components["responses"]["get_firewall_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19671,22 +21156,71 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_get: { + 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"]["existing_droplet"]; + 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"]; @@ -19694,22 +21228,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy: { + firewalls_delete: { 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: { - 204: components["responses"]["no_content_with_content_type"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19717,67 +21251,81 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_backups: { + firewalls_assign_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; - responses: { - 200: components["responses"]["all_droplet_backups"]; - 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_snapshots: { - 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"]; + 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: { + 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"]; + }; + }; + firewalls_delete_droplets: { + 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 { + * "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"]; @@ -19785,33 +21333,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"]["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"]; @@ -19819,30 +21368,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_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"]["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"]; @@ -19850,57 +21403,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`. - * @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"]; @@ -19908,7 +21507,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_kernels: { + floatingIPs_list: { parameters: { query?: { /** @@ -19923,52 +21522,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"]; @@ -19976,22 +21577,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"]; @@ -19999,22 +21600,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"]; @@ -20022,26 +21623,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"]; @@ -20049,28 +21653,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"]; @@ -20078,335 +21681,313 @@ 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: { - /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 - */ - droplet_id: components["parameters"]["droplet_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["create_namespace"]; + }; + }; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["namespace_created"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 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"]; }; }; - firewalls_list: { + functions_get_namespace: { 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 The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - page?: components["parameters"]["page"]; + namespace_id: components["parameters"]["namespace_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_firewalls_response"]; + 200: components["responses"]["namespace_created"]; 401: components["responses"]["unauthorized"]; + 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"]; }; }; - firewalls_create: { + functions_delete_namespace: { 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); + 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"]["create_firewall_response"]; - 400: components["responses"]["bad_request"]; + 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"]; }; }; - firewalls_get: { + functions_list_triggers: { 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 The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - firewall_id: components["parameters"]["firewall_id"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_firewall_response"]; + 200: components["responses"]["list_triggers"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - firewalls_update: { + functions_create_trigger: { 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 The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - firewall_id: components["parameters"]["firewall_id"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; - requestBody?: { + 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); + "application/json": components["schemas"]["create_trigger"]; + }; + }; + responses: { + 200: components["responses"]["trigger_response"]; + 400: components["responses"]["trigger_bad_request"]; + 401: components["responses"]["unauthorized"]; + 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"]; + }; + }; + functions_get_trigger: { + 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"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["put_firewall_response"]; - 400: components["responses"]["bad_request"]; + 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"]; }; }; - firewalls_delete: { + functions_update_trigger: { 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 The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - firewall_id: components["parameters"]["firewall_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?: never; + requestBody: { + content: { + "application/json": components["schemas"]["update_trigger"]; + }; + }; responses: { - 204: 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"]; }; }; - firewalls_assign_droplets: { + functions_delete_trigger: { 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 The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - firewall_id: components["parameters"]["firewall_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: { - /** @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[]; - }; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; - 400: components["responses"]["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"]; }; }; - firewalls_delete_droplets: { + images_list: { 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 Filters results based on image type which can be either `application` or `distribution`. + * @example distribution */ - firewall_id: components["parameters"]["firewall_id"]; + 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 + */ + 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_images"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + images_create_custom: { + 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 removed from the firewall. - * @example [ - * 49696269 - * ] - */ - droplet_ids: number[]; - }; + "application/json": components["schemas"]["image_new_custom"]; }; }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 202: components["responses"]["new_custom_image"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + images_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; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["existing_image"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20414,34 +21995,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_tags: { + images_update: { 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?: { + requestBody: { content: { - /** @example { - * "tags": [ - * "frontend" - * ] - * } */ - "application/json": { - tags: components["schemas"]["tags_array"] & unknown; - }; + "application/json": components["schemas"]["image_update"]; }; }; responses: { - 204: components["responses"]["no_content"]; - 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"]; @@ -20449,34 +22022,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_tags: { + 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?: { - content: { - /** @example { - * "tags": [ - * "frontend" - * ] - * } */ - "application/json": { - tags: components["schemas"]["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"]; @@ -20484,51 +22045,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_rules: { + 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 { - * "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: { + 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: { - 204: components["responses"]["no_content"]; - 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"]; @@ -20536,51 +22095,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_rules: { + 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?: { - 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"]["get_image_action_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20588,7 +22123,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_list: { + kubernetes_list_clusters: { parameters: { query?: { /** @@ -20608,14 +22143,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_list"]; + 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"]; }; }; - floatingIPs_create: { + kubernetes_create_cluster: { parameters: { query?: never; header?: never; @@ -20624,33 +22159,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["floating_ip_create"]; + "application/json": components["schemas"]["cluster"]; }; }; responses: { - 202: components["responses"]["floating_ip_created"]; + 201: components["responses"]["cluster_create"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_get: { + kubernetes_get_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; responses: { - 200: components["responses"]["floating_ip"]; + 200: components["responses"]["existing_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20658,16 +22193,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_delete: { + kubernetes_update_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: { + content: { + "application/json": components["schemas"]["cluster_update"]; + }; + }; + responses: { + 202: components["responses"]["updated_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"]; + }; + }; + kubernetes_delete_cluster: { + 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; }; @@ -20681,22 +22243,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_list: { + kubernetes_list_associatedResources: { 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"]["associated_kubernetes_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20704,29 +22266,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_post: { + kubernetes_destroy_associatedResourcesSelective: { 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"]; + "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; }; }; responses: { - 201: components["responses"]["floating_ip_action"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20734,27 +22293,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_get: { + kubernetes_destroy_associatedResourcesDangerous: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 - */ - floating_ip: components["parameters"]["floating_ip"]; - /** - * @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 cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - action_id: components["parameters"]["action_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_action"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20762,219 +22316,256 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - functions_list_namespaces: { + kubernetes_get_kubeconfig: { 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; + 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: { - 200: components["responses"]["list_namespaces"]; + 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"]; }; }; - functions_create_namespace: { + 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"]["create_namespace"]; + 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: { - 200: components["responses"]["namespace_created"]; + 200: components["responses"]["credentials"]; 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_get_availableUpgrades: { 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: { - 200: components["responses"]["namespace_created"]; + 200: components["responses"]["available_upgrades"]; 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_upgrade_cluster: { 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; + 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"]["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_nodePools: { 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: { - 200: components["responses"]["list_triggers"]; + 200: components["responses"]["all_node_pools"]; 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_add_nodePool: { 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: { content: { - "application/json": components["schemas"]["create_trigger"]; + /** @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: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 201: components["responses"]["node_pool_create"]; 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_get_nodePool: { 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 The name of the trigger to be managed. - * @example my trigger + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - trigger_name: components["parameters"]["trigger_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["trigger_response"]; + 200: components["responses"]["existing_node_pool"]; 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_update_nodePool: { 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 The name of the trigger to be managed. - * @example my trigger + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - trigger_name: components["parameters"]["trigger_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["update_trigger"]; + "application/json": components["schemas"]["kubernetes_node_pool_update"]; }; }; responses: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 202: components["responses"]["node_pool_update"]; 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_delete_trigger: { + kubernetes_delete_nodePool: { 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 The name of the trigger to be managed. - * @example my trigger + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - trigger_name: components["parameters"]["trigger_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; @@ -20982,93 +22573,86 @@ export interface operations { responses: { 204: components["responses"]["no_content"]; 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"]; }; }; - images_list: { + kubernetes_delete_node: { parameters: { query?: { /** - * @description Filters results based on image type which can be either `application` or `distribution`. - * @example distribution + * @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 */ - type?: components["parameters"]["type"]; + skip_drain?: components["parameters"]["kubernetes_node_skip_drain"]; /** - * @description Used to filter only user images. - * @example true + * @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 */ - private?: components["parameters"]["private"]; + replace?: components["parameters"]["kubernetes_node_replace"]; + }; + header?: never; + path: { /** - * @description Used to filter images by a specific tag. - * @example base-image + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - tag_name?: components["parameters"]["tag"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; /** - * @description Number of items returned per page - * @example 2 + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - per_page?: components["parameters"]["per_page"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique ID that can be used to reference a node in a Kubernetes node pool. + * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f */ - page?: components["parameters"]["page"]; + node_id: components["parameters"]["kubernetes_node_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_images"]; + 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"]; }; }; - images_create_custom: { + kubernetes_recycle_node_pool: { 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"]["image_new_custom"]; - }; - }; - responses: { - 202: components["responses"]["new_custom_image"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - images_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; + "application/json": { + /** @example [ + * "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" + * ] */ + nodes?: string[]; + }; }; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["existing_image"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21076,26 +22660,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_update: { + kubernetes_get_clusterUser: { 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 ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - image_id: components["parameters"]["image_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["image_update"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["updated_image"]; + 200: components["responses"]["cluster_user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21103,22 +22683,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_delete: { + kubernetes_list_options: { 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"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_options"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21126,22 +22700,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_list: { + 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 A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - image_id: components["parameters"]["image_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_image_actions_response"]; + 200: components["responses"]["clusterlint_results"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21149,26 +22729,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_post: { + kubernetes_run_clusterLint: { 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 ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - image_id: components["parameters"]["image_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["image_action_base"] | components["schemas"]["image_action_transfer"]; + "application/json": components["schemas"]["clusterlint_request"]; }; }; responses: { - 201: components["responses"]["post_image_action_response"]; + 202: components["responses"]["clusterlint_run"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21176,35 +22756,47 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_get: { + kubernetes_add_registry: { 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 - */ - action_id: components["parameters"]["action_id"]; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registries"]; }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + kubernetes_remove_registry: { + parameters: { + query?: never; + header?: never; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registries"]; + }; + }; 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"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_clusters: { + loadBalancers_list: { parameters: { query?: { /** @@ -21224,14 +22816,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_clusters"]; + 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"]; }; }; - kubernetes_create_cluster: { + loadBalancers_create: { parameters: { query?: never; header?: never; @@ -21240,33 +22832,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["cluster"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 201: components["responses"]["cluster_create"]; + 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"]; }; }; - kubernetes_get_cluster: { + loadBalancers_get: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_cluster"]; + 200: components["responses"]["existing_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21274,26 +22866,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_update_cluster: { + loadBalancers_update: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["cluster_update"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 202: components["responses"]["updated_cluster"]; + 200: components["responses"]["updated_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21301,16 +22893,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_cluster: { + loadBalancers_delete: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; @@ -21324,22 +22916,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_associatedResources: { + loadBalancers_add_droplets: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_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"]["associated_kubernetes_resources_list"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21347,22 +22952,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesSelective: { + loadBalancers_remove_droplets: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; + "application/json": { + /** + * @description An array containing the IDs of the Droplets assigned to the load balancer. + * @example [ + * 3164444, + * 3164445 + * ] + */ + droplet_ids: number[]; + }; }; }; responses: { @@ -21374,20 +22988,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesDangerous: { + loadBalancers_add_forwardingRules: { 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + forwarding_rules: components["schemas"]["forwarding_rule"][]; + }; + }; + }; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -21397,28 +23017,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_kubeconfig: { + loadBalancers_remove_forwardingRules: { parameters: { - 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"]; - }; + 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 a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_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"]["kubeconfig"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21426,51 +23046,102 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_credentials: { + monitoring_list_alertPolicy: { parameters: { 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 Number of items returned per page + * @example 2 */ - expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; - }; - header?: never; - path: { + per_page?: components["parameters"]["per_page"]; /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description Which 'page' of paginated results to return. + * @example 1 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["credentials"]; + 200: components["responses"]["list_alert_policy_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_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|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"]; + }; + }; + responses: { + 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"]; + }; + }; + 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"]["available_upgrades"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21478,32 +23149,59 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_upgrade_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|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": { - /** - * @description The slug identifier for the version of Kubernetes that the cluster will be upgraded to. - * @example 1.16.13-do.0 - */ - version?: string; - }; + "application/json": components["schemas"]["alert_policy_request"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21511,22 +23209,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_nodePools: { + 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 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + alert_uuid: components["parameters"]["alert_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_node_pools"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21534,362 +23232,428 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_add_nodePool: { + monitoring_get_dropletBandwidthMetrics: { 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 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: { - 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"]["droplet_bandwidth_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_DropletCpuMetrics: { 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 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: { - 200: components["responses"]["existing_node_pool"]; + 200: components["responses"]["droplet_cpu_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_dropletFilesystemFreeMetrics: { 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 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": components["schemas"]["kubernetes_node_pool_update"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["node_pool_update"]; + 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_delete_nodePool: { + 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 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"]["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_delete_node: { + monitoring_get_dropletLoad1Metrics: { 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: { + 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 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_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 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_dropletLoad15Metrics: { 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"]["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_dropletMemoryCachedMetrics: { parameters: { - query?: never; + 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"]["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_dropletMemoryFreeMetrics: { parameters: { - query?: { + query: { /** - * @description Specifies the clusterlint run whose results will be retrieved. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + * @description The droplet ID. + * @example 17209102 */ - run_id?: components["parameters"]["clusterlint_run_id"]; - }; - 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"]["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_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": 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_dropletMemoryAvailableMetrics: { parameters: { - query?: never; + 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?: { - 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_appMemoryPercentageMetrics: { parameters: { - query?: never; + 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"]; + }; 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"]["app_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_appCPUPercentageMetrics: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - per_page?: components["parameters"]["per_page"]; + app_id: components["parameters"]["parameters_app_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The app component name. + * @example sample-application */ - page?: components["parameters"]["page"]; + 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; @@ -21897,249 +23661,292 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_load_balancers"]; + 200: components["responses"]["app_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_appRestartCountMetrics.yml": { parameters: { - query?: never; + 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"]; + }; 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"]["app_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_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_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_cpu_utilization: { 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_frontend_firewall_dropped_bytes: { 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_frontend_firewall_dropped_packets: { 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_frontend_http_responses: { 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_frontend_http_requests_per_second: { 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_frontend_network_throughput_http: { 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; @@ -22147,190 +23954,181 @@ 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_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; }; - /** @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|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"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_alertPolicy: { + monitoring_get_lb_frontend_network_throughput_tcp: { 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_frontend_nlb_tcp_network_throughput: { 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|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_frontend_nlb_udp_network_throughput: { 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_frontend_tls_connections_current: { 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 The network interface. - * @example private + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - interface: components["parameters"]["network_interface"]; + start: components["parameters"]["metric_timestamp_start"]; /** - * @description The traffic direction. - * @example inbound + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - direction: components["parameters"]["network_direction"]; + 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_get_lb_frontend_tls_connections_limit: { + 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 @@ -22348,21 +24146,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_frontend_tls_connections_exceeding_rate_limit: { 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 @@ -22380,21 +24178,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_http_session_duration_avg: { 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 @@ -22412,21 +24210,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_lb_droplets_http_session_duration_50p: { 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 @@ -22444,21 +24242,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_lb_droplets_http_session_duration_95p: { 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 @@ -22483,14 +24281,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletLoad5Metrics: { + monitoring_get_lb_droplets_http_response_time_avg: { 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 @@ -22515,14 +24313,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletLoad15Metrics: { + monitoring_get_lb_droplets_http_response_time_50p: { 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 @@ -22547,14 +24345,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryCachedMetrics: { + monitoring_get_lb_droplets_http_response_time_95p: { 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 @@ -22579,14 +24377,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryFreeMetrics: { + monitoring_get_lb_droplets_http_response_time_99p: { 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 @@ -22611,14 +24409,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryTotalMetrics: { + monitoring_get_lb_droplets_queue_size: { 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 @@ -22643,14 +24441,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryAvailableMetrics: { + monitoring_get_lb_droplets_http_responses: { 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 @@ -22675,19 +24473,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_appMemoryPercentageMetrics: { + monitoring_get_lb_droplets_connections: { 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 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - app_component?: components["parameters"]["app_component"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -22705,26 +24498,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["app_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_appCPUPercentageMetrics: { + monitoring_get_lb_droplets_health_checks: { 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 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - app_component?: components["parameters"]["app_component"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -22742,26 +24530,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["app_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_appRestartCountMetrics.yml": { + monitoring_get_lb_droplets_downtime: { 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 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - app_component?: components["parameters"]["app_component"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -22779,7 +24562,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["app_metric_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; 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 55f73fc58..3b95f9380 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 @@ -570,14 +570,6 @@ paths: get: $ref: 'resources/apps/apps_get_logs_active_deployment_aggregate.yml' - /v2/apps/tiers: - get: - $ref: 'resources/apps/apps_list_tiers.yml' - - /v2/apps/tiers/{slug}: - get: - $ref: 'resources/apps/apps_get_tier.yml' - /v2/apps/tiers/instance_sizes: get: $ref: 'resources/apps/apps_list_instanceSizes.yml' @@ -743,6 +735,10 @@ paths: put: $ref: 'resources/databases/databases_update_maintenanceWindow.yml' + /v2/databases/{database_cluster_uuid}/install_update: + put: + $ref: 'resources/databases/databases_update_installUpdate.yml' + /v2/databases/{database_cluster_uuid}/backups: get: $ref: 'resources/databases/databases_list_backups.yml' @@ -861,7 +857,15 @@ paths: $ref: 'resources/databases/databases_get_cluster_metrics_credentials.yml' put: $ref: 'resources/databases/databases_update_cluster_metrics_credentials.yml' - + + /v2/databases/{database_cluster_uuid}/indexes: + get: + $ref: 'resources/databases/databases_list_opensearch_indexes.yml' + + /v2/databases/{database_cluster_uuid}/indexes/{index_name}: + delete: + $ref: 'resources/databases/databases_delete_opensearch_index.yml' + /v2/domains: get: $ref: 'resources/domains/domains_list.yml' @@ -911,6 +915,18 @@ paths: get: $ref: 'resources/droplets/droplets_list_backups.yml' + /v2/droplets/{droplet_id}/backups/policy: + get: + $ref: 'resources/droplets/droplets_get_backup_policy.yml' + + /v2/droplets/backups/policies: + get: + $ref: 'resources/droplets/droplets_list_backup_policies.yml' + + /v2/droplets/backups/supported_policies: + get: + $ref: 'resources/droplets/droplets_list_supported_backup_policies.yml' + /v2/droplets/{droplet_id}/snapshots: get: $ref: 'resources/droplets/droplets_list_snapshots.yml' @@ -1269,6 +1285,114 @@ paths: get: $ref: 'resources/monitoring/monitoring_get_appRestartCountMetrics.yml' + /v2/monitoring/metrics/load_balancer/frontend_connections_current: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_connections_current.yml' + + /v2/monitoring/metrics/load_balancer/frontend_connections_limit: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml' + + /v2/monitoring/metrics/load_balancer/frontend_cpu_utilization: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml' + + /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml' + + /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml' + + /v2/monitoring/metrics/load_balancer/frontend_http_responses: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_http_responses.yml' + + /v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml' + + /v2/monitoring/metrics/load_balancer/frontend_network_throughput_http: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml' + + /v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml' + + /v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml' + + /v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml' + + /v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml' + + /v2/monitoring/metrics/load_balancer/frontend_tls_connections_current: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml' + + /v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml' + + /v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit: + get: + $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml' + + /v2/monitoring/metrics/load_balancer/droplets_queue_size: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_queue_size.yml' + + /v2/monitoring/metrics/load_balancer/droplets_http_responses: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_responses.yml' + + /v2/monitoring/metrics/load_balancer/droplets_connections: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_connections.yml' + + /v2/monitoring/metrics/load_balancer/droplets_health_checks: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_health_checks.yml' + + /v2/monitoring/metrics/load_balancer/droplets_downtime: + get: + $ref: 'resources/monitoring/monitoring_get_lb_droplets_downtime.yml' + /v2/projects: get: $ref: 'resources/projects/projects_list.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml index ef805f13e..ab973c885 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml @@ -59,4 +59,7 @@ properties: example: node-js log_destinations: - $ref: app_log_destination_definition.yml + type: array + items: + $ref: app_log_destination_definition.yml + description: A list of configured log forwarding destinations. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml index 3f31a28dc..fbb61695c 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml @@ -50,7 +50,10 @@ properties: $ref: apps_gitlab_source_spec.yml log_destinations: - $ref: app_log_destination_definition.yml + type: array + items: + $ref: app_log_destination_definition.yml + description: A list of configured log forwarding destinations. required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_update_app_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_update_app_request.yml index f80151c6a..8d655a0ed 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_update_app_request.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_update_app_request.yml @@ -2,5 +2,10 @@ type: object properties: spec: $ref: app_spec.yml + update_all_source_versions: + type: boolean + description: Whether or not to update the source versions (for example fetching a new commit or image digest) of all components. By default (when this is false) only newly added sources will be updated to avoid changes like updating the scale of a component from also updating the respective code. + example: true + default: false required: - spec diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_opensearch_index.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_opensearch_index.yml new file mode 100644 index 000000000..974d1338f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_opensearch_index.yml @@ -0,0 +1,44 @@ +operationId: databases_delete_opensearch_index + +summary: Delete Index for OpenSearch Cluster + +description: | + To delete a single index within OpenSearch cluster, send a DELETE request + to `/v2/databases/$DATABASE_ID/indexes/$INDEX_NAME`. + + A status of 204 will be given. This indicates that the request was + processed successfully, but that no response body is needed. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + - $ref: 'parameters.yml#/opensearch_index_name' + +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/databases_delete_opensearch_index.yml' + - $ref: 'examples/go/databases_delete_opensearch_index.yml' + +security: + - bearer_auth: + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_opensearch_indexes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_opensearch_indexes.yml new file mode 100644 index 000000000..8f3100d49 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_opensearch_indexes.yml @@ -0,0 +1,42 @@ +operationId: databases_list_opeasearch_indexes + +summary: List Indexes for a OpenSearch Cluster + +description: | + To list all of a OpenSearch cluster's indexes, send a GET request to + `/v2/databases/$DATABASE_ID/indexes`. + + The result will be a JSON object with a `indexes` key. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +responses: + '200': + $ref: 'responses/opensearch_indexes.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/databases_list_opensearch_indexes.yml' + - $ref: 'examples/go/databases_list_opensearch_indexes.yml' + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_installUpdate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_installUpdate.yml new file mode 100644 index 000000000..8345f9c5d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_installUpdate.yml @@ -0,0 +1,45 @@ +operationId: databases_install_update + +summary: Start Database Maintenance + +description: >- + To start the installation of updates for a + database cluster, send a PUT request to + `/v2/databases/$DATABASE_ID/install_update`. + + A successful request will receive a 204 No Content status code with no body + in response. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +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/databases_update_installUpdate.yml' + - $ref: 'examples/go/databases_update_installUpdate.yml' + - $ref: 'examples/python/databases_update_installUpdate.yml' + +security: + - bearer_auth: + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_opensearch_index.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_opensearch_index.yml new file mode 100644 index 000000000..afc09f8a4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_delete_opensearch_index.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/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/indexes/sample-index" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_opensearch_indexes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_opensearch_indexes.yml new file mode 100644 index 000000000..9e217ccb8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_opensearch_indexes.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/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/indexes" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_installUpdate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_installUpdate.yml new file mode 100644 index 000000000..2777446fb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_installUpdate.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/install_update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_opensearch_index.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_opensearch_index.yml new file mode 100644 index 000000000..89fc39b8b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_opensearch_index.yml @@ -0,0 +1,19 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + indexName := "sampe-index" + + _, err := client.Databases.DeleteIndex(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", indexName) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_opensearch_indexes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_opensearch_indexes.yml new file mode 100644 index 000000000..759df5d0b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_opensearch_indexes.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() + + replicas, _, err := client.Databases.ListIndexes(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", nil) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_installUpdate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_installUpdate.yml new file mode 100644 index 000000000..451c21eb0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_installUpdate.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.Databases.InstallUpdate(ctx, "88055188-9e54-4f21-ab11-8a918ed79ee2") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_installUpdate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_installUpdate.yml new file mode 100644 index 000000000..2105a1120 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_installUpdate.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + update_resp = client.databases.install_update(database_cluster_uuid="a7a8bas") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml index 1f495b803..3eba6f8a2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml @@ -5,7 +5,7 @@ properties: type: string description: >- This is provided as a convenience and should be able to be constructed by the other attributes. - example: opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + example: https://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060 readOnly: true host: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index.yml new file mode 100644 index 000000000..3e6111dcb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index.yml @@ -0,0 +1,25 @@ +type: object + +allOf: +- $ref: './opensearch_index_base.yml' +- properties: + status: + type: string + enum: + - unknown + - open + - close + - none + example: open + description: The status of the OpenSearch index. + + health: + type: string + enum: + - unknown + - green + - yellow + - red + - red* + example: green + description: The health of the OpenSearch index. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index_base.yml new file mode 100644 index 000000000..451fc10f0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_index_base.yml @@ -0,0 +1,28 @@ +type: object + +properties: + index_name: + type: string + description: The name of the opensearch index. + example: events + + number_of_shards: + type: integer + example: 2 + description: The number of shards for the index. + + number_of_replicas: + type: integer + example: 3 + description: The number of replicas for the index. + + size: + type: integer + example: 208 + description: The size of the index. + + created_time: + type: string + format: date-time + example: "2021-01-01T00:00:00Z" + description: The date and time the index was created. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml index 6b8e33004..756eaffa5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml @@ -2,11 +2,39 @@ type: object properties: pg_allow_replication: - type: boolean - example: true - description: | - For Postgres clusters, set to `true` for a user with replication rights. - This option is not currently supported for other database engines. + type: boolean + example: true + description: | + For Postgres clusters, set to `true` for a user with replication rights. + This option is not currently supported for other database engines. + opensearch_acl: + type: array + items: + type: object + properties: + index: + type: string + example: index-abc.* + description: A regex for matching the indexes that this ACL should apply to. + permission: + type: string + enum: + - deny + - admin + - read + - readwrite + - write + example: read + description: >- + Permission set applied to the ACL. 'read' allows user to + read from the index. 'write' allows for user to write + to the index. 'readwrite' allows for both 'read' and + 'write' permission. 'deny'(default) restricts user from performing + any operation over an index. 'admin' allows for 'readwrite' as + well as any operations to administer the index. + description: >- + ACLs (Access Control Lists) specifying permissions on index within a + OpenSearch cluster. acl: type: array items: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml index f0ffe5ada..0847980c7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml @@ -71,6 +71,15 @@ kafka_topic_name: schema: type: string +opensearch_index_name: + in: path + name: index_name + description: The name of the OpenSearch index. + required: true + example: logs-* + schema: + type: string + logsink_id: in: path name: logsink_id @@ -78,4 +87,4 @@ logsink_id: required: true example: 50484ec3-19d6-4cd3-b56f-3b0381c289a6 schema: - type: string \ No newline at end of file + type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml index c598f90e2..e249bea69 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml @@ -11,39 +11,44 @@ headers: content: application/json: schema: - allOf: - - $ref: "../models/logsink_verbose.yml" - required: - - sink_id - - sink_name - - sink_type - - config + properties: + sink: + allOf: + - $ref: "../models/logsink_verbose.yml" + required: + - sink_id + - sink_name + - sink_type + - config examples: Create an opensearch logsink: value: - sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" - sink_name: "logs-sink" - sink_type: "opensearch" - config: - url: https://user:passwd@192.168.0.1:25060 - index_prefix: "opensearch-logs" - index_days_max: 5 + sink: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "opensearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "opensearch-logs" + index_days_max: 5 Create an elasticsearch logsink: value: - sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" - sink_name: "logs-sink" - sink_type: "elasticsearch" - config: - url: https://user:passwd@192.168.0.1:25060 - index_prefix: "elasticsearch-logs" - index_days_max: 5 + sink: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "elasticsearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "elasticsearch-logs" + index_days_max: 5 Create a rsyslog logsink: value: - sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" - sink_name: logs-sink - sink_type: rsyslog - config: - server: 192.168.0.1 - port: 514 - tls: false - format: rfc5424 \ No newline at end of file + sink: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: logs-sink + sink_type: rsyslog + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/opensearch_indexes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/opensearch_indexes.yml new file mode 100644 index 000000000..cc7606e0a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/opensearch_indexes.yml @@ -0,0 +1,35 @@ +description: A JSON object with a key of `indexes`. + +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" + +content: + application/json: + schema: + properties: + indexes: + type: array + items: + $ref: "../models/opensearch_index.yml" + + example: + indexes: + - index_name: sample-data + number_of_shards: 2 + number_of_replicas: 3 + size: 208 + created_time: "2021-01-01T00:00:00Z" + status: open + health: green + - index_name: logs-* + number_of_shards: 2 + number_of_replicas: 3 + size: 208 + created_time: "2021-01-01T00:00:00Z" + status: open + health: green diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml index 1f085ebcc..c150ce23c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml @@ -11,6 +11,7 @@ description: | | ---------------------------------------- | ----------- | | `enable_backups` | Enables backups for a Droplet | | `disable_backups` | Disables backups for a Droplet | + | `change_backup_policy` | Update the backup policy for a Droplet | | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | @@ -42,6 +43,8 @@ requestBody: schema: anyOf: - $ref: 'models/droplet_actions.yml#/droplet_action' + - $ref: 'models/droplet_actions.yml#/droplet_action_enable_backups' + - $ref: 'models/droplet_actions.yml#/droplet_action_change_backup_policy' - $ref: 'models/droplet_actions.yml#/droplet_action_restore' - $ref: 'models/droplet_actions.yml#/droplet_action_resize' - $ref: 'models/droplet_actions.yml#/droplet_action_rebuild' @@ -51,8 +54,9 @@ requestBody: discriminator: propertyName: type mapping: - enable_backups: 'models/droplet_actions.yml#/droplet_action' + enable_backups: 'models/droplet_actions.yml#/droplet_action_enable_backups' disable_backups: 'models/droplet_actions.yml#/droplet_action' + change_backup_policy: 'models/droplet_actions.yml#/droplet_action_change_backup_policy' reboot: 'models/droplet_actions.yml#/droplet_action' power_cycle: 'models/droplet_actions.yml#/droplet_action' shutdown: 'models/droplet_actions.yml#/droplet_action' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml new file mode 100644 index 000000000..2cff6149a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml @@ -0,0 +1,39 @@ +operationId: droplets_get_backup_policy + +summary: Retrieve the Backup Policy for an Existing Droplet + +description: | + To show information about an individual Droplet's backup policy, send a GET + request to `/v2/droplets/$DROPLET_ID/backups/policy`. + +tags: + - Droplets + +parameters: + - $ref: 'parameters.yml#/droplet_id' + +responses: + '200': + $ref: 'responses/droplet_backup_policy.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/droplets_get_backup_policy.yml' + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml new file mode 100644 index 000000000..c0f013635 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml @@ -0,0 +1,40 @@ +operationId: droplets_list_backup_policies + +summary: List Backup Policies for All Existing Droplets + +description: | + To list information about the backup policies for all Droplets in the account, + send a GET request to `/v2/droplets/backups/policies`. + +tags: + - Droplets + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/all_droplet_backup_policies.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/droplets_list_backup_policies.yml' + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml new file mode 100644 index 000000000..f6974eaf4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml @@ -0,0 +1,36 @@ +operationId: droplets_list_supported_backup_policies + +summary: List Supported Droplet Backup Policies + +description: | + To retrieve a list of all supported Droplet backup policies, send a GET + request to `/v2/droplets/backups/supported_policies`. + +tags: + - Droplets + +responses: + '200': + $ref: 'responses/droplets_supported_backup_policies.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/droplets_list_supported_backup_policies.yml' + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_get_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_get_backup_policy.yml new file mode 100644 index 000000000..bcc387808 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_get_backup_policy.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/3164494/backups/policy" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_backup_policies.yml new file mode 100644 index 000000000..c5936fc79 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_backup_policies.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/backups/policies" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_supported_backup_policies.yml new file mode 100644 index 000000000..2978a1936 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/curl/droplets_list_supported_backup_policies.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/backups/supported_policies" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml index 77e04c36f..778e0acf2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet.yml @@ -76,24 +76,11 @@ properties: instance creation. next_backup_window: - type: object - description: The details of the Droplet's backups feature, if backups are - configured for the Droplet. This object contains keys for the start and - end times of the window during which the backup will start. - nullable: true - properties: - start: - type: string - format: date-time - example: '2019-12-04T00:00:00Z' - description: A time value given in ISO8601 combined date and time format - specifying the start of the Droplet's backup window. - end: - type: string - format: date-time - example: '2019-12-04T23:00:00Z' - description: A time value given in ISO8601 combined date and time format - specifying the end of the Droplet's backup window. + allOf: + - $ref: 'droplet_next_backup_window.yml' + - description: The details of the Droplet's backups feature, if backups are + configured for the Droplet. This object contains keys for the start and + end times of the window during which the backup will start. snapshot_ids: type: array diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml index 8acc39ad2..19e895d19 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_actions.yml @@ -25,6 +25,42 @@ droplet_action: example: reboot description: The type of action to initiate for the Droplet. +droplet_action_enable_backups: + allOf: + - $ref: '#/droplet_action' + - type: object + properties: + backup_policy: + allOf: + - $ref: 'droplet_backup_policy.yml' + - description: An object specifying the backup policy for the Droplet. If + omitted, the default backup policy will be used. + + example: + type: enable_backups + backup_policy: + plan: daily + hour: 20 + +droplet_action_change_backup_policy: + allOf: + - $ref: '#/droplet_action' + - type: object + properties: + backup_policy: + allOf: + - $ref: 'droplet_backup_policy.yml' + - description: An object specifying the backup policy for the Droplet. + required: + - backup_policy + + example: + type: enable_backups + backup_policy: + plan: weekly + day: SUN + hour: 20 + droplet_action_restore: allOf: - $ref: '#/droplet_action' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy.yml new file mode 100644 index 000000000..9078d776b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy.yml @@ -0,0 +1,48 @@ +type: object + +properties: + plan: + type: string + enum: + - daily + - weekly + example: daily + description: The backup plan used for the Droplet. The plan can be either + `daily` or `weekly`. + + weekday: + type: string + enum: + - SUN + - MON + - TUE + - WED + - THU + - FRI + - SAT + example: SUN + description: The day of the week on which the backup will occur. + + hour: + type: integer + enum: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + example: 0 + description: The hour of the day that the backup window will start. + + window_length_hours: + type: integer + readOnly: true + example: 4 + description: The length of the backup window starting from `hour`. + + retention_period_days: + type: integer + readOnly: true + example: 7 + description: The number of days the backup will be retained. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy_record.yml new file mode 100644 index 000000000..a8188130f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_backup_policy_record.yml @@ -0,0 +1,24 @@ +type: object + +properties: + droplet_id: + type: integer + example: 7101383 + description: The unique identifier for the Droplet. + + backup_enabled: + type: boolean + example: true + description: A boolean value indicating whether backups are enabled for the + Droplet. + + backup_policy: + allOf: + - $ref: 'droplet_backup_policy.yml' + - description: An object specifying the backup policy for the Droplet. + + next_backup_window: + allOf: + - $ref: 'droplet_next_backup_window.yml' + - description: An object containing keys with the start and end times of the + window during which the backup will occur. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml index 0a6d7ff8e..637217044 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_create.yml @@ -45,6 +45,12 @@ properties: description: A boolean indicating whether automated backups should be enabled for the Droplet. + backup_policy: + allOf: + - $ref: 'droplet_backup_policy.yml' + - description: An object specifying the backup policy for the Droplet. If + omitted and `backups` is `true`, the default backup policy will be used. + ipv6: type: boolean example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_next_backup_window.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_next_backup_window.yml new file mode 100644 index 000000000..dda61ca28 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_next_backup_window.yml @@ -0,0 +1,15 @@ +type: object +nullable: true +properties: + start: + type: string + format: date-time + example: '2019-12-04T00:00:00Z' + description: A time value given in ISO8601 combined date and time format + specifying the start of the Droplet's backup window. + end: + type: string + format: date-time + example: '2019-12-04T23:00:00Z' + description: A time value given in ISO8601 combined date and time format + specifying the end of the Droplet's backup window. \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/supported_droplet_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/supported_droplet_backup_policy.yml new file mode 100644 index 000000000..cce53985e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/supported_droplet_backup_policy.yml @@ -0,0 +1,39 @@ +type: object + +properties: + name: + type: string + example: daily + description: The name of the Droplet backup plan. + + possible_window_starts: + type: array + items: + type: integer + description: | + An array of integers representing the hours of the day that a backup can + start. + example: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + + window_length_hours: + type: integer + example: 4 + description: The number of hours that a backup window is open. + + retention_period_days: + type: integer + example: 7 + description: The number of days that a backup will be kept. + + possible_days: + type: array + items: + type: string + example: ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"] + description: The day of the week the backup will occur. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml new file mode 100644 index 000000000..aad1f25d1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml @@ -0,0 +1,58 @@ +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. + +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' + +content: + application/json: + schema: + allOf: + - type: object + properties: + policies: + description: | + A map where the keys are the Droplet IDs and the values are + objects containing the backup policy information for each Droplet. + additionalProperties: + $ref: '../models/droplet_backup_policy_record.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + + example: + policies: + "436444618": + droplet_id: 436444618 + backup_enabled: false + "444909314": + droplet_id: 444909314 + backup_enabled: true + backup_policy: + plan: daily + hour: 20 + window_length_hours: 4 + retention_period_days: 7 + next_backup_window: + start: "2024-09-13T20:00:00Z" + end: "2024-09-14T00:00:00Z" + "444909706": + droplet_id: 444909706 + backup_enabled: true + backup_policy: + plan: weekly + weekday: SUN + hour: 20 + window_length_hours: 4 + retention_period_days: 28 + next_backup_window: + start: "2024-09-15T20:00:00Z" + end: "2024-09-16T00:00:00Z" + links: {} + meta: + total: 3 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplet_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplet_backup_policy.yml new file mode 100644 index 000000000..0fc161ec1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplet_backup_policy.yml @@ -0,0 +1,32 @@ +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. + +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' + +content: + application/json: + schema: + properties: + policy: + $ref: '../models/droplet_backup_policy_record.yml' + + example: + policy: + droplet_id: 444909706 + backup_enabled: true + backup_policy: + plan: "weekly" + weekday: "SUN" + hour: 20 + window_length_hours: 4 + retention_period_days: 28 + next_backup_window: + start: "2024-09-15T20:00:00Z" + end: "2024-09-16T00:00:00Z" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml new file mode 100644 index 000000000..6ae6be4b7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml @@ -0,0 +1,53 @@ +description: A JSON object with an `supported_policies` key set to an array + of objects describing each supported backup policy. + + +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' + +content: + application/json: + schema: + type: object + properties: + supported_policies: + type: array + items: + $ref: '../models/supported_droplet_backup_policy.yml' + + example: + supported_policies: + - name: "weekly" + possible_window_starts: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + window_length_hours: 4 + retention_period_days: 28 + possible_days": + - "SUN" + - "MON" + - "TUE" + - "WED" + - "THU" + - "FRI" + - "SAT" + - name: "daily" + possible_window_starts: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + window_length_hours: 4 + retention_period_days: 7 + possible_days: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_get.yml index ef075b085..d19423f66 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_get.yml @@ -5,4 +5,4 @@ source: |- client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) - resp = client.image_actions.get(image_id="fd9391a") + resp = client.image_actions.get(action_id=36805527, image_id=7938269) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_list.yml index bca3325d4..b207504eb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/examples/python/imageActions_list.yml @@ -5,4 +5,4 @@ source: |- client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) - resp = client.image_actions.list() + resp = client.image_actions.list(image_id=7938269) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_connections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_connections.yml new file mode 100644 index 000000000..edd2a7527 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_connections.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/load_balancer/droplets_connections?lb_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_lb_droplets_downtime.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_downtime.yml new file mode 100644 index 000000000..728076f3a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_downtime.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/load_balancer/droplets_downtime?lb_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_lb_droplets_health_checks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_health_checks.yml new file mode 100644 index 000000000..1e3830029 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_health_checks.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/load_balancer/droplets_health_checks?lb_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_lb_droplets_http_response_time_50p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_50p.yml new file mode 100644 index 000000000..f771cd7a6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_50p.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/load_balancer/droplets_http_response_time_50p?lb_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_lb_droplets_http_response_time_95p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_95p.yml new file mode 100644 index 000000000..208b3244a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_95p.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/load_balancer/droplets_http_response_time_95p?lb_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_lb_droplets_http_response_time_99p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_99p.yml new file mode 100644 index 000000000..a68393e2d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_99p.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/load_balancer/droplets_http_response_time_99p?lb_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_lb_droplets_http_response_time_avg.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_avg.yml new file mode 100644 index 000000000..782de6aed --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_response_time_avg.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/load_balancer/droplets_http_response_time_avg?lb_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_lb_droplets_http_responses.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_responses.yml new file mode 100644 index 000000000..8e6e928cb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_responses.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/load_balancer/droplets_http_responses?lb_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_lb_droplets_http_session_duration_50p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_50p.yml new file mode 100644 index 000000000..149f58d42 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_50p.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/load_balancer/droplets_http_session_duration_50p?lb_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_lb_droplets_http_session_duration_95p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_95p.yml new file mode 100644 index 000000000..215c6b034 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_95p.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/load_balancer/droplets_http_session_duration_95p?lb_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_lb_droplets_http_session_duration_avg.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_avg.yml new file mode 100644 index 000000000..cdcfc5433 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_http_session_duration_avg.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/load_balancer/droplets_http_session_duration_avg?lb_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_lb_droplets_queue_size.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_queue_size.yml new file mode 100644 index 000000000..29354159b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_droplets_queue_size.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/load_balancer/droplets_queue_size?lb_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_lb_frontend_connections_current.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_connections_current.yml new file mode 100644 index 000000000..b3824a972 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_connections_current.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/load_balancer/frontend_connections_current?lb_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_lb_frontend_connections_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_connections_limit.yml new file mode 100644 index 000000000..5d40d922b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_connections_limit.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/load_balancer/frontend_connections_limit?lb_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_lb_frontend_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_cpu_utilization.yml new file mode 100644 index 000000000..bf5a77b33 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_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/load_balancer/frontend_cpu_utilization?lb_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_lb_frontend_firewall_dropped_bytes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_firewall_dropped_bytes.yml new file mode 100644 index 000000000..c969e01d9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_firewall_dropped_bytes.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/load_balancer/frontend_firewall_dropped_bytes?lb_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_lb_frontend_firewall_dropped_packets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_firewall_dropped_packets.yml new file mode 100644 index 000000000..09d98a3bf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_firewall_dropped_packets.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/load_balancer/frontend_firewall_dropped_packets?lb_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_lb_frontend_http_requests_per_second.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_http_requests_per_second.yml new file mode 100644 index 000000000..409e03978 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_http_requests_per_second.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/load_balancer/frontend_http_requests_per_second?lb_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_lb_frontend_http_responses.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_http_responses.yml new file mode 100644 index 000000000..90e8f8849 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_http_responses.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/load_balancer/frontend_http_responses?lb_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_lb_frontend_network_throughput_http.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_http.yml new file mode 100644 index 000000000..68b0f5456 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_http.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/load_balancer/frontend_network_throughput_http?lb_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_lb_frontend_network_throughput_tcp.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_tcp.yml new file mode 100644 index 000000000..ded4a6499 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_tcp.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/load_balancer/frontend_network_throughput_tcp?lb_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_lb_frontend_network_throughput_udp.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_udp.yml new file mode 100644 index 000000000..b1afbd245 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_network_throughput_udp.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/load_balancer/frontend_network_throughput_udp?lb_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_lb_frontend_nlb_tcp_network_throughput.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml new file mode 100644 index 000000000..d121b18a1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_nlb_tcp_network_throughput.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/load_balancer/frontend_nlb_tcp_network_throughput?lb_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_lb_frontend_nlb_udp_network_throughput.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml new file mode 100644 index 000000000..cb78e1e4f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_nlb_udp_network_throughput.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/load_balancer/frontend_nlb_udp_network_throughput?lb_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_lb_frontend_tls_connections_current.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_current.yml new file mode 100644 index 000000000..78f687f99 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_current.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/load_balancer/frontend_tls_connections_current?lb_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_lb_frontend_tls_connections_exceeding_rate_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml new file mode 100644 index 000000000..451a3307f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.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/load_balancer/frontend_tls_connections_exceeding_rate_limit?lb_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_lb_frontend_tls_connections_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_limit.yml new file mode 100644 index 000000000..592672d0c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_lb_frontend_tls_connections_limit.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/load_balancer/frontend_tls_connections_limit?lb_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/metrics_result.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/metrics_result.yml index 20e19e9bb..a3a67456f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/metrics_result.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/metrics_result.yml @@ -6,13 +6,17 @@ properties: metric: type: object description: >- - An object containing the metric labels. + An object containing the metric's labels. These labels are key/value pairs + that vary depending on the metric being queried. For example, load balancer + metrics contain a `lb_id` label, while Droplet metrics contain a `host_id` + label, and App Platform metrics contain a `app_component` label. additionalProperties: type: string example: host_id: "19201920" values: type: array + description: An array of values for the metric. example: - - 1435781430 - "1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_connections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_connections.yml new file mode 100644 index 000000000..bfb809dc6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_connections.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_connections + +summary: Get Load Balancer Droplets Active Connections Metrics + +description: >- + To retrieve Droplets active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_connections`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_connections.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_downtime.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_downtime.yml new file mode 100644 index 000000000..627f05f38 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_downtime.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_downtime + +summary: Get Load Balancer Droplets Downtime Status Metrics + +description: >- + To retrieve Droplets downtime status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_downtime`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_downtime.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_health_checks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_health_checks.yml new file mode 100644 index 000000000..d8d57ac1b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_health_checks.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_health_checks + +summary: Get Load Balancer Droplets Health Check Status Metrics + +description: >- + To retrieve Droplets health check status for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_health_checks`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_health_checks.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml new file mode 100644 index 000000000..1bf147ba7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_response_time_50p + +summary: Get Load Balancer Droplets 50th Percentile HTTP Response Time Metrics + +description: >- + To retrieve Droplets 50th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_response_time_50p.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml new file mode 100644 index 000000000..fc8e807dc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_response_time_95p + +summary: Get Load Balancer Droplets 95th Percentile HTTP Response Time Metrics + +description: >- + To retrieve Droplets 95th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_response_time_95p.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml new file mode 100644 index 000000000..7b00505d6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_response_time_99p + +summary: Get Load Balancer Droplets 99th Percentile HTTP Response Time Metrics + +description: >- + To retrieve Droplets 99th percentile HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_response_time_99p.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml new file mode 100644 index 000000000..17950cb55 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_response_time_avg + +summary: Get Load Balancer Droplets Average HTTP Response Time Metrics + +description: >- + To retrieve Droplets average HTTP response time in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_response_time_avg.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_responses.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_responses.yml new file mode 100644 index 000000000..558f6db8c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_responses.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_responses + +summary: Get Load Balancer Droplets HTTP Rate Of Response Code Metrics + +description: >- + To retrieve Droplets HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_responses`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_responses.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml new file mode 100644 index 000000000..da40f463a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_session_duration_50p + +summary: Get Load Balancer Droplets 50th Percentile HTTP Session Duration Metrics + +description: >- + To retrieve Droplets 50th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_session_duration_50p.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml new file mode 100644 index 000000000..2872dd86f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_session_duration_95p + +summary: Get Load Balancer Droplets 95th Percentile HTTP Session Duration Metrics + +description: >- + To retrieve Droplets 95th percentile HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_session_duration_95p.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml new file mode 100644 index 000000000..836face96 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_http_session_duration_avg + +summary: Get Load Balancer Droplets Average HTTP Session Duration Metrics + +description: >- + To retrieve Droplets average HTTP session duration in seconds for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_http_session_duration_avg.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_queue_size.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_queue_size.yml new file mode 100644 index 000000000..39c28ef5f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_droplets_queue_size.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_droplets_queue_size + +summary: Get Load Balancer Droplets Queue Size Metrics + +description: >- + To retrieve Droplets queue size for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/droplets_queue_size`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_droplets_queue_size.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_current.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_current.yml new file mode 100644 index 000000000..5b3120b33 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_current.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_connections_current + +summary: Get Load Balancer Frontend Total Current Active Connections Metrics + +description: >- + To retrieve frontend total current active connections for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_current`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_connections_current.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml new file mode 100644 index 000000000..30ba2d399 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_connections_limit + +summary: Get Load Balancer Frontend Max Connections Limit Metrics + +description: >- + To retrieve frontend max connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_connections_limit`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_connections_limit.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml new file mode 100644 index 000000000..607078c81 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_cpu_utilization + +summary: Get Load Balancer Frontend Average Percentage CPU Utilization Metrics + +description: >- + To retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_cpu_utilization.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml new file mode 100644 index 000000000..3460be5b3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_firewall_dropped_bytes + +summary: Get Load Balancer Frontend Firewall Dropped Bytes Metrics + +description: >- + To retrieve firewall dropped bytes for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes`. This is currently only supported for network load balancers. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_firewall_dropped_bytes.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml new file mode 100644 index 000000000..381ee5415 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_firewall_dropped_packets + +summary: Get Load Balancer Frontend Firewall Dropped Packets Metrics + +description: >- + To retrieve firewall dropped packets per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets`. This is currently only supported for network load balancers. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_firewall_dropped_packets.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml new file mode 100644 index 000000000..2e2b21a3e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_http_requests_per_second + +summary: Get Load Balancer Frontend HTTP Requests Metrics + +description: >- + To retrieve frontend HTTP requests per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_http_requests_per_second.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_responses.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_responses.yml new file mode 100644 index 000000000..0171a0add --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_http_responses.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_http_responses + +summary: Get Load Balancer Frontend HTTP Rate Of Response Code Metrics + +description: >- + To retrieve frontend HTTP rate of response code for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_http_responses`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_http_responses.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml new file mode 100644 index 000000000..28fd1a4d9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_network_throughput_http + +summary: Get Load Balancer Frontend HTTP Throughput Metrics + +description: >- + To retrieve frontend HTTP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_http`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_network_throughput_http.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml new file mode 100644 index 000000000..6925c876c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_network_throughput_tcp + +summary: Get Load Balancer Frontend TCP Throughput Metrics + +description: >- + To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_network_throughput_tcp.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml new file mode 100644 index 000000000..2e958e6ae --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_network_throughput_udp + +summary: Get Load Balancer Frontend UDP Throughput Metrics + +description: >- + To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_network_throughput_udp.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml new file mode 100644 index 000000000..266f0b5b2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_nlb_tcp_network_throughput + +summary: Get Network Load Balancer Frontend TCP Throughput Metrics + +description: >- + To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml new file mode 100644 index 000000000..02788556e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_nlb_udp_network_throughput + +summary: Get Network Load Balancer Frontend UDP Throughput Metrics + +description: >- + To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml new file mode 100644 index 000000000..0023511ad --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_tls_connections_current + +summary: Get Load Balancer Frontend Current TLS Connections Rate Metrics + +description: >- + To retrieve frontend current TLS connections rate for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_current`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_tls_connections_current.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml new file mode 100644 index 000000000..6e9d7643f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit + +summary: Get Load Balancer Frontend Closed TLS Connections For Exceeded Rate Limit Metrics + +description: >- + To retrieve frontend closed TLS connections for exceeded rate limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml new file mode 100644 index 000000000..21c362fa9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml @@ -0,0 +1,37 @@ +operationId: monitoring_get_lb_frontend_tls_connections_limit + +summary: Get Load Balancer Frontend Max TLS Connections Limit Metrics + +description: >- + To retrieve frontend max TLS connections limit for a given load balancer, send a GET request to `/v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit`. + +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#/load_balancer_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_lb_frontend_tls_connections_limit.yml' + +security: + - bearer_auth: + - 'monitoring:read' 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 6c5599e1b..4cba95de1 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 @@ -16,6 +16,15 @@ app_id: schema: type: string +load_balancer_id: + in: query + name: lb_id + description: A unique identifier for a load balancer. + required: true + schema: + type: string + example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 + app_component: in: query name: app_component diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml index ee2774fd8..f3733d880 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml @@ -16,7 +16,7 @@ description: | | droplet_id | Set to the Droplet's ID | | region | Set to the slug representing the region where the volume is located | - Each volume may only be attached to a single Droplet. However, up to five + Each volume may only be attached to a single Droplet. However, up to fifteen volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml index f3b1a7094..084c5b255 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml @@ -15,7 +15,7 @@ description: | | droplet_id | Set to the Droplet's ID | | region | Set to the slug representing the region where the volume is located | - Each volume may only be attached to a single Droplet. However, up to seven + Each volume may only be attached to a single Droplet. However, up to fifteen volumes may be attached to a Droplet at a time. Pre-formatted volumes will be automatically mounted to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018 when attached. On older Droplets, 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 5e4c1668d..e0a3b0a55 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -649,7 +649,7 @@ export type paths = { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-enterprise-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/events": { readonly parameters: { readonly query?: never; @@ -3037,7 +3073,7 @@ export type paths = { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export type paths = { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ readonly get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + readonly get: operations["copilot/usage-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/teams": { readonly parameters: { readonly query?: never; @@ -5620,7 +5695,7 @@ export type paths = { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; readonly delete?: never; @@ -7418,9 +7493,9 @@ export type paths = { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ readonly post: operations["repos/create-attestation"]; readonly delete?: never; @@ -8619,6 +8694,30 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/code-security-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configuration-for-repository"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/codeowners/errors": { readonly parameters: { readonly query?: never; @@ -13282,6 +13381,9 @@ export type paths = { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ readonly get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly post: operations["secret-scanning/create-push-protection-bypass"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/security-advisories": { readonly parameters: { readonly query?: never; @@ -17305,6 +17431,20 @@ export type components = { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: readonly string[] | null; }; + readonly "cvss-severities": { + readonly cvss_v3?: { + /** @description The CVSS 3 vector string. */ + readonly vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + readonly cvss_v4?: { + /** @description The CVSS 4 vector string. */ + readonly vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export type components = { /** @description The CVSS score. */ readonly score: number | null; } | null; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export type components = { readonly slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ readonly node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + readonly client_id?: string; readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export type components = { * @example 5 */ readonly installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export type components = { /** Format: uri */ readonly html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export type components = { readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - readonly organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - readonly login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - readonly url: string; - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly repos_url: string; - /** Format: uri */ - readonly events_url: string; - readonly hooks_url: string; - readonly issues_url: string; - readonly members_url: string; - readonly public_members_url: string; - readonly avatar_url: string; - readonly description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - readonly blog?: string; - /** Format: uri */ - readonly html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - readonly name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - readonly company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - readonly location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - readonly email?: string; - /** @description Specifies if organization projects are enabled for this org */ - readonly has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - readonly has_repository_projects: boolean; - readonly is_verified?: boolean; - readonly public_repos: number; - readonly public_gists: number; - readonly followers: number; - readonly following: number; - readonly type: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly plan?: { - readonly name?: string; - readonly space?: number; - readonly private_repos?: number; - readonly filled_seats?: number; - readonly seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - readonly "organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - readonly repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - readonly events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; - /** @example A great organization */ - readonly description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export type components = { /** @description The assignee that has been granted access to GitHub Copilot. */ readonly assignee: { readonly [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ readonly organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export type components = { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export type components = { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; @@ -20025,6 +20092,8 @@ export type components = { readonly slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ readonly node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + readonly client_id?: string; readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export type components = { * @example 5 */ readonly installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export type components = { * "192.0.2.1" * ] */ readonly actions_macos?: readonly string[]; + /** @example [ + * "192.0.2.1" + * ] */ + readonly codespaces?: readonly string[]; /** @example [ * "192.0.2.1" * ] */ readonly dependabot?: readonly string[]; + /** @example [ + * "192.0.2.1" + * ] */ + readonly copilot?: readonly string[]; readonly domains?: { readonly website?: readonly string[]; readonly codespaces?: readonly string[]; readonly copilot?: readonly string[]; readonly packages?: readonly string[]; readonly actions?: readonly string[]; + readonly artifact_attestations?: { + /** @example [ + * "example" + * ] */ + readonly trust_domain?: string; + readonly services?: readonly string[]; + }; }; }; readonly "security-and-analysis": { @@ -21686,8 +21768,14 @@ export type components = { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; + /** @description A description of the rule used to detect the alert. */ + readonly full_description?: string; /** @description A set of tags applicable for the rule. */ readonly tags?: readonly string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export type components = { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export type components = { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export type components = { * Organization Custom Property * @description Custom property defined on an organization */ - readonly "org-custom-property": { + readonly "custom-property": { /** @description The name of the property */ readonly property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + readonly url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export type components = { * @description An actor that can bypass rules in a ruleset */ readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ readonly actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ readonly bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export type components = { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export type components = { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export type components = { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - readonly evaluation_result?: "pass" | "fail"; + readonly evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export type components = { */ readonly result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - readonly evaluation_result?: "pass" | "fail"; + readonly evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ readonly rule_evaluations?: readonly { readonly rule_source?: { @@ -24354,8 +24455,8 @@ export type components = { readonly result?: "pass" | "fail"; /** @description The type of rule. */ readonly rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - readonly details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + readonly details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export type components = { /** @description The CVSS score. */ readonly score: number | null; } | null; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; @@ -26417,6 +26519,7 @@ export type components = { readonly site_admin?: boolean; }; readonly name?: string; + readonly client_id?: string; readonly description?: string; readonly external_url?: string; readonly html_url?: string; @@ -26820,6 +26923,7 @@ export type components = { */ readonly "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export type components = { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; /** @description A set of tags applicable for the rule. */ readonly tags?: readonly string[] | null; @@ -27382,6 +27486,15 @@ export type components = { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + readonly "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export type components = { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + readonly "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + readonly "repository-rule-violation-error": { + readonly message?: string; + readonly documentation_url?: string; + readonly status?: string; + readonly metadata?: { + readonly secret_scanning?: { + readonly bypass_placeholders?: readonly { + readonly placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + readonly token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export type components = { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; @@ -31600,6 +31729,21 @@ export type components = { readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + readonly "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + readonly "secret-scanning-push-protection-bypass": { + readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly expire_at?: string | null; + /** @description The token type this bypass is for. */ + readonly token_type?: string; + }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ readonly summary: string; @@ -35372,7 +35516,6 @@ export type components = { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ readonly "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export type components = { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export type components = { readonly score: number; readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { readonly cwe_id: string; readonly name: string; @@ -38649,6 +38793,8 @@ export type components = { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description The client ID of the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -38890,6 +39036,8 @@ export type components = { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description Client ID of the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -39131,6 +39279,8 @@ export type components = { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description The Client ID for the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -40132,7 +40282,7 @@ export type components = { readonly "webhook-custom-property-created": { /** @enum {string} */ readonly action: "created"; - readonly definition: components["schemas"]["org-custom-property"]; + readonly definition: components["schemas"]["custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export type components = { readonly "webhook-custom-property-updated": { /** @enum {string} */ readonly action: "updated"; - readonly definition: components["schemas"]["org-custom-property"]; + readonly definition: components["schemas"]["custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export type components = { readonly score: number; readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { readonly cwe_id: string; readonly name: string; @@ -81847,6 +81998,70 @@ export type components = { readonly target_url: string | null; readonly updated_at: string; }; + /** parent issue added event */ + readonly "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + readonly action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + readonly "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + readonly action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + readonly "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + readonly action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + readonly "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + readonly action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ readonly "webhook-team-add": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export type components = { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -85137,7 +85352,7 @@ export type components = { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export type components = { readonly "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; /** @description The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export type components = { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The unique identifier of the role. */ readonly "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export type components = { readonly "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ readonly "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; @@ -85476,6 +85690,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + readonly epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + readonly epss_percentile?: 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 results before this cursor. 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 before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85485,7 +85705,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - readonly sort?: "updated" | "published"; + readonly sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; readonly header?: never; readonly path?: never; @@ -86460,7 +86680,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86501,6 +86721,44 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "copilot/usage-metrics-for-enterprise-team": { + readonly parameters: { + readonly query?: { + /** @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. */ + readonly since?: string; + /** @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. */ + readonly until?: string; + /** @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"]; + /** @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)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + }; + }; + readonly 401: components["responses"]["requires_authentication"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "activity/list-public-events": { readonly parameters: { readonly query?: { @@ -89660,6 +89918,20 @@ export interface operations { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -89696,6 +89968,12 @@ export interface operations { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89853,6 +90131,16 @@ export interface operations { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -89883,6 +90171,11 @@ export interface operations { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93466,7 +93759,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-custom-property"][]; + readonly "application/json": readonly components["schemas"]["custom-property"][]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93487,7 +93780,7 @@ export interface operations { readonly content: { readonly "application/json": { /** @description The array of custom properties to create or update. */ - readonly properties: readonly components["schemas"]["org-custom-property"][]; + readonly properties: readonly components["schemas"]["custom-property"][]; }; }; }; @@ -93498,7 +93791,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-custom-property"][]; + readonly "application/json": readonly components["schemas"]["custom-property"][]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93525,7 +93818,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-custom-property"]; + readonly "application/json": components["schemas"]["custom-property"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93572,7 +93865,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-custom-property"]; + readonly "application/json": components["schemas"]["custom-property"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93903,7 +94196,9 @@ export interface operations { */ readonly use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -93920,7 +94215,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94007,9 +94304,7 @@ export interface operations { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -94039,8 +94334,7 @@ export interface operations { readonly "repos/get-org-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94156,9 +94450,6 @@ export interface operations { readonly name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -94216,7 +94507,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94435,6 +94726,44 @@ export interface operations { }; }; }; + readonly "copilot/usage-metrics-for-team": { + readonly parameters: { + readonly query?: { + /** @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. */ + readonly since?: string; + /** @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. */ + readonly until?: string; + /** @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"]; + /** @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)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + }; + }; + readonly 401: components["responses"]["requires_authentication"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "teams/list": { readonly parameters: { readonly query?: { @@ -96628,7 +96957,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; @@ -96693,7 +97022,9 @@ export interface operations { */ readonly use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -96710,7 +97041,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99467,7 +99800,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ readonly contexts: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -99937,7 +100269,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ readonly contexts?: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101724,6 +102055,35 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-security/get-configuration-for-repository": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + readonly 204: components["responses"]["no_content"]; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "repos/codeowners-errors": { readonly parameters: { readonly query?: { @@ -103115,7 +103475,15 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + /** @description Conflict */ + readonly 409: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -104926,7 +105294,15 @@ export interface operations { readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; readonly "git/get-blob": { @@ -110049,6 +110425,7 @@ export interface operations { readonly "application/json": components["schemas"]["content-file"]; }; }; + readonly 304: components["responses"]["not_modified"]; readonly 404: components["responses"]["not_found"]; readonly 422: components["responses"]["validation_failed"]; }; @@ -110764,9 +111141,7 @@ export interface operations { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -110796,8 +111171,7 @@ export interface operations { readonly "repos/get-repo-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -110922,9 +111296,6 @@ export interface operations { readonly name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -110984,7 +111355,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111168,6 +111539,60 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "secret-scanning/create-push-protection-bypass": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + readonly reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + readonly placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "security-advisories/list-repository-advisories": { readonly parameters: { readonly query?: { @@ -116165,7 +116590,9 @@ export interface operations { */ readonly delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116182,7 +116609,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index a69166261..116d1bf01 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-enterprise-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/events": { readonly parameters: { readonly query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ readonly get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + readonly get: operations["copilot/usage-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/teams": { readonly parameters: { readonly query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; readonly delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ readonly post: operations["repos/create-attestation"]; readonly delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/code-security-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configuration-for-repository"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/codeowners/errors": { readonly parameters: { readonly query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ readonly get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly post: operations["secret-scanning/create-push-protection-bypass"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/security-advisories": { readonly parameters: { readonly query?: never; @@ -17305,6 +17431,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: readonly string[] | null; }; + readonly "cvss-severities": { + readonly cvss_v3?: { + /** @description The CVSS 3 vector string. */ + readonly vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + readonly cvss_v4?: { + /** @description The CVSS 4 vector string. */ + readonly vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export interface components { readonly slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ readonly node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + readonly client_id?: string; readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export interface components { * @example 5 */ readonly installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export interface components { /** Format: uri */ readonly html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export interface components { readonly repositories_url: string; readonly parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - readonly organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - readonly login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - readonly url: string; - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly repos_url: string; - /** Format: uri */ - readonly events_url: string; - readonly hooks_url: string; - readonly issues_url: string; - readonly members_url: string; - readonly public_members_url: string; - readonly avatar_url: string; - readonly description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - readonly blog?: string; - /** Format: uri */ - readonly html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - readonly name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - readonly company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - readonly location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - readonly email?: string; - /** @description Specifies if organization projects are enabled for this org */ - readonly has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - readonly has_repository_projects: boolean; - readonly is_verified?: boolean; - readonly public_repos: number; - readonly public_gists: number; - readonly followers: number; - readonly following: number; - readonly type: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly plan?: { - readonly name?: string; - readonly space?: number; - readonly private_repos?: number; - readonly filled_seats?: number; - readonly seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - readonly "organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - readonly repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - readonly events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; - /** @example A great organization */ - readonly description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ readonly assignee: { readonly [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ readonly organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; @@ -20025,6 +20092,8 @@ export interface components { readonly slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ readonly node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + readonly client_id?: string; readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export interface components { * @example 5 */ readonly installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ readonly client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export interface components { * "192.0.2.1" * ] */ readonly actions_macos?: readonly string[]; + /** @example [ + * "192.0.2.1" + * ] */ + readonly codespaces?: readonly string[]; /** @example [ * "192.0.2.1" * ] */ readonly dependabot?: readonly string[]; + /** @example [ + * "192.0.2.1" + * ] */ + readonly copilot?: readonly string[]; readonly domains?: { readonly website?: readonly string[]; readonly codespaces?: readonly string[]; readonly copilot?: readonly string[]; readonly packages?: readonly string[]; readonly actions?: readonly string[]; + readonly artifact_attestations?: { + /** @example [ + * "example" + * ] */ + readonly trust_domain?: string; + readonly services?: readonly string[]; + }; }; }; readonly "security-and-analysis": { @@ -21686,8 +21768,14 @@ export interface components { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; + /** @description A description of the rule used to detect the alert. */ + readonly full_description?: string; /** @description A set of tags applicable for the rule. */ readonly tags?: readonly string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export interface components { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export interface components { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - readonly "org-custom-property": { + readonly "custom-property": { /** @description The name of the property */ readonly property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + readonly url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ readonly actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ readonly bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export interface components { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - readonly evaluation_result?: "pass" | "fail"; + readonly evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export interface components { */ readonly result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - readonly evaluation_result?: "pass" | "fail"; + readonly evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ readonly rule_evaluations?: readonly { readonly rule_source?: { @@ -24354,8 +24455,8 @@ export interface components { readonly result?: "pass" | "fail"; /** @description The type of rule. */ readonly rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - readonly details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + readonly details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; @@ -26417,6 +26519,7 @@ export interface components { readonly site_admin?: boolean; }; readonly name?: string; + readonly client_id?: string; readonly description?: string; readonly external_url?: string; readonly html_url?: string; @@ -26820,6 +26923,7 @@ export interface components { */ readonly "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export interface components { readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ readonly full_description?: string; /** @description A set of tags applicable for the rule. */ readonly tags?: readonly string[] | null; @@ -27382,6 +27486,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + readonly "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + readonly "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + readonly "repository-rule-violation-error": { + readonly message?: string; + readonly documentation_url?: string; + readonly status?: string; + readonly metadata?: { + readonly secret_scanning?: { + readonly bypass_placeholders?: readonly { + readonly placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + readonly token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** @description The secret that was detected. */ readonly secret?: string; @@ -31600,6 +31729,21 @@ export interface components { readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + readonly "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + readonly "secret-scanning-push-protection-bypass": { + readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly expire_at?: string | null; + /** @description The token type this bypass is for. */ + readonly token_type?: string; + }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ readonly summary: string; @@ -35372,7 +35516,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ readonly "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ readonly secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export interface components { readonly score: number; readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { readonly cwe_id: string; readonly name: string; @@ -38649,6 +38793,8 @@ export interface components { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description The client ID of the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -38890,6 +39036,8 @@ export interface components { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description Client ID of the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -39131,6 +39279,8 @@ export interface components { readonly html_url: string; /** @description Unique identifier of the GitHub app */ readonly id: number | null; + /** @description The Client ID for the GitHub app */ + readonly client_id?: string | null; /** @description The name of the GitHub app */ readonly name: string; readonly node_id: string; @@ -40132,7 +40282,7 @@ export interface components { readonly "webhook-custom-property-created": { /** @enum {string} */ readonly action: "created"; - readonly definition: components["schemas"]["org-custom-property"]; + readonly definition: components["schemas"]["custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export interface components { readonly "webhook-custom-property-updated": { /** @enum {string} */ readonly action: "updated"; - readonly definition: components["schemas"]["org-custom-property"]; + readonly definition: components["schemas"]["custom-property"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export interface components { readonly score: number; readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: readonly { readonly cwe_id: string; readonly name: string; @@ -81847,6 +81998,70 @@ export interface components { readonly target_url: string | null; readonly updated_at: string; }; + /** parent issue added event */ + readonly "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + readonly action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + readonly "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + readonly action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + readonly "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + readonly action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + readonly "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + readonly action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + readonly sub_issue_id: number; + readonly sub_issue: components["schemas"]["issue"]; + readonly sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + readonly parent_issue_id: number; + readonly parent_issue: components["schemas"]["issue"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ readonly "webhook-team-add": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export interface components { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -85137,7 +85352,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export interface components { readonly "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; /** @description The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export interface components { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The unique identifier of the role. */ readonly "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export interface components { readonly "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ readonly "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; @@ -85476,6 +85690,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + readonly epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + readonly epss_percentile?: 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 results before this cursor. 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 before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85485,7 +85705,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - readonly sort?: "updated" | "published"; + readonly sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; readonly header?: never; readonly path?: never; @@ -86460,7 +86680,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86501,6 +86721,44 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "copilot/usage-metrics-for-enterprise-team": { + readonly parameters: { + readonly query?: { + /** @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. */ + readonly since?: string; + /** @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. */ + readonly until?: string; + /** @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"]; + /** @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)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + }; + }; + readonly 401: components["responses"]["requires_authentication"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "activity/list-public-events": { readonly parameters: { readonly query?: { @@ -89660,6 +89918,20 @@ export interface operations { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -89696,6 +89968,12 @@ export interface operations { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89853,6 +90131,16 @@ export interface operations { * @enum {string} */ readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -89883,6 +90171,11 @@ export interface operations { * @enum {string} */ readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93466,7 +93759,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-custom-property"][]; + readonly "application/json": readonly components["schemas"]["custom-property"][]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93487,7 +93780,7 @@ export interface operations { readonly content: { readonly "application/json": { /** @description The array of custom properties to create or update. */ - readonly properties: readonly components["schemas"]["org-custom-property"][]; + readonly properties: readonly components["schemas"]["custom-property"][]; }; }; }; @@ -93498,7 +93791,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-custom-property"][]; + readonly "application/json": readonly components["schemas"]["custom-property"][]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93525,7 +93818,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-custom-property"]; + readonly "application/json": components["schemas"]["custom-property"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93572,7 +93865,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-custom-property"]; + readonly "application/json": components["schemas"]["custom-property"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -93903,7 +94196,9 @@ export interface operations { */ readonly use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -93920,7 +94215,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94007,9 +94304,7 @@ export interface operations { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -94039,8 +94334,7 @@ export interface operations { readonly "repos/get-org-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94156,9 +94450,6 @@ export interface operations { readonly name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -94216,7 +94507,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94435,6 +94726,44 @@ export interface operations { }; }; }; + readonly "copilot/usage-metrics-for-team": { + readonly parameters: { + readonly query?: { + /** @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. */ + readonly since?: string; + /** @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. */ + readonly until?: string; + /** @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"]; + /** @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)." */ + readonly per_page?: number; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + readonly team_slug: components["parameters"]["team-slug"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + }; + }; + readonly 401: components["responses"]["requires_authentication"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 500: components["responses"]["internal_error"]; + }; + }; readonly "teams/list": { readonly parameters: { readonly query?: { @@ -96628,7 +96957,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ readonly secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ readonly status?: string; @@ -96693,7 +97022,9 @@ export interface operations { */ readonly use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -96710,7 +97041,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99467,7 +99800,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ readonly contexts: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -99937,7 +100269,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ readonly contexts?: readonly string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101724,6 +102055,35 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-security/get-configuration-for-repository": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + readonly 204: components["responses"]["no_content"]; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "repos/codeowners-errors": { readonly parameters: { readonly query?: { @@ -103115,7 +103475,15 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + /** @description Conflict */ + readonly 409: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -104926,7 +105294,15 @@ export interface operations { readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; readonly "git/get-blob": { @@ -110049,6 +110425,7 @@ export interface operations { readonly "application/json": components["schemas"]["content-file"]; }; }; + readonly 304: components["responses"]["not_modified"]; readonly 404: components["responses"]["not_found"]; readonly 422: components["responses"]["validation_failed"]; }; @@ -110764,9 +111141,7 @@ export interface operations { readonly name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -110796,8 +111171,7 @@ export interface operations { readonly "repos/get-repo-rule-suites": { readonly parameters: { readonly query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -110922,9 +111296,6 @@ export interface operations { readonly name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ readonly target?: "branch" | "tag" | "push"; @@ -110984,7 +111355,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111168,6 +111539,60 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "secret-scanning/create-push-protection-bypass": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + readonly reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + readonly placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "security-advisories/list-repository-advisories": { readonly parameters: { readonly query?: { @@ -116165,7 +116590,9 @@ export interface operations { */ readonly delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116182,7 +116609,9 @@ export interface operations { */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index dda08fda8..4c940d413 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ post: operations["repos/create-attestation"]; delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/codeowners/errors": { parameters: { query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -18193,6 +18319,9 @@ export interface webhooks { * For activity relating to deployment creation, use the `deployment` event. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + * + * > [!NOTE] + * > A webhook event is not fired for deployment statuses with an `inactive` state. * @description A new deployment status was created. */ post: operations["deployment-status/created"]; @@ -22760,6 +22889,102 @@ export interface webhooks { patch?: never; trace?: never; }; + "sub-issues-parent-issue-added": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to sub-issues. + * + * For activity relating to issues more generally, use the `issues` event instead. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + * @description A parent issue was added to an issue. + */ + post: operations["sub-issues/parent-issue-added"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "sub-issues-parent-issue-removed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to sub-issues. + * + * For activity relating to issues more generally, use the `issues` event instead. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + * @description A parent issue was removed from an issue. + */ + post: operations["sub-issues/parent-issue-removed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "sub-issues-sub-issue-added": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to sub-issues. + * + * For activity relating to issues more generally, use the `issues` event instead. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + * @description A sub-issue was added to an issue. + */ + post: operations["sub-issues/sub-issue-added"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "sub-issues-sub-issue-removed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to sub-issues. + * + * For activity relating to issues more generally, use the `issues` event instead. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + * @description A sub-issue was removed from an issue. + */ + post: operations["sub-issues/sub-issue-removed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "team-add": { parameters: { query?: never; @@ -23202,6 +23427,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -23324,12 +23563,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -23365,6 +23609,7 @@ export interface components { /** @description The slug name of the GitHub app */ slug?: string; node_id: string; + client_id?: string; owner: null | components["schemas"]["simple-user"]; /** @description The name of the GitHub app */ name: string; @@ -23397,7 +23642,6 @@ export interface components { events: string[]; /** @description The number of installations associated with the GitHub app */ installations_count?: number; - client_id?: string; client_secret?: string; webhook_secret?: string | null; pem?: string; @@ -24418,6 +24662,27 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + login: string; + id: number; + node_id: string; + /** Format: uri */ + url: string; + /** Format: uri */ + repos_url: string; + /** Format: uri */ + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -24479,91 +24744,6 @@ export interface components { repositories_url: string; parent: null | components["schemas"]["team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** @description Unique login name of the organization */ - login: string; - /** - * Format: uri - * @description URL for the organization - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** @description Display name for the organization */ - name?: string; - /** @description Display company name for the organization */ - company?: string; - /** @description Display location for the organization */ - location?: string; - /** - * Format: email - * @description Display email for the organization - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - login: string; - id: number; - node_id: string; - /** Format: uri */ - url: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -24593,7 +24773,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ organization?: (Record | null) & components["schemas"]["organization-simple"]; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -24716,6 +24896,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -25007,7 +25188,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -25637,13 +25818,19 @@ export interface components { importer?: string[]; actions?: string[]; actions_macos?: string[]; + codespaces?: string[]; dependabot?: string[]; + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + artifact_attestations?: { + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -26215,8 +26402,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -26304,6 +26497,16 @@ export interface components { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -26334,6 +26537,11 @@ export interface components { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -27027,9 +27235,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; /** * @description The type of the value for the property * @enum {string} @@ -27270,18 +27483,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -27352,7 +27562,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -27712,9 +27921,6 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -27784,7 +27990,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -27815,10 +28021,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -27841,8 +28047,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -27949,6 +28155,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; @@ -29256,6 +29463,7 @@ export interface components { site_admin?: boolean; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -29553,7 +29761,10 @@ export interface components { * @description A check performed on the code of a given code change */ "check-run": { - /** @description The id of the check. */ + /** + * Format: int64 + * @description The id of the check. + */ id: number; /** @description The SHA of the commit that is being checked. */ head_sha: string; @@ -29687,7 +29898,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -29988,6 +30199,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -30584,6 +30804,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -32902,7 +33138,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -33060,6 +33296,21 @@ export interface components { type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -36348,7 +36599,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -38635,7 +38885,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38657,6 +38907,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -39081,6 +39332,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39322,6 +39575,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39563,6 +39818,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -40564,7 +40821,7 @@ export interface components { "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40587,7 +40844,7 @@ export interface components { "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81961,6 +82218,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -82279,6 +82537,70 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83956,7 +84278,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ created_at: string; event: string; @@ -85566,7 +85888,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85575,6 +85897,8 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85633,8 +85957,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85664,8 +85986,7 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; @@ -85905,6 +86226,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + epss_percentile?: 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 results before this cursor. 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)." */ before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85914,7 +86241,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; header?: never; path?: never; @@ -86870,7 +87197,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86911,6 +87238,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "activity/list-public-events": { parameters: { query?: { @@ -90040,6 +90405,20 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -90076,6 +90455,12 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -90233,6 +90618,16 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -90263,6 +90658,11 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93838,7 +94238,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93859,7 +94259,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -93870,7 +94270,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93897,7 +94297,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93943,7 +94343,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -94273,7 +94673,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -94290,7 +94692,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94377,9 +94781,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94409,8 +94811,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94526,9 +94927,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94586,7 +94984,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94805,6 +95203,44 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "teams/list": { parameters: { query?: { @@ -96958,7 +97394,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ status?: string; @@ -97023,7 +97459,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -97040,7 +97478,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99787,7 +100227,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100257,7 +100696,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -102043,6 +102481,35 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "repos/codeowners-errors": { parameters: { query?: { @@ -103432,7 +103899,15 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -105228,7 +105703,15 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; "git/get-blob": { @@ -110334,6 +110817,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -111048,9 +111532,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -111080,8 +111562,7 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -111206,9 +111687,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -111268,7 +111746,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111452,6 +111930,60 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -116377,7 +116909,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116394,7 +116928,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -124105,7 +124641,155 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-locked"]; + "application/json": components["schemas"]["webhook-pull-request-locked"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "pull-request/milestoned": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-pull-request-milestoned"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "pull-request/opened": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-pull-request-opened"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "pull-request/ready-for-review": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-pull-request-ready-for-review"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "pull-request/reopened": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-pull-request-reopened"]; }; }; responses: { @@ -124118,7 +124802,7 @@ export interface operations { }; }; }; - "pull-request/milestoned": { + "pull-request-review-comment/created": { parameters: { query?: never; header?: { @@ -124142,7 +124826,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-milestoned"]; + "application/json": components["schemas"]["webhook-pull-request-review-comment-created"]; }; }; responses: { @@ -124155,7 +124839,7 @@ export interface operations { }; }; }; - "pull-request/opened": { + "pull-request-review-comment/deleted": { parameters: { query?: never; header?: { @@ -124179,7 +124863,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-opened"]; + "application/json": components["schemas"]["webhook-pull-request-review-comment-deleted"]; }; }; responses: { @@ -124192,7 +124876,7 @@ export interface operations { }; }; }; - "pull-request/ready-for-review": { + "pull-request-review-comment/edited": { parameters: { query?: never; header?: { @@ -124216,7 +124900,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-ready-for-review"]; + "application/json": components["schemas"]["webhook-pull-request-review-comment-edited"]; }; }; responses: { @@ -124229,7 +124913,7 @@ export interface operations { }; }; }; - "pull-request/reopened": { + "pull-request-review/dismissed": { parameters: { query?: never; header?: { @@ -124253,7 +124937,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-reopened"]; + "application/json": components["schemas"]["webhook-pull-request-review-dismissed"]; }; }; responses: { @@ -124266,7 +124950,7 @@ export interface operations { }; }; }; - "pull-request-review-comment/created": { + "pull-request-review/edited": { parameters: { query?: never; header?: { @@ -124290,7 +124974,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-comment-created"]; + "application/json": components["schemas"]["webhook-pull-request-review-edited"]; }; }; responses: { @@ -124303,7 +124987,7 @@ export interface operations { }; }; }; - "pull-request-review-comment/deleted": { + "pull-request/review-request-removed": { parameters: { query?: never; header?: { @@ -124327,7 +125011,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-comment-deleted"]; + "application/json": components["schemas"]["webhook-pull-request-review-request-removed"]; }; }; responses: { @@ -124340,7 +125024,7 @@ export interface operations { }; }; }; - "pull-request-review-comment/edited": { + "pull-request/review-requested": { parameters: { query?: never; header?: { @@ -124364,7 +125048,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-comment-edited"]; + "application/json": components["schemas"]["webhook-pull-request-review-requested"]; }; }; responses: { @@ -124377,7 +125061,7 @@ export interface operations { }; }; }; - "pull-request-review/dismissed": { + "pull-request-review/submitted": { parameters: { query?: never; header?: { @@ -124401,7 +125085,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-dismissed"]; + "application/json": components["schemas"]["webhook-pull-request-review-submitted"]; }; }; responses: { @@ -124414,7 +125098,7 @@ export interface operations { }; }; }; - "pull-request-review/edited": { + "pull-request-review-thread/resolved": { parameters: { query?: never; header?: { @@ -124438,7 +125122,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-edited"]; + "application/json": components["schemas"]["webhook-pull-request-review-thread-resolved"]; }; }; responses: { @@ -124451,7 +125135,7 @@ export interface operations { }; }; }; - "pull-request/review-request-removed": { + "pull-request-review-thread/unresolved": { parameters: { query?: never; header?: { @@ -124475,7 +125159,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-request-removed"]; + "application/json": components["schemas"]["webhook-pull-request-review-thread-unresolved"]; }; }; responses: { @@ -124488,7 +125172,7 @@ export interface operations { }; }; }; - "pull-request/review-requested": { + "pull-request/synchronize": { parameters: { query?: never; header?: { @@ -124512,7 +125196,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-requested"]; + "application/json": components["schemas"]["webhook-pull-request-synchronize"]; }; }; responses: { @@ -124525,7 +125209,7 @@ export interface operations { }; }; }; - "pull-request-review/submitted": { + "pull-request/unassigned": { parameters: { query?: never; header?: { @@ -124549,7 +125233,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-submitted"]; + "application/json": components["schemas"]["webhook-pull-request-unassigned"]; }; }; responses: { @@ -124562,7 +125246,7 @@ export interface operations { }; }; }; - "pull-request-review-thread/resolved": { + "pull-request/unlabeled": { parameters: { query?: never; header?: { @@ -124586,7 +125270,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-thread-resolved"]; + "application/json": components["schemas"]["webhook-pull-request-unlabeled"]; }; }; responses: { @@ -124599,7 +125283,7 @@ export interface operations { }; }; }; - "pull-request-review-thread/unresolved": { + "pull-request/unlocked": { parameters: { query?: never; header?: { @@ -124623,7 +125307,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-review-thread-unresolved"]; + "application/json": components["schemas"]["webhook-pull-request-unlocked"]; }; }; responses: { @@ -124636,7 +125320,7 @@ export interface operations { }; }; }; - "pull-request/synchronize": { + push: { parameters: { query?: never; header?: { @@ -124660,7 +125344,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-synchronize"]; + "application/json": components["schemas"]["webhook-push"]; }; }; responses: { @@ -124673,7 +125357,7 @@ export interface operations { }; }; }; - "pull-request/unassigned": { + "registry-package/published": { parameters: { query?: never; header?: { @@ -124697,7 +125381,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-unassigned"]; + "application/json": components["schemas"]["webhook-registry-package-published"]; }; }; responses: { @@ -124710,7 +125394,7 @@ export interface operations { }; }; }; - "pull-request/unlabeled": { + "registry-package/updated": { parameters: { query?: never; header?: { @@ -124734,7 +125418,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-unlabeled"]; + "application/json": components["schemas"]["webhook-registry-package-updated"]; }; }; responses: { @@ -124747,7 +125431,7 @@ export interface operations { }; }; }; - "pull-request/unlocked": { + "release/created": { parameters: { query?: never; header?: { @@ -124771,7 +125455,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-pull-request-unlocked"]; + "application/json": components["schemas"]["webhook-release-created"]; }; }; responses: { @@ -124784,7 +125468,7 @@ export interface operations { }; }; }; - push: { + "release/deleted": { parameters: { query?: never; header?: { @@ -124808,7 +125492,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-push"]; + "application/json": components["schemas"]["webhook-release-deleted"]; }; }; responses: { @@ -124821,7 +125505,7 @@ export interface operations { }; }; }; - "registry-package/published": { + "release/edited": { parameters: { query?: never; header?: { @@ -124845,7 +125529,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-registry-package-published"]; + "application/json": components["schemas"]["webhook-release-edited"]; }; }; responses: { @@ -124858,7 +125542,7 @@ export interface operations { }; }; }; - "registry-package/updated": { + "release/prereleased": { parameters: { query?: never; header?: { @@ -124882,7 +125566,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-registry-package-updated"]; + "application/json": components["schemas"]["webhook-release-prereleased"]; }; }; responses: { @@ -124895,7 +125579,7 @@ export interface operations { }; }; }; - "release/created": { + "release/published": { parameters: { query?: never; header?: { @@ -124919,7 +125603,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-created"]; + "application/json": components["schemas"]["webhook-release-published"]; }; }; responses: { @@ -124932,7 +125616,7 @@ export interface operations { }; }; }; - "release/deleted": { + "release/released": { parameters: { query?: never; header?: { @@ -124956,7 +125640,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-deleted"]; + "application/json": components["schemas"]["webhook-release-released"]; }; }; responses: { @@ -124969,7 +125653,7 @@ export interface operations { }; }; }; - "release/edited": { + "release/unpublished": { parameters: { query?: never; header?: { @@ -124993,7 +125677,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-edited"]; + "application/json": components["schemas"]["webhook-release-unpublished"]; }; }; responses: { @@ -125006,7 +125690,7 @@ export interface operations { }; }; }; - "release/prereleased": { + "repository-advisory/published": { parameters: { query?: never; header?: { @@ -125030,7 +125714,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-prereleased"]; + "application/json": components["schemas"]["webhook-repository-advisory-published"]; }; }; responses: { @@ -125043,7 +125727,7 @@ export interface operations { }; }; }; - "release/published": { + "repository-advisory/reported": { parameters: { query?: never; header?: { @@ -125067,7 +125751,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-published"]; + "application/json": components["schemas"]["webhook-repository-advisory-reported"]; }; }; responses: { @@ -125080,7 +125764,7 @@ export interface operations { }; }; }; - "release/released": { + "repository/archived": { parameters: { query?: never; header?: { @@ -125104,7 +125788,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-released"]; + "application/json": components["schemas"]["webhook-repository-archived"]; }; }; responses: { @@ -125117,7 +125801,7 @@ export interface operations { }; }; }; - "release/unpublished": { + "repository/created": { parameters: { query?: never; header?: { @@ -125141,7 +125825,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-release-unpublished"]; + "application/json": components["schemas"]["webhook-repository-created"]; }; }; responses: { @@ -125154,7 +125838,7 @@ export interface operations { }; }; }; - "repository-advisory/published": { + "repository/deleted": { parameters: { query?: never; header?: { @@ -125178,7 +125862,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-advisory-published"]; + "application/json": components["schemas"]["webhook-repository-deleted"]; }; }; responses: { @@ -125191,7 +125875,7 @@ export interface operations { }; }; }; - "repository-advisory/reported": { + "repository-dispatch/sample.collected": { parameters: { query?: never; header?: { @@ -125215,7 +125899,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-advisory-reported"]; + "application/json": components["schemas"]["webhook-repository-dispatch-sample"]; }; }; responses: { @@ -125228,7 +125912,7 @@ export interface operations { }; }; }; - "repository/archived": { + "repository/edited": { parameters: { query?: never; header?: { @@ -125252,7 +125936,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-archived"]; + "application/json": components["schemas"]["webhook-repository-edited"]; }; }; responses: { @@ -125265,7 +125949,7 @@ export interface operations { }; }; }; - "repository/created": { + "repository-import": { parameters: { query?: never; header?: { @@ -125289,7 +125973,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-created"]; + "application/json": components["schemas"]["webhook-repository-import"]; }; }; responses: { @@ -125302,7 +125986,7 @@ export interface operations { }; }; }; - "repository/deleted": { + "repository/privatized": { parameters: { query?: never; header?: { @@ -125326,7 +126010,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-deleted"]; + "application/json": components["schemas"]["webhook-repository-privatized"]; }; }; responses: { @@ -125339,7 +126023,7 @@ export interface operations { }; }; }; - "repository-dispatch/sample.collected": { + "repository/publicized": { parameters: { query?: never; header?: { @@ -125363,7 +126047,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-dispatch-sample"]; + "application/json": components["schemas"]["webhook-repository-publicized"]; }; }; responses: { @@ -125376,7 +126060,7 @@ export interface operations { }; }; }; - "repository/edited": { + "repository/renamed": { parameters: { query?: never; header?: { @@ -125400,7 +126084,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-edited"]; + "application/json": components["schemas"]["webhook-repository-renamed"]; }; }; responses: { @@ -125413,7 +126097,7 @@ export interface operations { }; }; }; - "repository-import": { + "repository-ruleset/created": { parameters: { query?: never; header?: { @@ -125437,7 +126121,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-import"]; + "application/json": components["schemas"]["webhook-repository-ruleset-created"]; }; }; responses: { @@ -125450,7 +126134,7 @@ export interface operations { }; }; }; - "repository/privatized": { + "repository-ruleset/deleted": { parameters: { query?: never; header?: { @@ -125474,7 +126158,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-privatized"]; + "application/json": components["schemas"]["webhook-repository-ruleset-deleted"]; }; }; responses: { @@ -125487,7 +126171,7 @@ export interface operations { }; }; }; - "repository/publicized": { + "repository-ruleset/edited": { parameters: { query?: never; header?: { @@ -125511,7 +126195,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-publicized"]; + "application/json": components["schemas"]["webhook-repository-ruleset-edited"]; }; }; responses: { @@ -125524,7 +126208,7 @@ export interface operations { }; }; }; - "repository/renamed": { + "repository/transferred": { parameters: { query?: never; header?: { @@ -125548,7 +126232,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-renamed"]; + "application/json": components["schemas"]["webhook-repository-transferred"]; }; }; responses: { @@ -125561,7 +126245,7 @@ export interface operations { }; }; }; - "repository-ruleset/created": { + "repository/unarchived": { parameters: { query?: never; header?: { @@ -125585,7 +126269,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-ruleset-created"]; + "application/json": components["schemas"]["webhook-repository-unarchived"]; }; }; responses: { @@ -125598,7 +126282,7 @@ export interface operations { }; }; }; - "repository-ruleset/deleted": { + "repository-vulnerability-alert/create": { parameters: { query?: never; header?: { @@ -125622,7 +126306,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-ruleset-deleted"]; + "application/json": components["schemas"]["webhook-repository-vulnerability-alert-create"]; }; }; responses: { @@ -125635,7 +126319,7 @@ export interface operations { }; }; }; - "repository-ruleset/edited": { + "repository-vulnerability-alert/dismiss": { parameters: { query?: never; header?: { @@ -125659,7 +126343,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-ruleset-edited"]; + "application/json": components["schemas"]["webhook-repository-vulnerability-alert-dismiss"]; }; }; responses: { @@ -125672,7 +126356,7 @@ export interface operations { }; }; }; - "repository/transferred": { + "repository-vulnerability-alert/reopen": { parameters: { query?: never; header?: { @@ -125696,7 +126380,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-transferred"]; + "application/json": components["schemas"]["webhook-repository-vulnerability-alert-reopen"]; }; }; responses: { @@ -125709,7 +126393,7 @@ export interface operations { }; }; }; - "repository/unarchived": { + "repository-vulnerability-alert/resolve": { parameters: { query?: never; header?: { @@ -125733,7 +126417,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-unarchived"]; + "application/json": components["schemas"]["webhook-repository-vulnerability-alert-resolve"]; }; }; responses: { @@ -125746,7 +126430,7 @@ export interface operations { }; }; }; - "repository-vulnerability-alert/create": { + "secret-scanning-alert/created": { parameters: { query?: never; header?: { @@ -125770,7 +126454,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-vulnerability-alert-create"]; + "application/json": components["schemas"]["webhook-secret-scanning-alert-created"]; }; }; responses: { @@ -125783,7 +126467,7 @@ export interface operations { }; }; }; - "repository-vulnerability-alert/dismiss": { + "secret-scanning-alert-location/created": { parameters: { query?: never; header?: { @@ -125807,7 +126491,8 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-vulnerability-alert-dismiss"]; + "application/json": components["schemas"]["webhook-secret-scanning-alert-location-created"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-secret-scanning-alert-location-created-form-encoded"]; }; }; responses: { @@ -125820,7 +126505,7 @@ export interface operations { }; }; }; - "repository-vulnerability-alert/reopen": { + "secret-scanning-alert/reopened": { parameters: { query?: never; header?: { @@ -125844,7 +126529,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-vulnerability-alert-reopen"]; + "application/json": components["schemas"]["webhook-secret-scanning-alert-reopened"]; }; }; responses: { @@ -125857,7 +126542,7 @@ export interface operations { }; }; }; - "repository-vulnerability-alert/resolve": { + "secret-scanning-alert/resolved": { parameters: { query?: never; header?: { @@ -125881,7 +126566,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-repository-vulnerability-alert-resolve"]; + "application/json": components["schemas"]["webhook-secret-scanning-alert-resolved"]; }; }; responses: { @@ -125894,7 +126579,7 @@ export interface operations { }; }; }; - "secret-scanning-alert/created": { + "secret-scanning-alert/validated": { parameters: { query?: never; header?: { @@ -125918,7 +126603,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-secret-scanning-alert-created"]; + "application/json": components["schemas"]["webhook-secret-scanning-alert-validated"]; }; }; responses: { @@ -125931,7 +126616,7 @@ export interface operations { }; }; }; - "secret-scanning-alert-location/created": { + "security-advisory/published": { parameters: { query?: never; header?: { @@ -125955,8 +126640,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-secret-scanning-alert-location-created"]; - "application/x-www-form-urlencoded": components["schemas"]["webhook-secret-scanning-alert-location-created-form-encoded"]; + "application/json": components["schemas"]["webhook-security-advisory-published"]; }; }; responses: { @@ -125969,7 +126653,7 @@ export interface operations { }; }; }; - "secret-scanning-alert/reopened": { + "security-advisory/updated": { parameters: { query?: never; header?: { @@ -125993,7 +126677,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-secret-scanning-alert-reopened"]; + "application/json": components["schemas"]["webhook-security-advisory-updated"]; }; }; responses: { @@ -126006,7 +126690,7 @@ export interface operations { }; }; }; - "secret-scanning-alert/resolved": { + "security-advisory/withdrawn": { parameters: { query?: never; header?: { @@ -126030,7 +126714,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-secret-scanning-alert-resolved"]; + "application/json": components["schemas"]["webhook-security-advisory-withdrawn"]; }; }; responses: { @@ -126043,7 +126727,7 @@ export interface operations { }; }; }; - "secret-scanning-alert/validated": { + "security-and-analysis": { parameters: { query?: never; header?: { @@ -126067,7 +126751,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-secret-scanning-alert-validated"]; + "application/json": components["schemas"]["webhook-security-and-analysis"]; }; }; responses: { @@ -126080,7 +126764,7 @@ export interface operations { }; }; }; - "security-advisory/published": { + "sponsorship/cancelled": { parameters: { query?: never; header?: { @@ -126104,7 +126788,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-security-advisory-published"]; + "application/json": components["schemas"]["webhook-sponsorship-cancelled"]; }; }; responses: { @@ -126117,7 +126801,7 @@ export interface operations { }; }; }; - "security-advisory/updated": { + "sponsorship/created": { parameters: { query?: never; header?: { @@ -126141,7 +126825,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-security-advisory-updated"]; + "application/json": components["schemas"]["webhook-sponsorship-created"]; }; }; responses: { @@ -126154,7 +126838,7 @@ export interface operations { }; }; }; - "security-advisory/withdrawn": { + "sponsorship/edited": { parameters: { query?: never; header?: { @@ -126178,7 +126862,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-security-advisory-withdrawn"]; + "application/json": components["schemas"]["webhook-sponsorship-edited"]; }; }; responses: { @@ -126191,7 +126875,7 @@ export interface operations { }; }; }; - "security-and-analysis": { + "sponsorship/pending-cancellation": { parameters: { query?: never; header?: { @@ -126215,7 +126899,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-security-and-analysis"]; + "application/json": components["schemas"]["webhook-sponsorship-pending-cancellation"]; }; }; responses: { @@ -126228,7 +126912,7 @@ export interface operations { }; }; }; - "sponsorship/cancelled": { + "sponsorship/pending-tier-change": { parameters: { query?: never; header?: { @@ -126252,7 +126936,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-cancelled"]; + "application/json": components["schemas"]["webhook-sponsorship-pending-tier-change"]; }; }; responses: { @@ -126265,7 +126949,7 @@ export interface operations { }; }; }; - "sponsorship/created": { + "sponsorship/tier-changed": { parameters: { query?: never; header?: { @@ -126289,7 +126973,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-created"]; + "application/json": components["schemas"]["webhook-sponsorship-tier-changed"]; }; }; responses: { @@ -126302,7 +126986,7 @@ export interface operations { }; }; }; - "sponsorship/edited": { + "star/created": { parameters: { query?: never; header?: { @@ -126326,7 +127010,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-edited"]; + "application/json": components["schemas"]["webhook-star-created"]; }; }; responses: { @@ -126339,7 +127023,7 @@ export interface operations { }; }; }; - "sponsorship/pending-cancellation": { + "star/deleted": { parameters: { query?: never; header?: { @@ -126363,7 +127047,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-pending-cancellation"]; + "application/json": components["schemas"]["webhook-star-deleted"]; }; }; responses: { @@ -126376,7 +127060,7 @@ export interface operations { }; }; }; - "sponsorship/pending-tier-change": { + status: { parameters: { query?: never; header?: { @@ -126400,7 +127084,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-pending-tier-change"]; + "application/json": components["schemas"]["webhook-status"]; }; }; responses: { @@ -126413,7 +127097,7 @@ export interface operations { }; }; }; - "sponsorship/tier-changed": { + "sub-issues/parent-issue-added": { parameters: { query?: never; header?: { @@ -126437,7 +127121,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-sponsorship-tier-changed"]; + "application/json": components["schemas"]["webhook-sub-issues-parent-issue-added"]; }; }; responses: { @@ -126450,7 +127134,7 @@ export interface operations { }; }; }; - "star/created": { + "sub-issues/parent-issue-removed": { parameters: { query?: never; header?: { @@ -126474,7 +127158,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-star-created"]; + "application/json": components["schemas"]["webhook-sub-issues-parent-issue-removed"]; }; }; responses: { @@ -126487,7 +127171,7 @@ export interface operations { }; }; }; - "star/deleted": { + "sub-issues/sub-issue-added": { parameters: { query?: never; header?: { @@ -126511,7 +127195,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-star-deleted"]; + "application/json": components["schemas"]["webhook-sub-issues-sub-issue-added"]; }; }; responses: { @@ -126524,7 +127208,7 @@ export interface operations { }; }; }; - status: { + "sub-issues/sub-issue-removed": { parameters: { query?: never; header?: { @@ -126548,7 +127232,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-status"]; + "application/json": components["schemas"]["webhook-sub-issues-sub-issue-removed"]; }; }; responses: { diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 5ce9cafb1..55f2f4d26 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -231,6 +231,20 @@ paths: in: query schema: type: string + - name: epss_percentage + in: query + description: |- + If specified, only return advisories that have an EPSS percentage score that matches the provided value. + The EPSS percentage represents the likelihood of a CVE being exploited. + schema: + type: string + - name: epss_percentile + in: query + description: |- + If specified, only return advisories that have an EPSS percentile score that matches the provided value. + The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + schema: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/direction" @@ -252,6 +266,8 @@ paths: enum: - updated - published + - epss_percentage + - epss_percentile default: published responses: '200': @@ -1501,7 +1517,7 @@ paths: for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + 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. @@ -1674,6 +1690,85 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for an enterprise team + description: |- + > [!NOTE] + > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + + Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-org" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage "/events": get: summary: List public events @@ -6225,6 +6320,23 @@ paths: - disabled - not_set default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + default: false dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -6273,6 +6385,15 @@ paths: - disabled - not_set default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -6494,6 +6615,21 @@ paths: - enabled - disabled - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -6536,6 +6672,14 @@ paths: - enabled - disabled - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -7892,7 +8036,7 @@ paths: across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + 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. @@ -11657,10 +11801,10 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11697,7 +11841,7 @@ paths: type: array description: The array of custom properties to create or update. items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" minItems: 1 maxItems: 100 required: @@ -11728,10 +11872,10 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11762,10 +11906,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11857,10 +12001,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': @@ -12322,6 +12466,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -12344,6 +12490,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -12466,15 +12614,12 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag - push + default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -12612,7 +12757,11 @@ paths: "/orgs/{org}/rulesets/{ruleset_id}": get: summary: Get an organization repository ruleset - description: Get a repository ruleset for an organization. + description: |- + Get a repository ruleset for an organization. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. tags: - repos operationId: repos/get-org-ruleset @@ -12681,11 +12830,7 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -13085,6 +13230,85 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for a team + description: |- + > [!NOTE] + > This endpoint is in beta 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" + - 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" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-org" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage "/orgs/{org}/teams": get: summary: List teams @@ -14744,7 +14968,7 @@ paths: The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. tags: - orgs operationId: orgs/enable-or-disable-security-product-on-all-org-repos @@ -16001,7 +16225,7 @@ paths: type: object description: Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. - For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." + For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." properties: status: type: string @@ -16078,6 +16302,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -16100,6 +16326,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -19270,9 +19498,9 @@ paths: description: |- Store an artifact attestation and associate it with a repository. - The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. - Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/create-attestation @@ -19803,7 +20031,7 @@ paths: have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained - control.\n" + control." items: type: string checks: @@ -20514,7 +20742,7 @@ paths: in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` - instead of `contexts` for more fine-grained control.\n" + instead of `contexts` for more fine-grained control." items: type: string checks: @@ -23655,6 +23883,47 @@ paths: githubCloudOnly: false category: code-scanning subcategory: code-scanning + "/repos/{owner}/{repo}/code-security-configuration": + get: + summary: Get the code security configuration associated with a repository + description: |- + Get the code security configuration that manages a repository's code security settings. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration-for-repository" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-for-repository" + '204': + "$ref": "#/components/responses/no_content" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations "/repos/{owner}/{repo}/codeowners/errors": get: summary: List CODEOWNERS errors @@ -25861,7 +26130,13 @@ paths: '422': "$ref": "#/components/responses/validation_failed" '409': - "$ref": "#/components/responses/conflict" + description: Conflict + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/basic-error" + - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28355,7 +28630,13 @@ paths: '403': "$ref": "#/components/responses/forbidden" '422': - "$ref": "#/components/responses/validation_failed" + description: Validation failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36042,6 +36323,8 @@ paths: examples: default: "$ref": "#/components/examples/content-file" + '304': + "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '422': @@ -37025,15 +37308,12 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag - push + default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -37165,7 +37445,11 @@ paths: "/repos/{owner}/{repo}/rulesets/{ruleset_id}": get: summary: Get a repository ruleset - description: Get a ruleset for a repository. + description: |- + Get a ruleset for a repository. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. tags: - repos operationId: repos/get-repo-ruleset @@ -37244,11 +37528,7 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -37534,6 +37814,67 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": + post: + summary: Create a push protection bypass + description: |- + Creates a bypass for a previously push protected secret. + + The authenticated user must be the original author of the committed secret. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: secret-scanning/create-push-protection-bypass + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reason: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + placeholder_id: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + required: + - reason + - placeholder_id + examples: + default: + value: + reason: will_fix_later + placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + examples: + default: + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + '403': + description: User does not have enough permissions to perform this action. + '404': + description: Placeholder ID not found, or push protection is disabled on + this repository. + '422': + description: Bad request, input data missing or incorrect. + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning "/repos/{owner}/{repo}/security-advisories": get: summary: List repository security advisories @@ -42839,9 +43180,9 @@ paths: type: array items: type: string - minItems: 1 examples: - username@example.com + minItems: 1 examples: [] required: - emails @@ -42852,9 +43193,9 @@ paths: - type: array items: type: string - minItems: 1 examples: - username@example.com + minItems: 1 - type: string examples: default: @@ -42919,9 +43260,9 @@ paths: type: array items: type: string - minItems: 1 examples: - username@example.com + minItems: 1 example: emails: - octocat@github.com @@ -42931,9 +43272,9 @@ paths: - type: array items: type: string - minItems: 1 examples: - username@example.com + minItems: 1 - type: string examples: default: @@ -45070,6 +45411,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -45092,6 +45435,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -49945,6 +50290,9 @@ webhooks: For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + + > [!NOTE] + > A webhook event is not fired for deployment statuses with an `inactive` state. description: A new deployment status was created. operationId: deployment-status/created externalDocs: @@ -62004,7 +62352,198 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: security_advisory + supported-webhook-types: + - app + security-and-analysis: + post: + summary: |- + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-security-and-analysis" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: security_and_analysis + supported-webhook-types: + - repository + - organization + - app + sponsorship-cancelled: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsorship was cancelled and the last billing cycle has ended. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-created: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62012,18 +62551,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: sponsorship supported-webhook-types: - - app - security-and-analysis: + - sponsors_listing + sponsorship-edited: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -62065,7 +62607,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62073,22 +62615,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - sponsorship-cancelled: + - sponsors_listing + sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." description: |- - A sponsorship was cancelled and the last billing cycle has ended. + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62132,7 +62672,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62143,15 +62683,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-created: + sponsorship-pending-tier-change: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62195,7 +62735,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62206,16 +62746,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-edited: + sponsorship-tier-changed: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + description: A sponsor changed the tier of their sponsorship and the change + has taken effect. If a sponsor upgraded their tier, the change took effect + immediately. If a sponsor downgraded their tier, the change took effect at + the beginning of the sponsor's next billing cycle. + operationId: sponsorship/tier-changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -62259,7 +62800,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62270,19 +62811,80 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + star-created: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-star-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: star + supported-webhook-types: + - repository + - organization + - app + star-deleted: + post: + summary: |- + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -62324,7 +62926,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62332,20 +62934,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: star supported-webhook-types: - - sponsors_listing - sponsorship-pending-tier-change: + - repository + - organization + - app + status: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -62387,7 +62989,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62395,22 +62997,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: status supported-webhook-types: - - sponsors_listing - sponsorship-tier-changed: + - repository + - organization + - app + sub-issues-parent-issue-added: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + This event occurs when there is activity relating to sub-issues. - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62452,7 +63055,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62460,19 +63063,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: sub-issues supported-webhook-types: - - sponsors_listing - star-created: + - repository + - organization + - app + sub-issues-parent-issue-removed: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62514,7 +63121,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62522,21 +63129,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sub-issues supported-webhook-types: - repository - organization - app - star-deleted: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62578,7 +63187,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62586,20 +63195,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sub-issues supported-webhook-types: - repository - organization - app - status: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62641,7 +63253,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62649,7 +63261,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: sub-issues supported-webhook-types: - repository - organization @@ -63842,6 +64454,53 @@ components: - vulnerable_version_range - first_patched_version - vulnerable_functions + cvss-severities: + type: + - object + - 'null' + properties: + cvss_v3: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 3 vector string. + score: + type: + - number + - 'null' + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 4 vector string. + score: + type: + - number + - 'null' + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score simple-user: title: Simple User description: A GitHub user. @@ -64129,6 +64788,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: - array @@ -64146,6 +64807,15 @@ components: required: - cwe_id - name + epss: + type: + - object + - 'null' + properties: + percentage: + type: number + percentile: + type: number credits: type: - array @@ -64238,6 +64908,10 @@ components: type: string examples: - MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + examples: + - '"Iv1.25b5d1e65ffc4022"' owner: anyOf: - type: 'null' @@ -64305,10 +64979,6 @@ components: type: integer examples: - 5 - client_id: - type: string - examples: - - '"Iv1.25b5d1e65ffc4022"' client_secret: type: string examples: @@ -66580,291 +67250,6 @@ components: - html_url - key - name - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - organization: - title: Organization - description: GitHub account for managing multiple users, teams, and repositories - type: object - properties: - login: - description: Unique login name of the organization - type: string - examples: - - new-org - url: - description: URL for the organization - type: string - format: uri - examples: - - https://api.github.com/orgs/github - id: - type: integer - node_id: - type: string - repos_url: - type: string - format: uri - events_url: - type: string - format: uri - hooks_url: - type: string - issues_url: - type: string - members_url: - type: string - public_members_url: - type: string - avatar_url: - type: string - description: - type: - - string - - 'null' - blog: - description: Display blog url for the organization - type: string - format: uri - examples: - - blog.example-org.com - html_url: - type: string - format: uri - name: - description: Display name for the organization - type: string - examples: - - New Org - company: - description: Display company name for the organization - type: string - examples: - - Acme corporation - location: - description: Display location for the organization - type: string - examples: - - Berlin, Germany - email: - description: Display email for the organization - type: string - format: email - examples: - - org@example.com - has_organization_projects: - description: Specifies if organization projects are enabled for this org - type: boolean - has_repository_projects: - description: Specifies if repository projects are enabled for repositories - that belong to this org - type: boolean - is_verified: - type: boolean - public_repos: - type: integer - public_gists: - type: integer - followers: - type: integer - following: - type: integer - type: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - plan: - type: object - properties: - name: - type: string - space: - type: integer - private_repos: - type: integer - filled_seats: - type: integer - seats: - type: integer - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - - html_url - - has_organization_projects - - has_repository_projects - - public_repos - - public_gists - - followers - - following - - type - - created_at - - updated_at organization-simple: title: Organization Simple description: A GitHub organization. @@ -66936,6 +67321,160 @@ components: - public_members_url - avatar_url - description + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -66996,8 +67535,6 @@ components: additionalProperties: true oneOf: - "$ref": "#/components/schemas/simple-user" - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/organization" organization: type: - object @@ -67258,6 +67795,8 @@ components: - score - vector_string additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. @@ -67870,7 +68409,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. @@ -69483,12 +70022,24 @@ components: type: string examples: - 192.0.2.1 + codespaces: + type: array + items: + type: string + examples: + - 192.0.2.1 dependabot: type: array items: type: string examples: - 192.0.2.1 + copilot: + type: array + items: + type: string + examples: + - 192.0.2.1 domains: type: object properties: @@ -69522,6 +70073,19 @@ components: type: string examples: - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + examples: + - example + services: + type: array + items: + type: string + examples: + - example.com required: - verifiable_password_authentication security-and-analysis: @@ -70878,6 +71442,9 @@ components: description: type: string description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. tags: type: - array @@ -70885,6 +71452,17 @@ components: description: A set of tags applicable for the rule. items: type: string + help: + type: + - string + - 'null' + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + type: + - string + - 'null' + description: A link to the documentation for the rule used to detect the + alert. code-scanning-analysis-tool-version: type: - string @@ -71059,6 +71637,21 @@ components: - enabled - disabled - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -71101,6 +71694,13 @@ components: - enabled - disabled - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -72645,7 +73245,7 @@ components: - columns_url - created_at - updated_at - org-custom-property: + custom-property: title: Organization Custom Property description: Custom property defined on an organization type: object @@ -72653,6 +73253,11 @@ components: property_name: type: string description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete info about + this property via the API. value_type: type: string enum: @@ -73360,12 +73965,10 @@ components: type: - integer - 'null' - description: 'The ID of the actor that can bypass a ruleset. If `actor_type` + description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - - ' actor_type: type: string enum: @@ -73374,16 +73977,12 @@ components: - RepositoryRole - Team - DeployKey - description: 'The type of actor that can bypass a ruleset. - - ' + description: The type of actor that can bypass a ruleset. bypass_mode: type: string - description: 'When the specified actor can bypass the ruleset. `pull_request` + description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - - ' enum: - always - pull_request @@ -73498,11 +74097,9 @@ components: org-ruleset-conditions: title: Organization ruleset conditions type: object - description: 'Conditions for an organization ruleset. The conditions object - should contain both `repository_name` and `ref_name` properties or both `repository_id` + description: Conditions for an organization ruleset. The conditions object should + contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - - ' oneOf: - type: object title: repository_name_and_ref_name @@ -74089,11 +74686,8 @@ components: - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - title: file_path_restriction - description: |- - > [!NOTE] - > `file_path_restriction` is in beta and subject to change. - - Prevent commits that include changes in specified file paths from being pushed to the commit graph. + description: Prevent commits that include changes in specified file paths + from being pushed to the commit graph. type: object required: - type @@ -74114,11 +74708,8 @@ components: required: - restricted_file_paths - title: max_file_path_length - description: |- - > [!NOTE] - > `max_file_path_length` is in beta and subject to change. - - Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. + description: Prevent commits that include file paths that exceed a specified + character limit from being pushed to the commit graph. type: object required: - type @@ -74138,11 +74729,8 @@ components: required: - max_file_path_length - title: file_extension_restriction - description: |- - > [!NOTE] - > `file_extension_restriction` is in beta and subject to change. - - Prevent commits that include files with specified file extensions from being pushed to the commit graph. + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. type: object required: - type @@ -74163,11 +74751,8 @@ components: required: - restricted_file_extensions - title: max_file_size - description: |- - > [!NOTE] - > `max_file_size` is in beta and subject to change. - - Prevent commits that exceed a specified file size limit from being pushed to the commit. + description: Prevent commits that exceed a specified file size limit from + being pushed to the commit. type: object required: - type @@ -74207,11 +74792,7 @@ components: description: The name of the ruleset target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -74324,6 +74905,7 @@ components: enum: - pass - fail + - bypass description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. @@ -74374,13 +74956,18 @@ components: description: The result of the rule evaluations for rules with the `active` enforcement status. evaluation_result: - type: string + type: + - string + - 'null' enum: - pass - fail + - bypass + - description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would - pass or fail if all rules in the rule suite were `active`. + pass or fail if all rules in the rule suite were `active`. Null if no + rules with `evaluate` enforcement status were run. rule_evaluations: type: array description: Details on the evaluated rules. @@ -74420,8 +75007,11 @@ components: type: string description: The type of rule. details: - type: string - description: Any associated details with the rule evaluation. + type: + - string + - 'null' + description: The detailed failure message for the rule. Null if the + rule passed. repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -74651,6 +75241,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: - array @@ -77940,6 +78532,8 @@ components: - false name: type: string + client_id: + type: string description: type: string external_url: @@ -78676,6 +79270,7 @@ components: id: description: The id of the check. type: integer + format: int64 examples: - 21 head_sha: @@ -79125,7 +79720,7 @@ components: description: A short description of the rule used to detect the alert. full_description: type: string - description: description of the rule used to detect the alert. + description: A description of the rule used to detect the alert. tags: type: - array @@ -79736,6 +80331,26 @@ components: type: string description: Any errors that ocurred during processing of the delivery. readOnly: true + code-security-configuration-for-repository: + type: object + description: Code security configuration associated with a repository and attachment + status + properties: + status: + type: string + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + configuration: + "$ref": "#/components/schemas/code-security-configuration" codeowners-errors: title: CODEOWNERS errors description: A list of errors found in a repo's CODEOWNERS file @@ -81276,6 +81891,35 @@ components: type: - string - 'null' + secret-scanning-push-protection-bypass-placeholder-id: + description: The ID of the push protection bypass placeholder. This value is + returned on any push protected routes. + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + token_type: + type: string contributor: title: Contributor description: Contributor @@ -87032,7 +87676,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. @@ -87361,6 +88005,27 @@ components: - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + secret-scanning-push-protection-bypass-reason: + description: The reason for bypassing push protection. + type: string + enum: + - false_positive + - used_in_tests + - will_fix_later + secret-scanning-push-protection-bypass: + type: object + properties: + reason: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + expire_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + token_type: + type: string + description: The token type this bypass is for. repository-advisory-create: type: object properties: @@ -94986,10 +95651,8 @@ components: merge-group: type: object title: Merge Group - description: 'A group of pull requests that the merge queue has grouped together + description: A group of pull requests that the merge queue has grouped together to be merged. - - ' properties: head_sha: description: The SHA of the merge group. @@ -99501,7 +100164,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." validity: type: string description: The token status as of the latest validity check. @@ -99542,6 +100205,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array items: @@ -100503,6 +101168,11 @@ components: type: - integer - 'null' + client_id: + description: The client ID of the GitHub app + type: + - string + - 'null' name: description: The name of the GitHub app type: string @@ -101116,6 +101786,11 @@ components: type: - integer - 'null' + client_id: + description: Client ID of the GitHub app + type: + - string + - 'null' name: description: The name of the GitHub app type: string @@ -101722,6 +102397,11 @@ components: type: - integer - 'null' + client_id: + description: The Client ID for the GitHub app + type: + - string + - 'null' name: description: The name of the GitHub app type: string @@ -103897,7 +104577,7 @@ components: enum: - created definition: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -103945,7 +104625,7 @@ components: enum: - updated definition: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -188732,6 +189412,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array items: @@ -189482,6 +190164,146 @@ components: - updated_at - repository - sender + webhook-sub-issues-parent-issue-added: + title: parent issue added event + type: object + properties: + action: + type: string + enum: + - parent_issue_added + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + parent_issue_repo: + "$ref": "#/components/schemas/repository" + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - parent_issue_id + - parent_issue + - parent_issue_repo + - sub_issue_id + - sub_issue + webhook-sub-issues-parent-issue-removed: + title: parent issue removed event + type: object + properties: + action: + type: string + enum: + - parent_issue_removed + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + parent_issue_repo: + "$ref": "#/components/schemas/repository" + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - parent_issue_id + - parent_issue + - parent_issue_repo + - sub_issue_id + - sub_issue + webhook-sub-issues-sub-issue-added: + title: sub-issue added event + type: object + properties: + action: + type: string + enum: + - sub_issue_added + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + sub_issue_repo: + "$ref": "#/components/schemas/repository" + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - sub_issue_id + - sub_issue + - sub_issue_repo + - parent_issue_id + - parent_issue + webhook-sub-issues-sub-issue-removed: + title: sub-issue removed event + type: object + properties: + action: + type: string + enum: + - sub_issue_removed + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + sub_issue_repo: + "$ref": "#/components/schemas/repository" + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - sub_issue_id + - sub_issue + - sub_issue_repo + - parent_issue_id + - parent_issue webhook-team-add: title: team_add event type: object @@ -193130,6 +193952,7 @@ components: - stale - success - timed_out + - startup_failure - created_at: type: string @@ -195906,9 +196729,19 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption + epss: + - percentage: 0.00045 + percentile: 0.16001e0 credits: - user: login: octocat @@ -195965,6 +196798,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption @@ -195993,6 +196833,7 @@ components: value: id: 1 slug: octoapp + client_id: Iv1.ab1112223334445c node_id: MDExOkludGVncmF0aW9uMQ== owner: login: octocat @@ -198778,6 +199619,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -198938,6 +199786,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -199237,6 +200092,70 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + copilot-usage-metrics-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 public-events-items: value: - id: '22249084947' @@ -200371,6 +201290,8 @@ components: - 192.0.2.1 dependabot: - 192.0.2.1 + copilot: + - 192.0.2.1 domains: website: - "*.example.com" @@ -201472,13 +202393,18 @@ components: scanning. advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view created_at: '2023-12-04T15:58:07Z' @@ -201490,13 +202416,18 @@ components: repositories advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: enabled code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 created_at: '2024-05-10T00:00:00Z' @@ -201509,12 +202440,16 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -201531,13 +202466,18 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' @@ -201551,6 +202491,9 @@ components: scanning. advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled @@ -201558,6 +202501,7 @@ components: secret_scanning_push_protection: enabled secret_scanning_validity_checks: disabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view created_at: '2023-12-04T15:58:07Z' @@ -201570,13 +202514,18 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' @@ -202091,70 +203040,6 @@ components: inactive_this_cycle: 11 seat_management_setting: assign_selected public_code_suggestions: block - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -202399,6 +203284,7 @@ components: repositories_url: https://api.github.com/installation/repositories html_url: https://github.com/organizations/github/settings/installations/1 app_id: 1 + client_id: Iv1.ab1112223334445c target_id: 1 target_type: Organization permissions: @@ -203580,9 +204466,10 @@ components: site_admin: false created_at: '2011-04-11T20:09:31Z' updated_at: '2014-03-04T18:58:10Z' - org-custom-properties: + custom-properties: value: - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment value_type: single_select required: true default_value: production @@ -203592,13 +204479,16 @@ components: - development values_editable_by: org_actors - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service value_type: string - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team value_type: string description: Team owning the repository - org-custom-property: + custom-property: value: property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment value_type: single_select required: true default_value: production @@ -204321,6 +205211,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-123 name: A CWE @@ -204461,6 +205358,13 @@ components: cvss: vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N score: 1.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + 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: 7.1 cwes: - cwe_id: CWE-456 name: A CWE 2.0 @@ -209059,6 +209963,32 @@ components: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 + code-security-configuration-for-repository: + value: + state: attached + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' codeowners-errors: value: errors: @@ -211169,6 +212099,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -211264,6 +212201,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -211341,6 +212285,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -211413,6 +212364,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -216378,6 +217336,11 @@ components: - type: pull_request_review_comment details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + secret-scanning-push-protection-bypass: + value: + reason: will_fix_later + expire_at: '2020-11-06T18:18:30Z' + token_type: mailchimp_api_key repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -216455,6 +217418,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-123 name: A CWE @@ -216634,6 +217604,9 @@ components: vulnerable_functions: - important_function cvss: + cvss_severities: + cvss_v3: + cvss_v4: cwes: - cwe_id: CWE-123 name: A CWE @@ -222507,7 +223480,7 @@ components: in: query description: |- A comma-separated list of secret types to return. By default all secret types are returned. - See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -222542,6 +223515,13 @@ components: required: false schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -222556,6 +223536,7 @@ components: required: true schema: type: integer + format: int64 labels: name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' @@ -222766,13 +223747,6 @@ components: required: true schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string role-id: name: role_id description: The unique identifier of the role. @@ -222903,12 +223877,10 @@ components: type: string ref-in-query: name: ref - description: 'The name of the ref. Cannot contain wildcard characters. Optionally + description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - - ' in: query schema: type: string diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 46b9662bd..5657f019a 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ post: operations["repos/create-attestation"]; delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/codeowners/errors": { parameters: { query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -17305,6 +17431,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: string[] | null; }; + "cvss-severities": { + cvss_v3: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + cvss_v4: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export interface components { repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name: string; - space: number; - private_repos: number; - filled_seats: number; - seats: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name: string; /** @description The secret that was detected. */ secret: string; @@ -20025,6 +20092,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export interface components { * "192.0.2.1" * ] */ actions_macos?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + codespaces?: string[]; /** @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + copilot?: string[]; domains?: { website: string[]; codespaces: string[]; copilot: string[]; packages: string[]; actions: string[]; + artifact_attestations: { + /** @example [ + * "example" + * ] */ + trust_domain: string; + services: string[]; + }; }; }; "security-and-analysis": { @@ -21686,8 +21768,14 @@ export interface components { security_severity_level: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description: string; + /** @description A description of the rule used to detect the alert. */ + full_description: string; /** @description A set of tags applicable for the rule. */ tags: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export interface components { * @enum {string} */ dependency_graph: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export interface components { * @enum {string} */ secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result: "pass" | "fail"; + evaluation_result: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export interface components { */ result: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result: "pass" | "fail"; + evaluation_result: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations: { rule_source: { @@ -24354,8 +24455,8 @@ export interface components { result: "pass" | "fail"; /** @description The type of rule. */ rule_type: string; - /** @description Any associated details with the rule evaluation. */ - details: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; @@ -26417,6 +26519,7 @@ export interface components { site_admin: boolean; }; name: string; + client_id: string; description: string; external_url: string; html_url: string; @@ -26820,6 +26923,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export interface components { security_severity_level: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description: string; /** @description A set of tags applicable for the rule. */ tags: string[] | null; @@ -27382,6 +27486,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors: string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message: string; + documentation_url: string; + status: string; + metadata: { + secret_scanning: { + bypass_placeholders: { + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name: string; /** @description The secret that was detected. */ secret: string; @@ -31600,6 +31729,21 @@ export interface components { type: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at: string | null; + /** @description The token type this bypass is for. */ + token_type: string; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -35372,7 +35516,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -38649,6 +38793,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -38890,6 +39036,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39131,6 +39279,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -40132,7 +40282,7 @@ export interface components { "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export interface components { "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -81847,6 +81998,70 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ created_at: string; event: string; @@ -85137,7 +85352,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; @@ -85476,6 +85690,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + epss_percentile?: 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 results before this cursor. 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)." */ before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85485,7 +85705,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; header?: never; path?: never; @@ -86460,7 +86680,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86501,6 +86721,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "activity/list-public-events": { parameters: { query?: { @@ -89660,6 +89918,20 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -89696,6 +89968,12 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89853,6 +90131,16 @@ export interface operations { * @enum {string} */ dependency_graph: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -89883,6 +90171,11 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93466,7 +93759,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93487,7 +93780,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -93498,7 +93791,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93525,7 +93818,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93572,7 +93865,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93903,7 +94196,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -93920,7 +94215,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94007,9 +94304,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94039,8 +94334,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94156,9 +94450,6 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target: "branch" | "tag" | "push"; @@ -94216,7 +94507,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94435,6 +94726,44 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "teams/list": { parameters: { query?: { @@ -96628,7 +96957,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns: { /** @description Can be `enabled` or `disabled`. */ status: string; @@ -96693,7 +97022,9 @@ export interface operations { */ use_squash_pr_title_as_default: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -96710,7 +97041,9 @@ export interface operations { */ squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99467,7 +99800,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -99937,7 +100269,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101724,6 +102055,35 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "repos/codeowners-errors": { parameters: { query?: { @@ -103115,7 +103475,15 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -104926,7 +105294,15 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; "git/get-blob": { @@ -110049,6 +110425,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -110764,9 +111141,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -110796,8 +111171,7 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -110922,9 +111296,6 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target: "branch" | "tag" | "push"; @@ -110984,7 +111355,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111168,6 +111539,60 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -116165,7 +116590,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116182,7 +116609,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index 8d14aba18..6b7911c8b 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ post: operations["repos/create-attestation"]; delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/codeowners/errors": { parameters: { query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -17305,6 +17431,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export interface components { repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -20025,6 +20092,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export interface components { * "192.0.2.1" * ] */ actions_macos?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + codespaces?: string[]; /** @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + artifact_attestations?: { + /** @example [ + * "example" + * ] */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -21686,8 +21768,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export interface components { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export interface components { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -24354,8 +24455,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; @@ -26417,6 +26519,7 @@ export interface components { site_admin?: boolean; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -26820,6 +26923,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -27382,6 +27486,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -31600,6 +31729,21 @@ export interface components { type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -35372,7 +35516,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -38649,6 +38793,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -38890,6 +39036,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39131,6 +39279,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -40132,7 +40282,7 @@ export interface components { "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export interface components { "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -81847,6 +81998,70 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ created_at: string; event: string; @@ -85137,7 +85352,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; @@ -85421,6 +85635,7 @@ export interface components { 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 SchemaSimpleUser = components['schemas']['simple-user']; export type SchemaSecurityAdvisoryCreditTypes = components['schemas']['security-advisory-credit-types']; export type SchemaGlobalAdvisory = components['schemas']['global-advisory']; @@ -85456,10 +85671,9 @@ export type SchemaSimpleClassroomAssignment = components['schemas']['simple-clas export type SchemaClassroomAcceptedAssignment = components['schemas']['classroom-accepted-assignment']; export type SchemaClassroomAssignmentGrade = components['schemas']['classroom-assignment-grade']; export type SchemaCodeOfConduct = components['schemas']['code-of-conduct']; +export type SchemaOrganizationSimple = components['schemas']['organization-simple']; export type SchemaNullableTeamSimple = components['schemas']['nullable-team-simple']; export type SchemaTeam = components['schemas']['team']; -export type SchemaOrganization = components['schemas']['organization']; -export type SchemaOrganizationSimple = components['schemas']['organization-simple']; export type SchemaEnterpriseTeam = components['schemas']['enterprise-team']; export type SchemaCopilotSeatDetails = components['schemas']['copilot-seat-details']; export type SchemaCopilotUsageMetrics = components['schemas']['copilot-usage-metrics']; @@ -85575,7 +85789,7 @@ export type SchemaPackageVersion = components['schemas']['package-version']; export type SchemaOrganizationProgrammaticAccessGrantRequest = components['schemas']['organization-programmatic-access-grant-request']; export type SchemaOrganizationProgrammaticAccessGrant = components['schemas']['organization-programmatic-access-grant']; export type SchemaProject = components['schemas']['project']; -export type SchemaOrgCustomProperty = components['schemas']['org-custom-property']; +export type SchemaCustomProperty = components['schemas']['custom-property']; export type SchemaCustomPropertyValue = components['schemas']['custom-property-value']; export type SchemaOrgRepoCustomPropertyValues = components['schemas']['org-repo-custom-property-values']; export type SchemaNullableRepository = components['schemas']['nullable-repository']; @@ -85702,6 +85916,7 @@ export type SchemaCodeScanningRefFull = components['schemas']['code-scanning-ref export type SchemaCodeScanningAnalysisSarifFile = components['schemas']['code-scanning-analysis-sarif-file']; export type SchemaCodeScanningSarifsReceipt = components['schemas']['code-scanning-sarifs-receipt']; export type SchemaCodeScanningSarifsStatus = components['schemas']['code-scanning-sarifs-status']; +export type SchemaCodeSecurityConfigurationForRepository = components['schemas']['code-security-configuration-for-repository']; export type SchemaCodeownersErrors = components['schemas']['codeowners-errors']; export type SchemaCodespaceMachine = components['schemas']['codespace-machine']; export type SchemaCodespacesPermissionsCheckForDevcontainer = components['schemas']['codespaces-permissions-check-for-devcontainer']; @@ -85728,6 +85943,8 @@ export type SchemaContentFile = components['schemas']['content-file']; export type SchemaContentSymlink = components['schemas']['content-symlink']; export type SchemaContentSubmodule = components['schemas']['content-submodule']; export type SchemaFileCommit = components['schemas']['file-commit']; +export type SchemaSecretScanningPushProtectionBypassPlaceholderId = components['schemas']['secret-scanning-push-protection-bypass-placeholder-id']; +export type SchemaRepositoryRuleViolationError = components['schemas']['repository-rule-violation-error']; export type SchemaContributor = components['schemas']['contributor']; export type SchemaDependabotAlert = components['schemas']['dependabot-alert']; export type SchemaDependabotSecret = components['schemas']['dependabot-secret']; @@ -85832,6 +86049,8 @@ export type SchemaSecretScanningLocationPullRequestComment = components['schemas export type SchemaSecretScanningLocationPullRequestReview = components['schemas']['secret-scanning-location-pull-request-review']; export type SchemaSecretScanningLocationPullRequestReviewComment = components['schemas']['secret-scanning-location-pull-request-review-comment']; export type SchemaSecretScanningLocation = components['schemas']['secret-scanning-location']; +export type SchemaSecretScanningPushProtectionBypassReason = components['schemas']['secret-scanning-push-protection-bypass-reason']; +export type SchemaSecretScanningPushProtectionBypass = components['schemas']['secret-scanning-push-protection-bypass']; export type SchemaRepositoryAdvisoryCreate = components['schemas']['repository-advisory-create']; export type SchemaPrivateVulnerabilityReportCreate = components['schemas']['private-vulnerability-report-create']; export type SchemaRepositoryAdvisoryUpdate = components['schemas']['repository-advisory-update']; @@ -86176,6 +86395,10 @@ export type SchemaWebhookSponsorshipTierChanged = components['schemas']['webhook export type SchemaWebhookStarCreated = components['schemas']['webhook-star-created']; export type SchemaWebhookStarDeleted = components['schemas']['webhook-star-deleted']; export type SchemaWebhookStatus = components['schemas']['webhook-status']; +export type SchemaWebhookSubIssuesParentIssueAdded = components['schemas']['webhook-sub-issues-parent-issue-added']; +export type SchemaWebhookSubIssuesParentIssueRemoved = components['schemas']['webhook-sub-issues-parent-issue-removed']; +export type SchemaWebhookSubIssuesSubIssueAdded = components['schemas']['webhook-sub-issues-sub-issue-added']; +export type SchemaWebhookSubIssuesSubIssueRemoved = components['schemas']['webhook-sub-issues-sub-issue-removed']; export type SchemaWebhookTeamAdd = components['schemas']['webhook-team-add']; export type SchemaWebhookTeamAddedToRepository = components['schemas']['webhook-team-added-to-repository']; export type SchemaWebhookTeamCreated = components['schemas']['webhook-team-created']; @@ -86246,6 +86469,7 @@ export type ParameterSecretScanningAlertSecretType = components['parameters']['s export type ParameterSecretScanningAlertResolution = components['parameters']['secret-scanning-alert-resolution']; export type ParameterSecretScanningAlertSort = components['parameters']['secret-scanning-alert-sort']; export type ParameterSecretScanningAlertValidity = components['parameters']['secret-scanning-alert-validity']; +export type ParameterTeamSlug = components['parameters']['team-slug']; export type ParameterGistId = components['parameters']['gist-id']; export type ParameterCommentId = components['parameters']['comment-id']; export type ParameterLabels = components['parameters']['labels']; @@ -86275,7 +86499,6 @@ export type ParameterInvitationId = components['parameters']['invitation-id']; export type ParameterCodespaceName = components['parameters']['codespace-name']; export type ParameterMigrationId = components['parameters']['migration-id']; export type ParameterRepoName = components['parameters']['repo-name']; -export type ParameterTeamSlug = components['parameters']['team-slug']; export type ParameterRoleId = components['parameters']['role-id']; export type ParameterPackageVisibility = components['parameters']['package-visibility']; export type ParameterPackageType = components['parameters']['package-type']; @@ -86428,6 +86651,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + epss_percentile?: 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 results before this cursor. 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)." */ before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -86437,7 +86666,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; header?: never; path?: never; @@ -87412,7 +87641,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -87453,6 +87682,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "activity/list-public-events": { parameters: { query?: { @@ -90612,6 +90879,20 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -90648,6 +90929,12 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -90805,6 +91092,16 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -90835,6 +91132,11 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -94418,7 +94720,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -94439,7 +94741,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -94450,7 +94752,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -94477,7 +94779,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -94524,7 +94826,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -94855,7 +95157,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -94872,7 +95176,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94959,9 +95265,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94991,8 +95295,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; @@ -95108,9 +95411,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -95168,7 +95468,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -95387,6 +95687,44 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "teams/list": { parameters: { query?: { @@ -97580,7 +97918,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ status?: string; @@ -97645,7 +97983,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -97662,7 +98002,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -100419,7 +100761,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -100889,7 +101230,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -102676,6 +103016,35 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "repos/codeowners-errors": { parameters: { query?: { @@ -104067,7 +104436,15 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -105878,7 +106255,15 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; "git/get-blob": { @@ -111001,6 +111386,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -111716,9 +112102,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -111748,8 +112132,7 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -111874,9 +112257,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -111936,7 +112316,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -112120,6 +112500,60 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -117117,7 +117551,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -117134,7 +117570,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 054f0d22d..9f2016e9e 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -649,7 +649,7 @@ export interface paths { * for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -718,6 +718,42 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -3037,7 +3073,7 @@ export interface paths { * across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + * 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. * @@ -4808,6 +4844,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -5002,6 +5041,42 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description > [!NOTE] + * > This endpoint is in beta 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. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -5620,7 +5695,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -7418,9 +7493,9 @@ export interface paths { * Create an attestation * @description Store an artifact attestation and associate it with a repository. * - * The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. * - * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ post: operations["repos/create-attestation"]; delete?: never; @@ -8619,6 +8694,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/codeowners/errors": { parameters: { query?: never; @@ -13282,6 +13381,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -13380,6 +13482,30 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -17305,6 +17431,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ readonly vulnerable_functions: string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + readonly score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + readonly score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -17463,12 +17603,17 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; 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"]; @@ -17583,6 +17728,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -17640,8 +17787,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -19141,6 +19286,45 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -19236,124 +19420,6 @@ export interface components { repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; - }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/repos - */ - repos_url: string; - /** - * Format: uri - * @example https://api.github.com/orgs/github/events - */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - }; /** * Enterprise Team * @description Group of enterprise owners and/or members @@ -19388,7 +19454,7 @@ export interface components { /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; - } & (components["schemas"]["simple-user"] | components["schemas"]["team"] | components["schemas"]["organization"]); + } & components["schemas"]["simple-user"]; /** @description The organization to which this seat belongs. */ organization?: components["schemas"]["organization-simple"] | null; /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ @@ -19511,6 +19577,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -19904,7 +19971,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -20025,6 +20092,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -20082,8 +20151,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -20869,16 +20936,31 @@ export interface components { * "192.0.2.1" * ] */ actions_macos?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + codespaces?: string[]; /** @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** @example [ + * "192.0.2.1" + * ] */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + artifact_attestations?: { + /** @example [ + * "example" + * ] */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -21686,8 +21768,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -21775,6 +21863,16 @@ export interface components { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -21805,6 +21903,11 @@ export interface components { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -23030,9 +23133,14 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; /** * @description The type of the value for the property * @example single_select @@ -23777,18 +23885,15 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - * */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -23859,7 +23964,6 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24219,9 +24323,6 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -24294,7 +24395,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -24328,10 +24429,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -24354,8 +24455,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -24462,6 +24563,7 @@ export interface components { /** @description The CVSS score. */ readonly score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; @@ -26417,6 +26519,7 @@ export interface components { site_admin?: boolean; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -26820,6 +26923,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -27051,7 +27155,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -27382,6 +27486,15 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ readonly errors?: string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -28279,6 +28392,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -31406,7 +31535,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -31600,6 +31729,21 @@ export interface components { type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -35372,7 +35516,6 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. - * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -38203,7 +38346,7 @@ export interface components { /** @description The type of secret that secret scanning detected. */ secret_type?: string; /** @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** * @description The token status as of the latest validity check. @@ -38225,6 +38368,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -38649,6 +38793,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -38890,6 +39036,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -39131,6 +39279,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -40132,7 +40282,7 @@ export interface components { "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -40155,7 +40305,7 @@ export interface components { "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -81529,6 +81679,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -81847,6 +81998,70 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83524,7 +83739,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ created_at: string; event: string; @@ -85137,7 +85352,7 @@ export interface components { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -85146,6 +85361,8 @@ export interface components { "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -85204,8 +85421,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -85235,8 +85450,7 @@ export interface components { "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; @@ -85476,6 +85690,12 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. */ + epss_percentage?: string; + /** @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ + epss_percentile?: 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 results before this cursor. 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)." */ before?: components["parameters"]["pagination-before"]; /** @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 results after this cursor. 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)." */ @@ -85485,7 +85705,7 @@ export interface operations { /** @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?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; header?: never; path?: never; @@ -86460,7 +86680,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -86501,6 +86721,44 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "activity/list-public-events": { parameters: { query?: { @@ -89660,6 +89918,20 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @default disabled @@ -89696,6 +89968,12 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89853,6 +90131,16 @@ export interface operations { * @enum {string} */ dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** * @description The enablement status of Dependabot alerts * @enum {string} @@ -89883,6 +90171,11 @@ export interface operations { * @enum {string} */ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93466,7 +93759,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93487,7 +93780,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -93498,7 +93791,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -93525,7 +93818,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93572,7 +93865,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -93903,7 +94196,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -93920,7 +94215,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -94007,9 +94304,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94039,8 +94334,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; @@ -94156,9 +94450,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -94216,7 +94507,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -94435,6 +94726,44 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-team": { + parameters: { + query?: { + /** @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. */ + since?: string; + /** @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. */ + until?: string; + /** @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"]; + /** @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)." */ + per_page?: number; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "teams/list": { parameters: { query?: { @@ -96628,7 +96957,7 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; - /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." */ + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ status?: string; @@ -96693,7 +97022,9 @@ export interface operations { */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -96710,7 +97041,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -99467,7 +99800,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -99937,7 +100269,6 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. - * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -101724,6 +102055,35 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "repos/codeowners-errors": { parameters: { query?: { @@ -103115,7 +103475,15 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -104926,7 +105294,15 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; "git/get-blob": { @@ -110049,6 +110425,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -110764,9 +111141,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -110796,8 +111171,7 @@ export interface operations { "repos/get-repo-rule-suites": { parameters: { query?: { - /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - * */ + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; /** @description The time period to filter by. * @@ -110922,9 +111296,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * > [!NOTE] - * > The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -110984,7 +111355,7 @@ export interface operations { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ @@ -111168,6 +111539,60 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -116165,7 +116590,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -116182,7 +116609,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 9ca7de218..3ba85e979 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -231,6 +231,20 @@ paths: in: query schema: type: string + - name: epss_percentage + in: query + description: |- + If specified, only return advisories that have an EPSS percentage score that matches the provided value. + The EPSS percentage represents the likelihood of a CVE being exploited. + schema: + type: string + - name: epss_percentile + in: query + description: |- + If specified, only return advisories that have an EPSS percentile score that matches the provided value. + The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + schema: + type: string - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/direction" @@ -252,6 +266,8 @@ paths: enum: - updated - published + - epss_percentage + - epss_percentile default: published responses: '200': @@ -1495,7 +1511,7 @@ paths: for all users across organizations with access to Copilot within your enterprise, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + 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. @@ -1668,6 +1684,85 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for an enterprise team + description: |- + > [!NOTE] + > This endpoint is in beta 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + + Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-org" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage "/events": get: summary: List public events @@ -6207,6 +6302,23 @@ paths: - disabled - not_set default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + default: false dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -6255,6 +6367,15 @@ paths: - disabled - not_set default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -6476,6 +6597,21 @@ paths: - enabled - disabled - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -6518,6 +6654,14 @@ paths: - enabled - disabled - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -7874,7 +8018,7 @@ paths: across an organization, 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 the prior 28 days. Usage metrics are processed once per day for the previous day, + 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. @@ -11627,10 +11771,10 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11667,7 +11811,7 @@ paths: type: array description: The array of custom properties to create or update. items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" minItems: 1 maxItems: 100 required: @@ -11698,10 +11842,10 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11732,10 +11876,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': @@ -11821,10 +11965,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" examples: default: - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" '403': "$ref": "#/components/responses/forbidden" '404': @@ -12285,6 +12429,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -12307,6 +12453,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -12429,15 +12577,12 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag - push + default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -12575,7 +12720,11 @@ paths: "/orgs/{org}/rulesets/{ruleset_id}": get: summary: Get an organization repository ruleset - description: Get a repository ruleset for an organization. + description: |- + Get a repository ruleset for an organization. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. tags: - repos operationId: repos/get-org-ruleset @@ -12644,11 +12793,7 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -13048,6 +13193,85 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for a team + description: |- + > [!NOTE] + > This endpoint is in beta 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" + - 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" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-org" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage "/orgs/{org}/teams": get: summary: List teams @@ -14705,7 +14929,7 @@ paths: The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. tags: - orgs operationId: orgs/enable-or-disable-security-product-on-all-org-repos @@ -15944,7 +16168,7 @@ paths: type: object description: Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. - For more information, see "[Secret scanning supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." + For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." properties: status: type: string @@ -16021,6 +16245,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -16043,6 +16269,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -19207,9 +19435,9 @@ paths: description: |- Store an artifact attestation and associate it with a repository. - The authenticated user must have write permission to the repository and, if using a fine-grained access token the `attestations:write` permission is required. + The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. - Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For amore information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). tags: - repos operationId: repos/create-attestation @@ -19739,7 +19967,7 @@ paths: have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained - control.\n" + control." items: type: string checks: @@ -20446,7 +20674,7 @@ paths: in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` - instead of `contexts` for more fine-grained control.\n" + instead of `contexts` for more fine-grained control." items: type: string checks: @@ -23585,6 +23813,47 @@ paths: githubCloudOnly: false category: code-scanning subcategory: code-scanning + "/repos/{owner}/{repo}/code-security-configuration": + get: + summary: Get the code security configuration associated with a repository + description: |- + Get the code security configuration that manages a repository's code security settings. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration-for-repository" + examples: + default: + "$ref": "#/components/examples/code-security-configuration-for-repository" + '204': + "$ref": "#/components/responses/no_content" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations "/repos/{owner}/{repo}/codeowners/errors": get: summary: List CODEOWNERS errors @@ -25781,7 +26050,13 @@ paths: '422': "$ref": "#/components/responses/validation_failed" '409': - "$ref": "#/components/responses/conflict" + description: Conflict + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/basic-error" + - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28265,7 +28540,13 @@ paths: '403': "$ref": "#/components/responses/forbidden" '422': - "$ref": "#/components/responses/validation_failed" + description: Validation failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/repository-rule-violation-error" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35914,6 +36195,8 @@ paths: examples: default: "$ref": "#/components/examples/content-file" + '304': + "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" '422': @@ -36896,15 +37179,12 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag - push + default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -37036,7 +37316,11 @@ paths: "/repos/{owner}/{repo}/rulesets/{ruleset_id}": get: summary: Get a repository ruleset - description: Get a ruleset for a repository. + description: |- + Get a ruleset for a repository. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. tags: - repos operationId: repos/get-repo-ruleset @@ -37115,11 +37399,7 @@ paths: description: The name of the ruleset. target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -37405,6 +37685,67 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": + post: + summary: Create a push protection bypass + description: |- + Creates a bypass for a previously push protected secret. + + The authenticated user must be the original author of the committed secret. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: secret-scanning/create-push-protection-bypass + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reason: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + placeholder_id: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + required: + - reason + - placeholder_id + examples: + default: + value: + reason: will_fix_later + placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + examples: + default: + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + '403': + description: User does not have enough permissions to perform this action. + '404': + description: Placeholder ID not found, or push protection is disabled on + this repository. + '422': + description: Bad request, input data missing or incorrect. + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning "/repos/{owner}/{repo}/security-advisories": get: summary: List repository security advisories @@ -42701,7 +43042,7 @@ paths: items: type: string example: username@example.com - minItems: 1 + minItems: 1 example: [] required: - emails @@ -42713,7 +43054,7 @@ paths: items: type: string example: username@example.com - minItems: 1 + minItems: 1 - type: string examples: default: @@ -42779,7 +43120,7 @@ paths: items: type: string example: username@example.com - minItems: 1 + minItems: 1 example: emails: - octocat@github.com @@ -42790,7 +43131,7 @@ paths: items: type: string example: username@example.com - minItems: 1 + minItems: 1 - type: string examples: default: @@ -44903,6 +45244,8 @@ paths: - PR_TITLE - COMMIT_OR_PR_TITLE description: |- + Required when using `squash_merge_commit_message`. + The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. @@ -44925,6 +45268,8 @@ paths: - PR_TITLE - MERGE_MESSAGE description: |- + Required when using `merge_commit_message`. + The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. @@ -49772,6 +50117,9 @@ x-webhooks: For activity relating to deployment creation, use the `deployment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + + > [!NOTE] + > A webhook event is not fired for deployment statuses with an `inactive` state. description: A new deployment status was created. operationId: deployment-status/created externalDocs: @@ -62481,18 +62829,18 @@ x-webhooks: - repository - organization - app - team-add: + sub-issues-parent-issue-added: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + This event occurs when there is activity relating to sub-issues. - For activity relating to teams, see the `teams` event. + For activity relating to issues more generally, use the `issues` event instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was added to an issue. + operationId: sub-issues/parent-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62534,7 +62882,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62542,22 +62890,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sub-issues supported-webhook-types: - repository - organization - app - team-added-to-repository: + sub-issues-parent-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A parent issue was removed from an issue. + operationId: sub-issues/parent-issue-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62599,7 +62948,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62607,22 +62956,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-created: + sub-issues-sub-issue-added: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was created. - operationId: team/created + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was added to an issue. + operationId: sub-issues/sub-issue-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues parameters: - name: User-Agent in: header @@ -62664,7 +63014,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62672,22 +63022,89 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sub-issues supported-webhook-types: + - repository - organization - - business - app - team-deleted: + sub-issues-sub-issue-removed: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when there is activity relating to sub-issues. + + For activity relating to issues more generally, use the `issues` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: A sub-issue was removed from an issue. + operationId: sub-issues/sub-issue-removed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + team-add: + post: + summary: |- + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -62729,7 +63146,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-add" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62737,20 +63154,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: team_add supported-webhook-types: + - repository - organization - - business - app - team-edited: + team-added-to-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + description: A team was granted access to a repository. + operationId: team/added-to-repository externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -62794,7 +63211,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-added-to-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62807,15 +63224,15 @@ x-webhooks: - organization - business - app - team-removed-from-repository: + team-created: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + description: A team was created. + operationId: team/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -62859,7 +63276,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62872,16 +63289,17 @@ x-webhooks: - organization - business - app - watch-started: + team-deleted: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team was deleted. + operationId: team/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -62923,7 +63341,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62931,22 +63349,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: team supported-webhook-types: - - repository - organization + - business - app - workflow-dispatch: + team-edited: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - - For activity relating to workflow runs, use the `workflow_run` event. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: workflow-dispatch + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name, description, or visibility of a team was changed. + operationId: team/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -62988,7 +63406,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62996,23 +63414,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_dispatch + subcategory: team supported-webhook-types: + - organization + - business - app - workflow-job-completed: + team-removed-from-repository: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run finished. This event occurs when a job - in a workflow is completed, regardless of whether the job was successful or - unsuccessful. - operationId: workflow-job/completed + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team's access to a repository was removed. + operationId: team/removed-from-repository externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -63054,7 +63471,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63062,24 +63479,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: team supported-webhook-types: - - business - - repository - organization + - business - app - workflow-job-in-progress: + watch-started: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run started processing on a runner. - operationId: workflow-job/in-progress + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone started watching the repository. + operationId: watch/started externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header @@ -63121,7 +63535,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-watch-started" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63129,24 +63543,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: watch supported-webhook-types: - - business - repository - organization - app - workflow-job-queued: + workflow-dispatch: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + For activity relating to workflow runs, use the `workflow_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created. - operationId: workflow-job/queued + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: workflow-dispatch externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -63188,7 +63600,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-workflow-dispatch" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63196,13 +63608,10 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: workflow_dispatch supported-webhook-types: - - business - - repository - - organization - app - workflow-job-waiting: + workflow-job-completed: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. @@ -63210,8 +63619,10 @@ x-webhooks: For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created and is waiting for approvals. - operationId: workflow-job/waiting + description: A job in a workflow run finished. This event occurs when a job + in a workflow is completed, regardless of whether the job was successful or + unsuccessful. + operationId: workflow-job/completed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job parameters: @@ -63255,7 +63666,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-waiting" + "$ref": "#/components/schemas/webhook-workflow-job-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63269,19 +63680,220 @@ x-webhooks: - repository - organization - app - workflow-run-completed: + workflow-job-in-progress: post: summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)" in the REST API documentation. + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - For activity relating to a job in a workflow run, use the `workflow_job` event. + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A workflow run finished. This event occurs when a workflow run - is completed, regardless of whether the workflow was successful or unsuccessful. - operationId: workflow-run/completed + description: A job in a workflow run started processing on a runner. + operationId: workflow-job/in-progress externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-queued: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run was created. + operationId: workflow-job/queued + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-workflow-job-queued" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-waiting: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run was created and is waiting for approvals. + operationId: workflow-job/waiting + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-workflow-job-waiting" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-run-completed: + post: + summary: |- + This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)" in the REST API documentation. + + For activity relating to a job in a workflow run, use the `workflow_job` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A workflow run finished. This event occurs when a workflow run + is completed, regardless of whether the workflow was successful or unsuccessful. + operationId: workflow-run/completed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run parameters: - name: User-Agent in: header @@ -63664,6 +64276,46 @@ components: - vulnerable_version_range - first_patched_version - vulnerable_functions + cvss-severities: + type: object + nullable: true + properties: + cvss_v3: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 3 vector string. + nullable: true + score: + type: number + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 4 vector string. + nullable: true + score: + type: number + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score simple-user: title: Simple User description: A GitHub user. @@ -63917,6 +64569,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array nullable: true @@ -63933,6 +64587,14 @@ 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. @@ -64117,6 +64779,9 @@ components: node_id: type: string example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' owner: "$ref": "#/components/schemas/nullable-simple-user" name: @@ -64174,9 +64839,6 @@ components: description: The number of installations associated with the GitHub app example: 5 type: integer - client_id: - type: string - example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' @@ -66189,6 +66851,64 @@ components: - html_url - key - name + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description nullable-team-simple: title: Team Simple description: Groups of organization members that gives permissions on specified @@ -66326,187 +67046,6 @@ components: - repositories_url - slug - parent - organization: - title: Organization - description: GitHub account for managing multiple users, teams, and repositories - type: object - properties: - login: - description: Unique login name of the organization - example: new-org - type: string - url: - description: URL for the organization - example: https://api.github.com/orgs/github - type: string - format: uri - id: - type: integer - node_id: - type: string - repos_url: - type: string - format: uri - events_url: - type: string - format: uri - hooks_url: - type: string - issues_url: - type: string - members_url: - type: string - public_members_url: - type: string - avatar_url: - type: string - description: - type: string - nullable: true - blog: - description: Display blog url for the organization - example: blog.example-org.com - type: string - format: uri - html_url: - type: string - format: uri - name: - description: Display name for the organization - example: New Org - type: string - company: - description: Display company name for the organization - example: Acme corporation - type: string - location: - description: Display location for the organization - example: Berlin, Germany - type: string - email: - description: Display email for the organization - example: org@example.com - type: string - format: email - has_organization_projects: - description: Specifies if organization projects are enabled for this org - type: boolean - has_repository_projects: - description: Specifies if repository projects are enabled for repositories - that belong to this org - type: boolean - is_verified: - type: boolean - public_repos: - type: integer - public_gists: - type: integer - followers: - type: integer - following: - type: integer - type: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - plan: - type: object - properties: - name: - type: string - space: - type: integer - private_repos: - type: integer - filled_seats: - type: integer - seats: - type: integer - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - - html_url - - has_organization_projects - - has_repository_projects - - public_repos - - public_gists - - followers - - following - - type - - created_at - - updated_at - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description enterprise-team: title: Enterprise Team description: Group of enterprise owners and/or members @@ -66563,8 +67102,6 @@ components: additionalProperties: true oneOf: - "$ref": "#/components/schemas/simple-user" - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/organization" organization: type: object description: The organization to which this seat belongs. @@ -66815,6 +67352,8 @@ components: - score - vector_string additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. @@ -67371,7 +67910,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. @@ -67533,6 +68072,9 @@ components: node_id: type: string example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' owner: "$ref": "#/components/schemas/nullable-simple-user" name: @@ -67590,9 +68132,6 @@ components: description: The number of installations associated with the GitHub app example: 5 type: integer - client_id: - type: string - example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' @@ -68965,12 +69504,24 @@ components: type: string example: - 192.0.2.1 + codespaces: + type: array + items: + type: string + example: + - 192.0.2.1 dependabot: type: array items: type: string example: - 192.0.2.1 + copilot: + type: array + items: + type: string + example: + - 192.0.2.1 domains: type: object properties: @@ -69004,6 +69555,19 @@ components: type: string example: - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + example: + - example + services: + type: array + items: + type: string + example: + - example.com required: - verifiable_password_authentication security-and-analysis: @@ -70192,12 +70756,24 @@ components: description: type: string description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. tags: nullable: true type: array description: A set of tags applicable for the rule. items: type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the + alert. code-scanning-analysis-tool-version: nullable: true type: string @@ -70367,6 +70943,21 @@ components: - enabled - disabled - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. dependabot_alerts: type: string description: The enablement status of Dependabot alerts @@ -70409,6 +71000,13 @@ components: - enabled - disabled - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -72191,7 +72789,7 @@ components: - columns_url - created_at - updated_at - org-custom-property: + custom-property: title: Organization Custom Property description: Custom property defined on an organization type: object @@ -72199,6 +72797,11 @@ components: property_name: type: string description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete info about + this property via the API. value_type: type: string example: single_select @@ -73266,12 +73869,10 @@ components: actor_id: type: integer nullable: true - description: 'The ID of the actor that can bypass a ruleset. If `actor_type` + description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - - ' actor_type: type: string enum: @@ -73280,16 +73881,12 @@ components: - RepositoryRole - Team - DeployKey - description: 'The type of actor that can bypass a ruleset. - - ' + description: The type of actor that can bypass a ruleset. bypass_mode: type: string - description: 'When the specified actor can bypass the ruleset. `pull_request` + description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - - ' enum: - always - pull_request @@ -73404,11 +74001,9 @@ components: org-ruleset-conditions: title: Organization ruleset conditions type: object - description: 'Conditions for an organization ruleset. The conditions object - should contain both `repository_name` and `ref_name` properties or both `repository_id` + description: Conditions for an organization ruleset. The conditions object should + contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - - ' oneOf: - type: object title: repository_name_and_ref_name @@ -73995,11 +74590,8 @@ components: - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - title: file_path_restriction - description: |- - > [!NOTE] - > `file_path_restriction` is in beta and subject to change. - - Prevent commits that include changes in specified file paths from being pushed to the commit graph. + description: Prevent commits that include changes in specified file paths + from being pushed to the commit graph. type: object required: - type @@ -74020,11 +74612,8 @@ components: required: - restricted_file_paths - title: max_file_path_length - description: |- - > [!NOTE] - > `max_file_path_length` is in beta and subject to change. - - Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. + description: Prevent commits that include file paths that exceed a specified + character limit from being pushed to the commit graph. type: object required: - type @@ -74044,11 +74633,8 @@ components: required: - max_file_path_length - title: file_extension_restriction - description: |- - > [!NOTE] - > `file_extension_restriction` is in beta and subject to change. - - Prevent commits that include files with specified file extensions from being pushed to the commit graph. + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. type: object required: - type @@ -74069,11 +74655,8 @@ components: required: - restricted_file_extensions - title: max_file_size - description: |- - > [!NOTE] - > `max_file_size` is in beta and subject to change. - - Prevent commits that exceed a specified file size limit from being pushed to the commit. + description: Prevent commits that exceed a specified file size limit from + being pushed to the commit. type: object required: - type @@ -74113,11 +74696,7 @@ components: description: The name of the ruleset target: type: string - description: |- - The target of the ruleset - - > [!NOTE] - > The `push` target is in beta and is subject to change. + description: The target of the ruleset enum: - branch - tag @@ -74227,6 +74806,7 @@ components: enum: - pass - fail + - bypass description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. @@ -74275,12 +74855,15 @@ components: enforcement status. evaluation_result: type: string + nullable: true enum: - pass - fail + - bypass description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would - pass or fail if all rules in the rule suite were `active`. + pass or fail if all rules in the rule suite were `active`. Null if no + rules with `evaluate` enforcement status were run. rule_evaluations: type: array description: Details on the evaluated rules. @@ -74319,7 +74902,9 @@ components: description: The type of rule. details: type: string - description: Any associated details with the rule evaluation. + nullable: true + description: The detailed failure message for the rule. Null if the + rule passed. repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -74528,6 +75113,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array nullable: true @@ -77390,6 +77977,8 @@ components: example: false name: type: string + client_id: + type: string description: type: string external_url: @@ -78062,6 +78651,7 @@ components: description: The id of the check. example: 21 type: integer + format: int64 head_sha: description: The SHA of the commit that is being checked. example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' @@ -78341,7 +78931,7 @@ components: - action_required - startup_failure - stale - - + - null nullable: true url: type: string @@ -78504,7 +79094,7 @@ components: description: A short description of the rule used to detect the alert. full_description: type: string - description: description of the rule used to detect the alert. + description: A description of the rule used to detect the alert. tags: nullable: true type: array @@ -79088,6 +79678,26 @@ components: description: Any errors that ocurred during processing of the delivery. readOnly: true nullable: true + code-security-configuration-for-repository: + type: object + description: Code security configuration associated with a repository and attachment + status + properties: + status: + type: string + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + configuration: + "$ref": "#/components/schemas/code-security-configuration" codeowners-errors: title: CODEOWNERS errors description: A list of errors found in a repo's CODEOWNERS file @@ -80657,6 +81267,35 @@ components: payload: type: string nullable: true + secret-scanning-push-protection-bypass-placeholder-id: + description: The ID of the push protection bypass placeholder. This value is + returned on any push protected routes. + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + token_type: + type: string contributor: title: Contributor description: Contributor @@ -86164,7 +86803,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." secret: type: string description: The secret that was detected. @@ -86468,6 +87107,26 @@ components: - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + secret-scanning-push-protection-bypass-reason: + description: The reason for bypassing push protection. + type: string + enum: + - false_positive + - used_in_tests + - will_fix_later + secret-scanning-push-protection-bypass: + type: object + properties: + reason: + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + expire_at: + type: string + format: date-time + description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + token_type: + type: string + description: The token type this bypass is for. repository-advisory-create: type: object properties: @@ -91337,7 +91996,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -92366,7 +93025,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -93584,10 +94243,8 @@ components: merge-group: type: object title: Merge Group - description: 'A group of pull requests that the merge queue has grouped together + description: A group of pull requests that the merge queue has grouped together to be merged. - - ' properties: head_sha: description: The SHA of the merge group. @@ -95356,7 +96013,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -97656,7 +98313,7 @@ components: enum: - LEFT - RIGHT - - + - null default: RIGHT subject_type: description: The level at which the comment is targeted, can be a diff line @@ -98690,7 +99347,7 @@ components: type: string description: |- User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." validity: type: string description: The token status as of the latest validity check. @@ -98726,6 +99383,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array items: @@ -99668,6 +100327,10 @@ components: description: Unique identifier of the GitHub app type: integer nullable: true + client_id: + description: The client ID of the GitHub app + type: string + nullable: true name: description: The name of the GitHub app type: string @@ -99958,7 +100621,7 @@ components: - timed_out - action_required - stale - - + - null - skipped - startup_failure created_at: @@ -100126,7 +100789,7 @@ components: - in_progress - completed - queued - - + - null - pending updated_at: type: string @@ -100267,6 +100930,10 @@ components: description: Unique identifier of the GitHub app type: integer nullable: true + client_id: + description: Client ID of the GitHub app + type: string + nullable: true name: description: The name of the GitHub app type: string @@ -100557,7 +101224,7 @@ components: - timed_out - action_required - stale - - + - null - skipped created_at: type: string @@ -100724,7 +101391,7 @@ components: - in_progress - completed - queued - - + - null updated_at: type: string format: date-time @@ -100859,6 +101526,10 @@ components: description: Unique identifier of the GitHub app type: integer nullable: true + client_id: + description: The Client ID for the GitHub app + type: string + nullable: true name: description: The name of the GitHub app type: string @@ -101149,7 +101820,7 @@ components: - timed_out - action_required - stale - - + - null created_at: type: string format: date-time @@ -101315,7 +101986,7 @@ components: - in_progress - completed - queued - - + - null updated_at: type: string format: date-time @@ -101453,7 +102124,7 @@ components: - false positive - won't fix - used in tests - - + - null html_url: description: The GitHub URL of the alert resource. type: string @@ -101540,7 +102211,7 @@ components: - note - warning - error - - + - null required: - id - severity @@ -101698,7 +102369,7 @@ components: - false positive - won't fix - used in tests - - + - null html_url: description: The GitHub URL of the alert resource. type: string @@ -101797,7 +102468,7 @@ components: - note - warning - error - - + - null tags: type: array nullable: true @@ -101997,7 +102668,7 @@ components: - note - warning - error - - + - null tags: type: array nullable: true @@ -102167,7 +102838,7 @@ components: - false positive - won't fix - used in tests - - + - null html_url: description: The GitHub URL of the alert resource. type: string @@ -102269,7 +102940,7 @@ components: - note - warning - error - - + - null tags: type: array nullable: true @@ -102465,7 +103136,7 @@ components: - note - warning - error - - + - null tags: type: array nullable: true @@ -102655,7 +103326,7 @@ components: - note - warning - error - - + - null required: - id - severity @@ -102958,7 +103629,7 @@ components: enum: - created definition: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -103006,7 +103677,7 @@ components: enum: - updated definition: - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -103897,7 +104568,7 @@ components: - timed_out - action_required - stale - - + - null created_at: type: string format: date-time @@ -104578,7 +105249,7 @@ components: - timed_out - action_required - stale - - + - null created_at: type: string format: date-time @@ -105232,7 +105903,7 @@ components: - timed_out - action_required - stale - - + - null created_at: type: string format: date-time @@ -105963,7 +106634,7 @@ components: - timed_out - action_required - stale - - + - null created_at: type: string format: date-time @@ -106508,7 +107179,7 @@ components: - action_required - stale - skipped - - + - null details_url: type: string format: uri @@ -107610,7 +108281,7 @@ components: - timed_out - action_required - stale - - + - null - startup_failure created_at: type: string @@ -109967,7 +110638,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -111121,7 +111792,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -112273,7 +112944,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -113454,7 +114125,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -114505,7 +115176,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -115437,7 +116108,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -116352,7 +117023,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -117272,7 +117943,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -118213,7 +118884,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -119127,7 +119798,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -120021,7 +120692,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -121375,7 +122046,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -122337,7 +123008,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -123231,7 +123902,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -124692,7 +125363,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -129706,7 +130377,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -131978,7 +132649,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -134247,7 +134918,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -136598,7 +137269,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -138928,7 +139599,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -141187,7 +141858,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -143459,7 +144130,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -145907,7 +146578,7 @@ components: enum: - LEFT - RIGHT - - + - null default: RIGHT subject_type: description: The level at which the comment is targeted, can be a diff @@ -146118,7 +146789,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -148282,7 +148953,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -150436,7 +151107,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -152589,7 +153260,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -154915,7 +155586,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -156970,7 +157641,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -159302,7 +159973,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -161687,7 +162358,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -164024,7 +164695,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -166382,7 +167053,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -168551,7 +169222,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -170677,7 +171348,7 @@ components: enum: - LEFT - RIGHT - - + - null default: RIGHT subject_type: description: The level at which the comment is targeted, can be @@ -170908,7 +171579,7 @@ components: - off-topic - too heated - spam - - + - null assignee: title: User type: object @@ -173019,7 +173690,7 @@ components: enum: - LEFT - RIGHT - - + - null default: RIGHT subject_type: description: The level at which the comment is targeted, can be @@ -173255,7 +173926,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -175519,7 +176190,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -177793,7 +178464,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -180055,7 +180726,7 @@ components: - off-topic - too heated - spam - - + - null additions: type: integer assignee: @@ -185521,6 +186192,8 @@ components: required: - vector_string - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" cwes: type: array items: @@ -186255,6 +186928,146 @@ components: - updated_at - repository - sender + webhook-sub-issues-parent-issue-added: + title: parent issue added event + type: object + properties: + action: + type: string + enum: + - parent_issue_added + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + parent_issue_repo: + "$ref": "#/components/schemas/repository" + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - parent_issue_id + - parent_issue + - parent_issue_repo + - sub_issue_id + - sub_issue + webhook-sub-issues-parent-issue-removed: + title: parent issue removed event + type: object + properties: + action: + type: string + enum: + - parent_issue_removed + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + parent_issue_repo: + "$ref": "#/components/schemas/repository" + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - parent_issue_id + - parent_issue + - parent_issue_repo + - sub_issue_id + - sub_issue + webhook-sub-issues-sub-issue-added: + title: sub-issue added event + type: object + properties: + action: + type: string + enum: + - sub_issue_added + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + sub_issue_repo: + "$ref": "#/components/schemas/repository" + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - sub_issue_id + - sub_issue + - sub_issue_repo + - parent_issue_id + - parent_issue + webhook-sub-issues-sub-issue-removed: + title: sub-issue removed event + type: object + properties: + action: + type: string + enum: + - sub_issue_removed + sub_issue_id: + description: The ID of the sub-issue. + type: number + sub_issue: + "$ref": "#/components/schemas/issue" + sub_issue_repo: + "$ref": "#/components/schemas/repository" + parent_issue_id: + description: The ID of the parent issue. + type: number + parent_issue: + "$ref": "#/components/schemas/issue" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - sub_issue_id + - sub_issue + - sub_issue_repo + - parent_issue_id + - parent_issue webhook-team-add: title: team_add event type: object @@ -188812,7 +189625,7 @@ components: enum: - success - failure - - + - null - skipped - cancelled - action_required @@ -188902,7 +189715,7 @@ components: - skipped - success - cancelled - - + - null name: type: string number: @@ -189068,7 +189881,7 @@ components: enum: - success - failure - - + - null - cancelled - neutral created_at: @@ -189153,7 +189966,7 @@ components: - failure - skipped - success - - + - null - cancelled name: type: string @@ -189411,7 +190224,7 @@ components: - skipped - success - cancelled - - + - null name: type: string number: @@ -189569,7 +190382,7 @@ components: - skipped - success - cancelled - - + - null name: type: string number: @@ -189776,6 +190589,7 @@ components: - stale - success - timed_out + - startup_failure created_at: type: string format: date-time @@ -191606,7 +192420,7 @@ components: - timed_out - action_required - stale - - + - null - skipped - startup_failure created_at: @@ -192498,9 +193312,19 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption + epss: + - percentage: 0.00045 + percentile: 0.16001e0 credits: - user: login: octocat @@ -192557,6 +193381,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-400 name: Uncontrolled Resource Consumption @@ -192585,6 +193416,7 @@ components: value: id: 1 slug: octoapp + client_id: Iv1.ab1112223334445c node_id: MDExOkludGVncmF0aW9uMQ== owner: login: octocat @@ -195370,6 +196202,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -195530,6 +196369,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -195829,6 +196675,70 @@ components: push_protection_bypassed_at: resolution_comment: validity: unknown + copilot-usage-metrics-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 public-events-items: value: - id: '22249084947' @@ -196963,6 +197873,8 @@ components: - 192.0.2.1 dependabot: - 192.0.2.1 + copilot: + - 192.0.2.1 domains: website: - "*.example.com" @@ -198064,13 +198976,18 @@ components: scanning. advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view created_at: '2023-12-04T15:58:07Z' @@ -198082,13 +198999,18 @@ components: repositories advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: enabled code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 created_at: '2024-05-10T00:00:00Z' @@ -198101,12 +199023,16 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled secret_scanning: enabled secret_scanning_push_protection: disabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -198123,13 +199049,18 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' @@ -198143,6 +199074,9 @@ components: scanning. advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled @@ -198150,6 +199084,7 @@ components: secret_scanning_push_protection: enabled secret_scanning_validity_checks: disabled private_vulnerability_reporting: enabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view created_at: '2023-12-04T15:58:07Z' @@ -198162,13 +199097,18 @@ components: description: This is a code security configuration for octo-org advanced_security: enabled dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled private_vulnerability_reporting: disabled + enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' @@ -198683,70 +199623,6 @@ components: inactive_this_cycle: 11 seat_management_setting: assign_selected public_code_suggestions: block - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -198991,6 +199867,7 @@ components: repositories_url: https://api.github.com/installation/repositories html_url: https://github.com/organizations/github/settings/installations/1 app_id: 1 + client_id: Iv1.ab1112223334445c target_id: 1 target_type: Organization permissions: @@ -200172,9 +201049,10 @@ components: site_admin: false created_at: '2011-04-11T20:09:31Z' updated_at: '2014-03-04T18:58:10Z' - org-custom-properties: + custom-properties: value: - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment value_type: single_select required: true default_value: production @@ -200184,13 +201062,16 @@ components: - development values_editable_by: org_actors - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service value_type: string - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team value_type: string description: Team owning the repository - org-custom-property: + custom-property: value: property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment value_type: single_select required: true default_value: production @@ -200913,6 +201794,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-123 name: A CWE @@ -201053,6 +201941,13 @@ components: cvss: vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N score: 1.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + 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: 7.1 cwes: - cwe_id: CWE-456 name: A CWE 2.0 @@ -205651,6 +206546,32 @@ components: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 + code-security-configuration-for-repository: + value: + state: attached + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' codeowners-errors: value: errors: @@ -207761,6 +208682,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -207856,6 +208784,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -207933,6 +208868,13 @@ components: cvss: vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + 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 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -208005,6 +208947,13 @@ components: cvss: vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + 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 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -212970,6 +213919,11 @@ components: - type: pull_request_review_comment details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + secret-scanning-push-protection-bypass: + value: + reason: will_fix_later + expire_at: '2020-11-06T18:18:30Z' + token_type: mailchimp_api_key repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -213047,6 +214001,13 @@ components: cvss: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 cwes: - cwe_id: CWE-123 name: A CWE @@ -213226,6 +214187,9 @@ components: vulnerable_functions: - important_function cvss: + cvss_severities: + cvss_v3: + cvss_v4: cwes: - cwe_id: CWE-123 name: A CWE @@ -219099,7 +220063,7 @@ components: in: query description: |- A comma-separated list of secret types to return. By default all secret types are returned. - See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -219134,6 +220098,13 @@ components: required: false schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -219148,6 +220119,7 @@ components: required: true schema: type: integer + format: int64 labels: name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' @@ -219358,13 +220330,6 @@ components: required: true schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string role-id: name: role_id description: The unique identifier of the role. @@ -219492,12 +220457,10 @@ components: type: string ref-in-query: name: ref - description: 'The name of the ref. Cannot contain wildcard characters. Optionally + description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - - ' in: query schema: type: string diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index e1f03ff19..8fd2077d5 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -106,7 +106,7 @@ export interface paths { * *

Test-mode accounts can be deleted at any time.

* - *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

+ *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

* *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ delete: operations["DeleteAccountsAccount"]; @@ -627,6 +627,92 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/billing/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists billing active and inactive alerts

*/ + get: operations["GetBillingAlerts"]; + put?: never; + /** @description

Creates a billing alert

*/ + post: operations["PostBillingAlerts"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a billing alert given an ID

*/ + get: operations["GetBillingAlertsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/activate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Reactivates this alert, allowing it to trigger again.

*/ + post: operations["PostBillingAlertsIdActivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Archives this alert, removing it from the list view and APIs. This is non-reversible.

*/ + post: operations["PostBillingAlertsIdArchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/alerts/{id}/deactivate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Deactivates this alert, preventing it from triggering.

*/ + post: operations["PostBillingAlertsIdDeactivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/billing/meter_event_adjustments": { parameters: { query?: never; @@ -2549,6 +2635,74 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoice_rendering_templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

List all templates, ordered by creation date, with the most recently created template appearing first.

*/ + get: operations["GetInvoiceRenderingTemplates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

*/ + get: operations["GetInvoiceRenderingTemplatesTemplate"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

*/ + post: operations["PostInvoiceRenderingTemplatesTemplateArchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_rendering_templates/{template}/unarchive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

*/ + post: operations["PostInvoiceRenderingTemplatesTemplateUnarchive"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoiceitems": { parameters: { query?: never; @@ -3548,7 +3702,10 @@ export interface paths { * return to the requires_confirmation state * after those actions are completed. Your server needs to then * explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt.

*/ + * attempt. + * There is a variable upper limit on how many times a PaymentIntent can be confirmed. + * After this limit is reached, any further calls to this endpoint will + * transition the PaymentIntent to the canceled state.

*/ post: operations["PostPaymentIntentsIntentConfirm"]; delete?: never; options?: never; @@ -4270,7 +4427,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ + /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ get: operations["GetQuotesQuotePdf"]; put?: never; post?: never; @@ -5164,6 +5321,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/tax/calculations/{calculation}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

*/ + get: operations["GetTaxCalculationsCalculation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/tax/calculations/{calculation}/line_items": { parameters: { query?: never; @@ -5880,6 +6054,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/settlements": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Allows the user to create an Issuing settlement.

*/ + post: operations["PostTestHelpersIssuingSettlements"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/transactions/create_force_capture": { parameters: { query?: never; @@ -7378,13 +7569,13 @@ export interface components { account_payments_settings: { /** @description The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. */ statement_descriptor?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only) */ + /** @description The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only) */ + /** @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_kanji?: string | null; - /** @description The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. */ + /** @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. */ + /** @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_prefix_kanji?: string | null; }; /** AccountPayoutSettings */ @@ -7430,7 +7621,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration"; + code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration" | "verification_supportability"; /** @description An informative message that indicates the error type and provides additional details about the error. */ reason: string; /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ @@ -8049,6 +8240,37 @@ export interface components { */ void_at?: number | null; }; + /** + * ThresholdsResourceAlert + * @description A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests. + */ + "billing.alert": { + /** + * @description Defines the type of the alert. + * @enum {string} + */ + alert_type: "usage_threshold"; + /** @description Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers). */ + filter?: components["schemas"]["thresholds_resource_alert_filter"] | null; + /** @description Unique identifier for the object. */ + id: string; + /** @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 String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.alert"; + /** + * @description Status of the alert. This can be active, inactive or archived. + * @enum {string|null} + */ + status?: "active" | "archived" | "inactive" | null; + /** @description Title of the alert. */ + title: string; + /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ + usage_threshold_config?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; + }; /** * BillingMeter * @description A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. @@ -8181,6 +8403,18 @@ export interface components { */ start_time: number; }; + /** BillingClocksResourceStatusDetailsAdvancingStatusDetails */ + billing_clocks_resource_status_details_advancing_status_details: { + /** + * Format: unix-time + * @description The `frozen_time` that the Test Clock is advancing towards. + */ + target_frozen_time: number; + }; + /** BillingClocksResourceStatusDetailsStatusDetails */ + billing_clocks_resource_status_details_status_details: { + advancing?: components["schemas"]["billing_clocks_resource_status_details_advancing_status_details"]; + }; /** billing_details */ billing_details: { /** @description Billing address. */ @@ -8393,11 +8627,11 @@ export interface components { address_zip_check?: string | null; /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ available_payout_methods?: ("instant" | "standard")[] | null; - /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ + /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; - /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ currency?: string | null; /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -8498,7 +8732,7 @@ export interface components { /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; billing_details: components["schemas"]["billing_details"]; - /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This only works for card payments. */ + /** @description The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. */ calculated_statement_descriptor?: string | null; /** @description If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ captured: boolean; @@ -8580,11 +8814,13 @@ export interface components { review?: (string | components["schemas"]["review"]) | null; /** @description Shipping information for the charge. */ shipping?: components["schemas"]["shipping"] | null; - /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ + /** @description The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ source_transfer?: (string | components["schemas"]["transfer"]) | null; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string | null; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string | null; /** * @description The status of the payment is either `succeeded`, `pending`, or `failed`. @@ -8779,7 +9015,7 @@ export interface components { /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ recovered_from?: string | null; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; @@ -8856,11 +9092,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -8875,11 +9111,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8889,11 +9125,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8903,11 +9139,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8917,11 +9153,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -8931,11 +9167,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8945,11 +9181,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -8959,11 +9195,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -8975,11 +9211,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9000,11 +9236,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9018,11 +9254,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9051,11 +9287,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9065,11 +9301,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9079,11 +9315,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9093,11 +9329,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9107,11 +9343,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9121,11 +9357,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9135,11 +9371,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9151,11 +9387,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9165,11 +9401,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9179,11 +9415,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9193,11 +9429,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9209,11 +9445,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9223,11 +9459,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9237,11 +9473,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9260,11 +9496,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9279,11 +9515,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -9293,11 +9529,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -9342,11 +9578,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -9362,11 +9598,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -10462,6 +10698,10 @@ export interface components { * CustomerSessionResourceCustomerSession * @description A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access * control over a Customer. + * + * Related guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), + * [Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session), + * [Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer). */ customer_session: { /** @description The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`. @@ -10530,7 +10770,7 @@ export interface components { * @enum {string} */ payment_method_redisplay: "disabled" | "enabled"; - /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `10`. */ + /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ payment_method_redisplay_limit?: number | null; /** * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. @@ -11158,6 +11398,7 @@ export interface components { }; /** DisputePaymentMethodDetails */ dispute_payment_method_details: { + amazon_pay?: components["schemas"]["dispute_payment_method_details_amazon_pay"]; card?: components["schemas"]["dispute_payment_method_details_card"]; klarna?: components["schemas"]["dispute_payment_method_details_klarna"]; paypal?: components["schemas"]["dispute_payment_method_details_paypal"]; @@ -11165,7 +11406,15 @@ export interface components { * @description Payment method type. * @enum {string} */ - type: "card" | "klarna" | "paypal"; + type: "amazon_pay" | "card" | "klarna" | "paypal"; + }; + /** DisputePaymentMethodDetailsAmazonPay */ + dispute_payment_method_details_amazon_pay: { + /** + * @description The AmazonPay dispute type, chargeback or claim + * @enum {string|null} + */ + dispute_type?: "chargeback" | "claim" | null; }; /** DisputePaymentMethodDetailsCard */ dispute_payment_method_details_card: { @@ -11487,7 +11736,7 @@ export interface components { * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ - purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @description The size of the file object in bytes. */ size: number; /** @description A suitable title for the document. */ @@ -12413,6 +12662,8 @@ export interface components { provided_details?: components["schemas"]["gelato_provided_details"] | null; /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ redaction?: components["schemas"]["verification_session_redaction"] | null; + /** @description Token referencing a Customer resource. */ + related_customer?: string | null; /** * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). * @enum {string} @@ -12542,6 +12793,11 @@ export interface components { /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ auto_advance?: boolean; automatic_tax: components["schemas"]["automatic_tax"]; + /** + * Format: unix-time + * @description The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. + */ + automatically_finalizes_at?: number | null; /** * @description Indicates the reason why the invoice was created. * @@ -12866,6 +13122,40 @@ export interface components { */ page_size?: "a4" | "auto" | "letter" | null; }; + /** + * InvoiceRenderingTemplate + * @description Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates + * can be created from within the Dashboard, and they can be used over the API when creating invoices. + */ + invoice_rendering_template: { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Unique identifier for the object. */ + id: string; + /** @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 A brief description of the template, hidden from customers */ + nickname?: string | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "invoice_rendering_template"; + /** + * @description The status of the template, one of `active` or `archived`. + * @enum {string} + */ + status: "active" | "archived"; + /** @description Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering */ + version: number; + }; /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ @@ -12877,6 +13167,8 @@ export interface components { invoice_setting_customer_rendering_options: { /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ amount_tax_display?: string | null; + /** @description ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. */ + template?: string | null; }; /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { @@ -13056,14 +13348,18 @@ export interface components { amount_tax_display?: string | null; /** @description Invoice pdf rendering options */ pdf?: components["schemas"]["invoice_rendering_pdf"] | null; + /** @description ID of the rendering template that the invoice is formatted by. */ + template?: string | null; + /** @description Version of the rendering template that the invoice is using. */ + template_version?: number | null; }; /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -13438,7 +13734,10 @@ export interface components { "issuing.settlement": { /** @description The Bank Identification Number reflecting this settlement record. */ bin: string; - /** @description The date that the transactions are cleared and posted to user's accounts. */ + /** + * Format: unix-time + * @description The date that the transactions are cleared and posted to user's accounts. + */ clearing_date: number; /** * Format: unix-time @@ -13460,10 +13759,10 @@ export interface components { /** @description The total net amount required to settle with the network. */ net_total: number; /** - * @description The card network for this settlement report. One of ["visa"] + * @description The card network for this settlement report. One of ["visa", "maestro"] * @enum {string} */ - network: "visa"; + network: "maestro" | "visa"; /** @description The total amount of fees owed to the network. */ network_fees: number; /** @description The Settlement Identification Number assigned by the network. */ @@ -13475,6 +13774,11 @@ export interface components { object: "issuing.settlement"; /** @description One of `international` or `uk_national_net`. */ settlement_service: string; + /** + * @description The current processing status of this settlement. + * @enum {string} + */ + status: "complete" | "pending"; /** @description The total number of transactions reflected in this settlement. */ transaction_count: number; /** @description The total transaction amount reflected in this settlement. */ @@ -13907,7 +14211,7 @@ export interface components { * @description The delivery status of the card. * @enum {string|null} */ - status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | null; + status?: "canceled" | "delivered" | "failure" | "pending" | "returned" | "shipped" | "submitted" | null; /** @description A tracking number for a card shipment. */ tracking_number?: string | null; /** @description A link to the shipping carrier's site where you can view detailed information about a card shipment. */ @@ -14531,7 +14835,7 @@ export interface components { /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description: string; + description?: string; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; /** @description Unique identifier for the object. */ @@ -14548,6 +14852,16 @@ export interface components { /** @description The taxes applied to the line item. */ taxes?: components["schemas"]["line_items_tax_amount"][]; }; + /** klarna_address */ + klarna_address: { + /** @description The payer address country */ + country?: string | null; + }; + /** klarna_payer_details */ + klarna_payer_details: { + /** @description The payer's address */ + address?: components["schemas"]["klarna_address"] | null; + }; /** LegalEntityCompany */ legal_entity_company: { address?: components["schemas"]["address"]; @@ -14665,7 +14979,12 @@ export interface components { /** @description The user-agent string from the browser where the beneficial owner attestation was made. */ user_agent?: string | null; }; - /** InvoiceLineItem */ + /** + * InvoiceLineItem + * @description Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice. + * + * Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items). + */ line_item: { /** @description The amount, in cents (or local equivalent). */ amount: number; @@ -14712,9 +15031,9 @@ export interface components { /** @description The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ subscription_item?: string | components["schemas"]["subscription_item"]; /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts?: components["schemas"]["invoice_tax_amount"][]; + tax_amounts: components["schemas"]["invoice_tax_amount"][]; /** @description The tax rates which apply to the line item. */ - tax_rates?: components["schemas"]["tax_rate"][]; + tax_rates: components["schemas"]["tax_rate"][]; /** * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. * @enum {string} @@ -15111,6 +15430,14 @@ export interface components { */ status: "available" | "unavailable"; }; + /** PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet */ + payment_flows_private_payment_methods_card_present_common_wallet: { + /** + * @description The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. + * @enum {string} + */ + type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"; + }; /** PaymentFlowsPrivatePaymentMethodsKlarnaDOB */ payment_flows_private_payment_methods_klarna_dob: { /** @description The day of birth, between 1 and 31. */ @@ -15190,7 +15517,7 @@ export interface components { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -15234,19 +15561,21 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; /** @description Shipping information for this PaymentIntent. */ shipping?: components["schemas"]["shipping"] | null; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string | null; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string | null; /** * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). @@ -15550,7 +15879,7 @@ export interface components { alipay?: components["schemas"]["payment_method_options_alipay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["payment_method_options_amazon_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; au_becs_debit?: components["schemas"]["payment_intent_payment_method_options_au_becs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; - bacs_debit?: components["schemas"]["payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + bacs_debit?: components["schemas"]["payment_intent_payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; bancontact?: components["schemas"]["payment_method_options_bancontact"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; blik?: components["schemas"]["payment_intent_payment_method_options_blik"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; boleto?: components["schemas"]["payment_method_options_boleto"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -15590,11 +15919,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15609,11 +15938,26 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. + * + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + * + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session" | "on_session"; + }; + /** payment_intent_payment_method_options_bacs_debit */ + payment_intent_payment_method_options_bacs_debit: { + mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_bacs_debit"]; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15623,11 +15967,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15649,7 +15993,7 @@ export interface components { * @description Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. * @enum {string} @@ -15680,11 +16024,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15698,11 +16042,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15717,11 +16061,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -15743,6 +16087,8 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; + /** payment_intent_payment_method_options_mandate_options_bacs_debit */ + payment_intent_payment_method_options_mandate_options_bacs_debit: Record; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ payment_intent_payment_method_options_mandate_options_sepa_debit: Record; /** payment_intent_payment_method_options_mobilepay */ @@ -15755,11 +16101,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15770,11 +16116,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15786,11 +16132,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -15807,11 +16153,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -15856,11 +16202,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -16134,9 +16480,9 @@ export interface components { * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; - /** @description Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. */ + /** @description For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. */ statement_descriptor?: string | null; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ statement_descriptor_suffix?: string | null; /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ transfer_group?: string | null; @@ -16194,6 +16540,8 @@ export interface components { payment_links_resource_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session. */ enabled: boolean; + /** @enum {string} */ + required: "if_supported" | "never"; }; /** PaymentLinksResourceTransferData */ payment_links_resource_transfer_data: { @@ -16406,6 +16754,8 @@ export interface components { last4?: string | null; /** @description Contains information about card networks that can be used to process the payment. */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; + /** @description Details about payment methods collected offline. */ + offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ preferred_locales?: string[] | null; /** @@ -16413,6 +16763,7 @@ export interface components { * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; + wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_card_present_networks */ payment_method_card_present_networks: { @@ -16753,6 +17104,8 @@ export interface components { payment_method_details_card: { /** @description The authorized amount. */ amount_authorized?: number | null; + /** @description Authorization code on the charge. */ + authorization_code?: string | null; /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; /** @@ -16871,10 +17224,7 @@ export interface components { last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. - * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. - * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). - * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; /** @description Details about payments collected offline. */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; @@ -16889,6 +17239,7 @@ export interface components { read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ receipt?: components["schemas"]["payment_method_details_card_present_receipt"] | null; + wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; }; /** payment_method_details_card_present_offline */ payment_method_details_card_present_offline: { @@ -16897,6 +17248,11 @@ export interface components { * @description Time at which the payment was collected while offline */ stored_at?: number | null; + /** + * @description The method used to process this payment method offline. Only deferred is allowed. + * @enum {string|null} + */ + type?: "deferred" | null; }; /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { @@ -17072,10 +17428,7 @@ export interface components { last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: string | null; - /** @description This is used by the financial networks to identify a transaction. - * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. - * The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). - * This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ network_transaction_id?: string | null; /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ preferred_locales?: string[] | null; @@ -17113,6 +17466,8 @@ export interface components { }; /** payment_method_details_klarna */ payment_method_details_klarna: { + /** @description The payer details for this transaction. */ + payer_details?: components["schemas"]["klarna_payer_details"] | null; /** @description The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` */ payment_method_category?: string | null; @@ -17438,11 +17793,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17460,11 +17815,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17474,11 +17829,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17493,29 +17848,15 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; }; - /** payment_method_options_bacs_debit */ - payment_method_options_bacs_debit: { - /** - * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. - * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. - * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. - * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). - * @enum {string} - */ - setup_future_usage?: "none" | "off_session" | "on_session"; - }; /** payment_method_options_bancontact */ payment_method_options_bancontact: { /** @@ -17526,11 +17867,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17542,11 +17883,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -17619,11 +17960,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -17639,11 +17980,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17674,11 +18015,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17688,11 +18029,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17702,11 +18043,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17716,11 +18057,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17739,11 +18080,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17764,11 +18105,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17778,11 +18119,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17794,11 +18135,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17808,11 +18149,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17822,11 +18163,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17845,11 +18186,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17863,11 +18204,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17877,11 +18218,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17896,11 +18237,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17915,11 +18256,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none" | "off_session"; @@ -17929,11 +18270,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17958,11 +18299,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -17972,11 +18313,11 @@ export interface components { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "none"; @@ -18340,10 +18681,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -18351,6 +18692,11 @@ export interface components { payment_pages_checkout_session_tax_id_collection: { /** @description Indicates whether tax ID collection is enabled for the session */ enabled: boolean; + /** + * @description Indicates whether a tax ID is required on the payment page + * @enum {string} + */ + required: "if_supported" | "never"; }; /** PaymentPagesCheckoutSessionTotalDetails */ payment_pages_checkout_session_total_details: { @@ -18561,7 +18907,8 @@ export interface components { }; /** PersonAdditionalTOSAcceptances */ person_additional_tos_acceptances: { - account: components["schemas"]["person_additional_tos_acceptance"]; + /** @description Details on the legal guardian's acceptance of the main Stripe service agreement. */ + account?: components["schemas"]["person_additional_tos_acceptance"] | null; }; /** PersonFutureRequirements */ person_future_requirements: { @@ -20198,7 +20545,7 @@ export interface components { object: "setup_intent"; /** @description The account (if any) for which the setup is intended. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ + /** @description ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ payment_method?: (string | components["schemas"]["payment_method"]) | null; /** @description Information about the payment method configuration used for this Setup Intent. */ payment_method_configuration_details?: components["schemas"]["payment_method_config_biz_payment_method_configuration_details"] | null; @@ -20254,6 +20601,7 @@ export interface components { setup_intent_payment_method_options: { acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; amazon_pay?: components["schemas"]["setup_intent_payment_method_options_amazon_pay"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; + bacs_debit?: components["schemas"]["setup_intent_payment_method_options_bacs_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["setup_intent_payment_method_options_card"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card_present?: components["schemas"]["setup_intent_payment_method_options_card_present"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; @@ -20277,6 +20625,10 @@ export interface components { }; /** setup_intent_payment_method_options_amazon_pay */ setup_intent_payment_method_options_amazon_pay: Record; + /** setup_intent_payment_method_options_bacs_debit */ + setup_intent_payment_method_options_bacs_debit: { + mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_bacs_debit"]; + }; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** @description Configuration options for setting up an eMandate for cards issued in India. */ @@ -20285,7 +20637,7 @@ export interface components { * @description Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -20350,6 +20702,8 @@ export interface components { */ transaction_type?: "business" | "personal" | null; }; + /** setup_intent_payment_method_options_mandate_options_bacs_debit */ + setup_intent_payment_method_options_mandate_options_bacs_debit: Record; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ setup_intent_payment_method_options_mandate_options_sepa_debit: Record; /** setup_intent_payment_method_options_paypal */ @@ -21208,7 +21562,7 @@ export interface components { * @description Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. * @enum {string|null} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa" | null; /** * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} @@ -21906,10 +22260,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -22039,6 +22393,7 @@ export interface components { local_lease_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_local_lease_tax"]; /** @description Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ state: string; + state_sales_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_state_sales_tax"]; /** * @description Type of registration in the US. * @enum {string} @@ -22055,6 +22410,21 @@ export interface components { /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ jurisdiction: string; }; + /** TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax */ + tax_product_registrations_resource_country_options_us_state_sales_tax: { + /** @description Elections for the state sales tax registration. */ + elections?: components["schemas"]["tax_product_registrations_resource_country_options_us_state_sales_tax_election"][]; + }; + /** TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection */ + tax_product_registrations_resource_country_options_us_state_sales_tax_election: { + /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + jurisdiction?: string; + /** + * @description The type of the election for the state sales tax registration. + * @enum {string} + */ + type: "local_use_tax" | "simplified_sellers_use_tax" | "single_local_use_tax"; + }; /** TaxProductResourceCustomerDetails */ tax_product_resource_customer_details: { /** @description The customer's postal address (for example, home or business location). */ @@ -22077,10 +22447,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value: string; }; @@ -22410,7 +22780,7 @@ export interface components { /** @description Serial number of the reader. */ serial_number: string; /** - * @description The networking status of the reader. + * @description The networking status of the reader. We do not recommend using this field in flows that may block taking payments. * @enum {string|null} */ status?: "offline" | "online" | null; @@ -22642,6 +23012,7 @@ export interface components { * @enum {string} */ status: "advancing" | "internal_failure" | "ready"; + status_details: components["schemas"]["billing_clocks_resource_status_details_status_details"]; }; /** three_d_secure_details */ three_d_secure_details: { @@ -22724,6 +23095,26 @@ export interface components { /** @description Whether 3D Secure is supported on this card. */ supported: boolean; }; + /** ThresholdsResourceAlertFilter */ + thresholds_resource_alert_filter: { + /** @description Limit the scope of the alert to this customer ID */ + customer?: (string | components["schemas"]["customer"]) | null; + }; + /** + * ThresholdsResourceUsageThresholdConfig + * @description The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. + */ + thresholds_resource_usage_threshold_config: { + /** @description The value at which this alert will trigger. */ + gte: number; + /** @description The [Billing Meter](/api/billing/meter) ID whose usage is monitored. */ + meter: string | components["schemas"]["billing.meter"]; + /** + * @description Defines how the alert will behave. + * @enum {string} + */ + recurrence: "one_time"; + }; /** * Token * @description Tokenization is the process Stripe uses to collect sensitive card or bank @@ -22894,7 +23285,7 @@ export interface components { }; /** @description Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ reversed: boolean; - /** @description ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. */ + /** @description ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. */ source_transaction?: (string | components["schemas"]["charge"]) | null; /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ source_type?: string; @@ -23090,7 +23481,7 @@ export interface components { */ "treasury.financial_account": { /** @description The array of paths to active Features in the Features hash. */ - active_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + active_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; balance: components["schemas"]["treasury_financial_accounts_resource_balance"]; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ country: string; @@ -23116,11 +23507,11 @@ export interface components { */ object: "treasury.financial_account"; /** @description The array of paths to pending Features in the Features hash. */ - pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + pending_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; /** @description The set of functionalities that the platform can restrict on the FinancialAccount. */ platform_restrictions?: components["schemas"]["treasury_financial_accounts_resource_platform_restrictions"] | null; /** @description The array of paths to restricted Features in the Features hash. */ - restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; + restricted_features?: ("card_issuing" | "deposit_insurance" | "financial_addresses.aba" | "financial_addresses.aba.forwarding" | "inbound_transfers.ach" | "intra_stripe_flows" | "outbound_payments.ach" | "outbound_payments.us_domestic_wire" | "outbound_transfers.ach" | "outbound_transfers.us_domestic_wire" | "remote_deposit_capture")[]; /** * @description The enum specifying what state the account is in. * @enum {string} @@ -23151,7 +23542,9 @@ export interface components { }; /** * TreasuryInboundTransfersResourceInboundTransfer - * @description Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + * @description Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + * + * Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) */ "treasury.inbound_transfer": { /** @description Amount (in cents) transferred. */ @@ -23206,9 +23599,11 @@ export interface components { }; /** * TreasuryOutboundPaymentsResourceOutboundPayment - * @description Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + * @description Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). * * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. + * + * Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) */ "treasury.outbound_payment": { /** @description Amount (in cents) transferred. */ @@ -23271,9 +23666,11 @@ export interface components { }; /** * TreasuryOutboundTransfersResourceOutboundTransfer - * @description Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + * @description Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. * * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. + * + * Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) */ "treasury.outbound_transfer": { /** @description Amount (in cents) transferred. */ @@ -23400,7 +23797,7 @@ export interface components { * @description Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. * @enum {string|null} */ - failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "other" | null; + failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "international_transaction" | "other" | null; /** @description The FinancialAccount that funds were pulled from. */ financial_account?: string | null; /** @description A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ @@ -23796,8 +24193,10 @@ export interface components { }; /** TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails */ treasury_outbound_payments_resource_us_domestic_wire_tracking_details: { + /** @description CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + chips?: string | null; /** @description IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ - imad: string; + imad?: string | null; /** @description OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ omad?: string | null; }; @@ -23851,8 +24250,10 @@ export interface components { }; /** TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails */ treasury_outbound_transfers_resource_us_domestic_wire_tracking_details: { + /** @description CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + chips?: string | null; /** @description IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ - imad: string; + imad?: string | null; /** @description OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ omad?: string | null; }; @@ -24193,7 +24594,7 @@ export interface operations { */ collection_options?: { /** @enum {string} */ - fields: "currently_due" | "eventually_due"; + fields?: "currently_due" | "eventually_due"; /** @enum {string} */ future_requirements?: "include" | "omit"; }; @@ -26426,7 +26827,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -26658,7 +27059,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -26949,7 +27350,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -27181,7 +27582,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * person_additional_tos_acceptances_specs - * @description Details on the legal guardian's acceptance of the required Stripe agreements. + * @description Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements. */ additional_tos_acceptances?: { /** settings_terms_of_service_specs */ @@ -28373,6 +28774,277 @@ export interface operations { }; }; }; + GetBillingAlerts: { + parameters: { + query?: { + /** @description Filter results to only include this type of alert. */ + alert_type?: "usage_threshold"; + /** @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; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description Filter results to only include alerts with the given meter. */ + meter?: string; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["billing.alert"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlerts: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * @description The type of alert to create. + * @enum {string} + */ + alert_type: "usage_threshold"; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * alert_filter + * @description Filters to limit the scope of an alert. + */ + filter?: { + customer?: string; + subscription?: string; + subscription_item?: string; + }; + /** @description The title of the alert. */ + title: string; + /** + * usage_threshold_config + * @description The configuration of the usage threshold. + */ + usage_threshold_config?: { + gte: number; + meter?: string; + /** @enum {string} */ + recurrence: "one_time"; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingAlertsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdActivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdArchive: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingAlertsIdDeactivate: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.alert"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostBillingMeterEventAdjustments: { parameters: { query?: never; @@ -29241,7 +29913,7 @@ export interface operations { payment_intent?: string; /** @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 Only return charges for this transfer group. */ + /** @description Only return charges for this transfer group, limited to 100. */ transfer_group?: string; }; header?: never; @@ -29369,9 +30041,11 @@ export interface operations { }; /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ source?: string; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string; /** * transfer_data_specs @@ -29598,9 +30272,11 @@ export interface operations { expand?: string[]; /** @description The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode. */ receipt_email?: string; - /** @description For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. */ statement_descriptor?: string; - /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ statement_descriptor_suffix?: string; /** * transfer_data_specs @@ -30164,7 +30840,7 @@ export interface operations { * @enum {string} */ billing_address_collection?: "auto" | "required"; - /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ + /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`. */ cancel_url?: string; /** @description A unique string to reference the Checkout Session. This can be a * customer ID, a cart ID, or similar, and can be used to reconcile the @@ -30687,7 +31363,7 @@ export interface operations { enabled: boolean; }; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; @@ -30826,6 +31502,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; /** * @description The UI mode of the Session. Defaults to `hosted`. @@ -32541,6 +33219,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; /** @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`. */ @@ -32590,7 +33269,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -32811,6 +33490,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; /** @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`. */ @@ -34723,7 +35403,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -34764,7 +35444,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -35056,7 +35736,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -35097,7 +35777,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. @@ -35342,10 +36022,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -36303,7 +36983,7 @@ export interface operations { * @description The link isn't usable after this future timestamp. */ expires_at?: number; - /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ + /** @description The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. */ file: string; /** @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?: { @@ -36432,7 +37112,7 @@ export interface operations { /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; /** @description Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. */ - purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose?: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "document_provider_identity_document" | "finance_report_run" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_reader_splashscreen"; /** @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; }; @@ -36510,7 +37190,7 @@ export interface operations { * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ - purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "pci_document" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "issuing_regulatory_reporting" | "pci_document" | "tax_document_user_upload" | "terminal_reader_splashscreen"; }; }; }; @@ -37366,6 +38046,7 @@ export interface operations { expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; + related_customer?: string; /** @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 Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ @@ -37450,6 +38131,8 @@ export interface operations { email?: string; phone?: string; }; + /** @description Token referencing a Customer resource. */ + related_customer?: string; /** @description The URL that the user will be redirected to upon completing the verification flow. */ return_url?: string; /** @@ -37664,6 +38347,176 @@ export interface operations { }; }; }; + GetInvoiceRenderingTemplates: { + parameters: { + query?: { + /** @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; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + status?: "active" | "archived"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Details about each object. */ + data: components["schemas"]["invoice_rendering_template"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetInvoiceRenderingTemplatesTemplate: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + version?: number; + }; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostInvoiceRenderingTemplatesTemplateArchive: { + parameters: { + query?: never; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostInvoiceRenderingTemplatesTemplateUnarchive: { + parameters: { + query?: never; + header?: never; + path: { + template: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice_rendering_template"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetInvoiceitems: { parameters: { query?: { @@ -38202,9 +39055,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -38258,6 +39111,8 @@ export interface operations { /** @enum {string} */ page_size?: "a4" | "auto" | "letter"; }; + template?: string; + template_version?: number | ""; }; /** * shipping_cost @@ -38421,7 +39276,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38433,7 +39288,7 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -38797,7 +39652,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -38809,7 +39664,7 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -39170,7 +40025,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; @@ -39184,7 +40039,7 @@ export interface operations { ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview. */ + /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; currency?: string; @@ -39660,9 +40515,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -39711,6 +40566,8 @@ export interface operations { /** @enum {string} */ page_size?: "a4" | "auto" | "letter"; }; + template?: string; + template_version?: number | ""; }; /** @description Settings for the cost of shipping for this invoice. */ shipping_cost?: { @@ -42951,7 +43808,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -43192,6 +44049,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -43219,9 +44078,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -43243,7 +44102,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -43485,11 +44344,11 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * @enum {string} */ setup_future_usage?: "off_session" | "on_session"; @@ -43512,9 +44371,11 @@ export interface operations { phone?: string; tracking_number?: string; }; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_creation_params @@ -43674,7 +44535,7 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ + * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -43888,6 +44749,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -43915,9 +44778,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -43939,7 +44802,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44172,13 +45035,13 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -44198,9 +45061,11 @@ export interface operations { phone?: string; tracking_number?: string; } | ""; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_update_params @@ -44350,9 +45215,11 @@ export interface operations { metadata?: { [key: string]: string; } | ""; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). + * + * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. */ statement_descriptor?: string; - /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. */ + /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** * transfer_data_update_params @@ -44646,6 +45513,8 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -44673,9 +45542,9 @@ export interface operations { installments?: { enabled?: boolean; plan?: { - count: number; + count?: number; /** @enum {string} */ - interval: "month"; + interval?: "month"; /** @enum {string} */ type: "fixed_count"; } | ""; @@ -44697,7 +45566,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** @enum {string} */ @@ -44941,13 +45810,13 @@ export interface operations { /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * - * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. * - * If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. * - * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). * - * If `setup_future_usage` is already set and you are performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. + * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. * @enum {string} */ setup_future_usage?: "" | "off_session" | "on_session"; @@ -45017,7 +45886,7 @@ export interface operations { metadata?: { [key: string]: string; }; - /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). */ statement_descriptor?: string; /** * transfer_data_update_params @@ -45418,6 +46287,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; /** * transfer_data_params @@ -45707,6 +46578,8 @@ export interface operations { */ tax_id_collection?: { enabled: boolean; + /** @enum {string} */ + required?: "if_supported" | "never"; }; }; }; @@ -49562,7 +50435,7 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ description?: string | ""; - /** @description The discounts applied to the quote. You can only set up to one discount. */ + /** @description The discounts applied to the quote. */ discounts?: { coupon?: string; discount?: string; @@ -49755,7 +50628,7 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. */ description?: string | ""; - /** @description The discounts applied to the quote. You can only set up to one discount. */ + /** @description The discounts applied to the quote. */ discounts?: { coupon?: string; discount?: string; @@ -51638,6 +52511,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -51658,7 +52536,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52015,6 +52893,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -52035,7 +52918,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -52391,6 +53274,11 @@ export interface operations { }; /** setup_intent_payment_method_options_param */ amazon_pay?: Record; + /** setup_intent_payment_method_options_param */ + bacs_debit?: { + /** payment_method_options_mandate_options_param */ + mandate_options?: Record; + }; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -52411,7 +53299,7 @@ export interface operations { supported_types?: "india"[]; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; /** setup_intent_payment_method_options_param */ @@ -54462,12 +55350,14 @@ export interface operations { lt?: number; lte?: number; } | number; + /** @description Only return subscriptions whose current_period_end falls within the given date interval. */ current_period_end?: { gt?: number; gte?: number; lt?: number; lte?: number; } | number; + /** @description Only return subscriptions whose current_period_start falls within the given date interval. */ current_period_start?: { gt?: number; gte?: number; @@ -54738,7 +55628,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -54779,7 +55669,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. @@ -55127,7 +56017,7 @@ export interface operations { description?: string; }; /** @enum {string} */ - network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "girocard" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; @@ -55168,7 +56058,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ promotion_code?: string; /** * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. @@ -55396,7 +56286,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @enum {string} */ @@ -55466,6 +56356,44 @@ export interface operations { }; }; }; + GetTaxCalculationsCalculation: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + calculation: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax.calculation"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetTaxCalculationsCalculationLineItems: { parameters: { query?: { @@ -56011,6 +56939,14 @@ export interface operations { jurisdiction: string; }; state: string; + /** state_sales_tax */ + state_sales_tax?: { + elections: { + jurisdiction?: string; + /** @enum {string} */ + type: "local_use_tax" | "simplified_sellers_use_tax" | "single_local_use_tax"; + }[]; + }; /** @enum {string} */ type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; }; @@ -56620,10 +57556,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -57494,7 +58430,7 @@ export interface operations { }; /** @description The ID of a configuration that will be used to customize all readers in this location. */ configuration_overrides?: string; - /** @description A name for the location. */ + /** @description A name for the location. Maximum length is 1000 characters. */ display_name: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -57985,7 +58921,7 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** @description Customer Consent Collected */ - customer_consent_collected: boolean; + customer_consent_collected?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -59170,6 +60106,58 @@ export interface operations { }; }; }; + PostTestHelpersIssuingSettlements: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description The Bank Identification Number reflecting this settlement record. */ + bin: string; + /** @description The date that the transactions are cleared and posted to user's accounts. */ + clearing_date: number; + /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + currency: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The total interchange received as reimbursement for the transactions. */ + interchange_fees?: number; + /** @description The total net amount required to settle with the network. */ + net_total: number; + /** @description The Settlement Identification Number assigned by the network. */ + network_settlement_identifier?: string; + /** @description The total number of transactions reflected in this settlement. */ + transaction_count?: number; + /** @description The total transaction amount reflected in this settlement. */ + transaction_volume?: number; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.settlement"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingTransactionsCreateForceCapture: { parameters: { query?: never; @@ -59950,6 +60938,7 @@ export interface operations { type: "ach" | "us_domestic_wire"; /** us_domestic_wire_tracking_details_params */ us_domestic_wire?: { + chips?: string; imad?: string; omad?: string; }; @@ -60127,6 +61116,7 @@ export interface operations { type: "ach" | "us_domestic_wire"; /** us_domestic_wire_tracking_details_params */ us_domestic_wire?: { + chips?: string; imad?: string; omad?: string; }; @@ -61121,7 +62111,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; - /** @description 3-letter [ISO code for currency](https://stripe.com/docs/payouts). */ + /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 801777c8a..870997aa0 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -1281,35 +1281,33 @@ components: type: string statement_descriptor_kana: description: >- - The Kana variation of the default text that appears on credit card - statements when a charge is made (Japan only) + The Kana variation of `statement_descriptor` used for charges in + Japan. Japanese statement descriptors have [special + requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). maxLength: 5000 nullable: true type: string statement_descriptor_kanji: description: >- - The Kanji variation of the default text that appears on credit card - statements when a charge is made (Japan only) + The Kanji variation of `statement_descriptor` used for charges in + Japan. Japanese statement descriptors have [special + requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kana: description: >- - The Kana variation of the default text that appears on credit card - statements when a charge is made (Japan only). This field prefixes - any dynamic `statement_descriptor_suffix_kana` specified on the - charge. `statement_descriptor_prefix_kana` is useful for maximizing - descriptor space for the dynamic portion. + The Kana variation of `statement_descriptor_prefix` used for card + charges in Japan. Japanese statement descriptors have [special + requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). maxLength: 5000 nullable: true type: string statement_descriptor_prefix_kanji: description: >- - The Kanji variation of the default text that appears on credit card - statements when a charge is made (Japan only). This field prefixes - any dynamic `statement_descriptor_suffix_kanji` specified on the - charge. `statement_descriptor_prefix_kanji` is useful for maximizing - descriptor space for the dynamic portion. + The Kanji variation of `statement_descriptor_prefix` used for card + charges in Japan. Japanese statement descriptors have [special + requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). maxLength: 5000 nullable: true type: string @@ -1553,6 +1551,7 @@ components: - verification_missing_owners - verification_requires_additional_memorandum_of_associations - verification_requires_additional_proof_of_registration + - verification_supportability type: string x-stripeBypassValidation: true reason: @@ -3196,6 +3195,72 @@ components: title: BankConnectionsResourceTransactionResourceStatusTransitions type: object x-expandableFields: [] + billing.alert: + description: >- + A billing alert is a resource that notifies you when a certain usage + threshold on a meter is crossed. For example, you might create a billing + alert to notify you when a certain user made 100 API requests. + properties: + alert_type: + description: Defines the type of the alert. + enum: + - usage_threshold + type: string + x-stripeBypassValidation: true + filter: + anyOf: + - $ref: '#/components/schemas/thresholds_resource_alert_filter' + description: >- + Limits the scope of the alert to a specific + [customer](https://stripe.com/docs/api/customers). + nullable: true + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.alert + type: string + status: + description: 'Status of the alert. This can be active, inactive or archived.' + enum: + - active + - archived + - inactive + nullable: true + type: string + title: + description: Title of the alert. + maxLength: 5000 + type: string + usage_threshold_config: + anyOf: + - $ref: '#/components/schemas/thresholds_resource_usage_threshold_config' + description: >- + Encapsulates configuration of the alert to monitor usage on a + specific [Billing Meter](https://stripe.com/docs/api/billing/meter). + nullable: true + required: + - alert_type + - id + - livemode + - object + - title + title: ThresholdsResourceAlert + type: object + x-expandableFields: + - filter + - usage_threshold_config + x-resourceId: billing.alert billing.meter: description: >- A billing meter is a resource that allows you to track usage of a @@ -3464,6 +3529,28 @@ components: type: object x-expandableFields: [] x-resourceId: billing.meter_event_summary + billing_clocks_resource_status_details_advancing_status_details: + description: '' + properties: + target_frozen_time: + description: The `frozen_time` that the Test Clock is advancing towards. + format: unix-time + type: integer + required: + - target_frozen_time + title: BillingClocksResourceStatusDetailsAdvancingStatusDetails + type: object + x-expandableFields: [] + billing_clocks_resource_status_details_status_details: + description: '' + properties: + advancing: + $ref: >- + #/components/schemas/billing_clocks_resource_status_details_advancing_status_details + title: BillingClocksResourceStatusDetailsStatusDetails + type: object + x-expandableFields: + - advancing billing_details: description: '' properties: @@ -4024,8 +4111,8 @@ components: brand: description: >- Card brand. Can be `American Express`, `Diners Club`, `Discover`, - `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or - `Unknown`. + `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, + `Visa`, or `Unknown`. maxLength: 5000 type: string country: @@ -4039,7 +4126,9 @@ components: currency: description: >- Three-letter [ISO code for - currency](https://stripe.com/docs/payouts). Only applicable on + currency](https://www.iso.org/iso-4217-currency-codes.html) in + lowercase. Must be a [supported + currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where @@ -4359,8 +4448,8 @@ components: The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks - like after the static and dynamic portions are combined. This only - works for card payments. + like after the static and dynamic portions are combined. This value + only exists for card payments. maxLength: 5000 nullable: true type: string @@ -4606,7 +4695,7 @@ components: description: >- The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect - documentation](https://stripe.com/docs/connect/destination-charges) + documentation](https://docs.stripe.com/connect/destination-charges) for details. nullable: true x-expansionResources: @@ -4614,20 +4703,27 @@ components: - $ref: '#/components/schemas/transfer' statement_descriptor: description: >- - For card charges, use `statement_descriptor_suffix` instead. - Otherwise, you can use this value as the complete description of a - charge on your customers’ statements. Must contain at least one - letter, maximum 22 characters. + For a non-card charge, text that appears on the customer's statement + as the statement descriptor. This value overrides the account's + default statement descriptor. For information about requirements, + including the 22-character limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + For a card charge, this value is ignored unless you don't specify a + `statement_descriptor_suffix`, in which case this value is used as + the suffix. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- - Provides information about the charge that customers see on their - statements. Concatenated with the prefix (shortened descriptor) or - statement descriptor that’s set on the account to form the complete - statement descriptor. Maximum 22 characters for the concatenated - descriptor. + Provides information about a card charge. Concatenated to the + account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on the + customer's statement. If the account has no prefix value, the suffix + is concatenated to the account's statement descriptor. maxLength: 5000 nullable: true type: string @@ -5236,7 +5332,7 @@ components: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect - behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. enum: - always @@ -5479,26 +5575,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -5525,26 +5619,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -5560,26 +5652,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -5595,26 +5685,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -5630,26 +5718,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -5666,26 +5752,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -5701,26 +5785,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -5738,26 +5820,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -5780,26 +5860,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -5848,26 +5926,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -5909,26 +5985,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6000,26 +6074,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6036,26 +6108,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6071,26 +6141,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6106,26 +6174,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6141,26 +6207,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6176,26 +6240,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6211,26 +6273,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -6256,26 +6316,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6291,26 +6349,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -6327,26 +6383,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6362,26 +6416,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6404,26 +6456,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6441,26 +6491,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6476,26 +6524,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6534,26 +6580,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -6580,26 +6624,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -6616,26 +6658,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -6757,26 +6797,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -6807,26 +6845,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -9652,6 +9688,16 @@ components: Stripe.js) client-side access control over a Customer. + + + Related guides: [Customer Session with the Payment + Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), + + [Customer Session with the Pricing + Table](/payments/checkout/pricing-table#customer-session), + + [Customer Session with the Buy + Button](/payment-links/buy-button#pass-an-existing-customer). properties: client_secret: description: >- @@ -9799,7 +9845,7 @@ components: payment_method_redisplay_limit: description: >- Determines the max number of saved payment methods for the Payment - Element to display. This parameter defaults to `10`. + Element to display. This parameter defaults to `3`. nullable: true type: integer payment_method_remove: @@ -11301,6 +11347,8 @@ components: dispute_payment_method_details: description: '' properties: + amazon_pay: + $ref: '#/components/schemas/dispute_payment_method_details_amazon_pay' card: $ref: '#/components/schemas/dispute_payment_method_details_card' klarna: @@ -11310,6 +11358,7 @@ components: type: description: Payment method type. enum: + - amazon_pay - card - klarna - paypal @@ -11319,9 +11368,23 @@ components: title: DisputePaymentMethodDetails type: object x-expandableFields: + - amazon_pay - card - klarna - paypal + dispute_payment_method_details_amazon_pay: + description: '' + properties: + dispute_type: + description: 'The AmazonPay dispute type, chargeback or claim' + enum: + - chargeback + - claim + nullable: true + type: string + title: DisputePaymentMethodDetailsAmazonPay + type: object + x-expandableFields: [] dispute_payment_method_details_card: description: '' properties: @@ -12062,6 +12125,7 @@ components: - finance_report_run - identity_document - identity_document_downloadable + - issuing_regulatory_reporting - pci_document - selfie - sigma_scheduled_query @@ -14115,6 +14179,11 @@ components: Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. nullable: true + related_customer: + description: Token referencing a Customer resource. + maxLength: 5000 + nullable: true + type: string status: description: >- Status of this VerificationSession. [Learn more about the lifecycle @@ -14454,6 +14523,17 @@ components: type: boolean automatic_tax: $ref: '#/components/schemas/automatic_tax' + automatically_finalizes_at: + description: >- + The time when this invoice is currently scheduled to be + automatically finalized. The field will be `null` if the invoice is + not scheduled to finalize in the future. If the invoice is not in + the draft state, this field will always be `null` - see + `finalized_at` for the time when an already-finalized invoice was + finalized. + format: unix-time + nullable: true + type: integer billing_reason: description: >- Indicates the reason why the invoice was created. @@ -15427,6 +15507,73 @@ components: title: InvoiceRenderingPdf type: object x-expandableFields: [] + invoice_rendering_template: + description: >- + Invoice Rendering Templates are used to configure how invoices are + rendered on surfaces like the PDF. Invoice Rendering Templates + + can be created from within the Dashboard, and they can be used over the + API when creating invoices. + properties: + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: string + 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. + nullable: true + type: object + nickname: + description: 'A brief description of the template, hidden from customers' + maxLength: 5000 + nullable: true + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - invoice_rendering_template + type: string + status: + description: 'The status of the template, one of `active` or `archived`.' + enum: + - active + - archived + type: string + version: + description: >- + Version of this template; version increases by one when an update on + the template changes any field that controls invoice rendering + type: integer + required: + - created + - id + - livemode + - object + - status + - version + title: InvoiceRenderingTemplate + type: object + x-expandableFields: [] + x-resourceId: invoice_rendering_template invoice_setting_custom_field: description: '' properties: @@ -15454,6 +15601,14 @@ components: maxLength: 5000 nullable: true type: string + template: + description: >- + ID of the invoice rendering template to be used for this customer's + invoices. If set, the template will be used on all invoices for this + customer unless a template is set directly on the invoice. + maxLength: 5000 + nullable: true + type: string title: InvoiceSettingCustomerRenderingOptions type: object x-expandableFields: [] @@ -16094,6 +16249,15 @@ components: - $ref: '#/components/schemas/invoice_rendering_pdf' description: Invoice pdf rendering options nullable: true + template: + description: ID of the rendering template that the invoice is formatted by. + maxLength: 5000 + nullable: true + type: string + template_version: + description: Version of the rendering template that the invoice is using. + nullable: true + type: integer title: InvoicesResourceInvoiceRendering type: object x-expandableFields: @@ -16105,17 +16269,17 @@ components: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, - `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, - `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, - `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, - `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, - `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, - `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, - `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, - `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, - `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, `ch_uid`, or `unknown` + `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, + `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, + `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, + `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, + `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, + `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, + `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, + `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, + `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, + `om_vat`, `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -16149,6 +16313,7 @@ components: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -17179,6 +17344,7 @@ components: description: >- The date that the transactions are cleared and posted to user's accounts. + format: unix-time type: integer created: description: >- @@ -17220,8 +17386,11 @@ components: description: The total net amount required to settle with the network. type: integer network: - description: 'The card network for this settlement report. One of ["visa"]' + description: >- + The card network for this settlement report. One of ["visa", + "maestro"] enum: + - maestro - visa type: string network_fees: @@ -17242,6 +17411,12 @@ components: description: One of `international` or `uk_national_net`. maxLength: 5000 type: string + status: + description: The current processing status of this settlement. + enum: + - complete + - pending + type: string transaction_count: description: The total number of transactions reflected in this settlement. type: integer @@ -17263,6 +17438,7 @@ components: - network_settlement_identifier - object - settlement_service + - status - transaction_count - transaction_volume title: IssuingSettlement @@ -18982,6 +19158,7 @@ components: - pending - returned - shipped + - submitted nullable: true type: string tracking_number: @@ -21854,7 +22031,6 @@ components: - amount_tax - amount_total - currency - - description - id - object title: LineItem @@ -21864,6 +22040,29 @@ components: - price - taxes x-resourceId: item + klarna_address: + description: '' + properties: + country: + description: The payer address country + maxLength: 5000 + nullable: true + type: string + title: klarna_address + type: object + x-expandableFields: [] + klarna_payer_details: + description: '' + properties: + address: + anyOf: + - $ref: '#/components/schemas/klarna_address' + description: The payer's address + nullable: true + title: klarna_payer_details + type: object + x-expandableFields: + - address legal_entity_company: description: '' properties: @@ -22251,7 +22450,15 @@ components: type: object x-expandableFields: [] line_item: - description: '' + description: >- + Invoice Line Items represent the individual lines within an + [invoice](https://stripe.com/docs/api/invoices) and only exist within + the context of an invoice. + + + Each line item is backed by either an [invoice + item](https://stripe.com/docs/api/invoiceitems) or a [subscription + item](https://stripe.com/docs/api/subscription_items). properties: amount: description: 'The amount, in cents (or local equivalent).' @@ -22426,6 +22633,8 @@ components: - object - period - proration + - tax_amounts + - tax_rates - type title: InvoiceLineItem type: object @@ -23381,6 +23590,24 @@ components: title: PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture type: object x-expandableFields: [] + payment_flows_private_payment_methods_card_present_common_wallet: + description: '' + properties: + type: + description: >- + The type of mobile wallet, one of `apple_pay`, `google_pay`, + `samsung_pay`, or `unknown`. + enum: + - apple_pay + - google_pay + - samsung_pay + - unknown + type: string + required: + - type + title: PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet + type: object + x-expandableFields: [] payment_flows_private_payment_methods_klarna_dob: description: '' properties: @@ -23583,7 +23810,7 @@ components: after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. nullable: true @@ -23742,26 +23969,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - off_session - on_session @@ -23774,21 +23999,27 @@ components: nullable: true statement_descriptor: description: >- - For card charges, use - [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). - Otherwise, you can use this value as the complete description of a - charge on your customers' statements. It must contain at least one - letter and be 1–22 characters long. + Text that appears on the customer's statement as the statement + descriptor for a non-card charge. This value overrides the account's + default statement descriptor. For information about requirements, + including the 22-character limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + Setting this value for a card charge returns an error. For card + charges, set the + [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) + instead. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- - Provides information about a card payment that customers see on - their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the account to - form the complete statement descriptor. Maximum 22 characters for - the concatenated descriptor. + Provides information about a card charge. Concatenated to the + account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on the + customer's statement. maxLength: 5000 nullable: true type: string @@ -24612,7 +24843,8 @@ components: #/components/schemas/payment_intent_type_specific_payment_method_options_client bacs_debit: anyOf: - - $ref: '#/components/schemas/payment_method_options_bacs_debit' + - $ref: >- + #/components/schemas/payment_intent_payment_method_options_bacs_debit - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client bancontact: @@ -24832,26 +25064,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -24878,26 +25108,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -24906,6 +25134,45 @@ components: title: payment_intent_payment_method_options_au_becs_debit type: object x-expandableFields: [] + payment_intent_payment_method_options_bacs_debit: + description: '' + properties: + mandate_options: + $ref: >- + #/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a + Customer after the transaction completes. + + + If the payment method is `card_present` and isn't a digital wallet, + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. + + + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). + enum: + - none + - off_session + - on_session + type: string + title: payment_intent_payment_method_options_bacs_debit + type: object + x-expandableFields: + - mandate_options payment_intent_payment_method_options_blik: description: '' properties: @@ -24915,26 +25182,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -24980,6 +25245,7 @@ components: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -25056,26 +25322,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -25116,26 +25380,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -25158,26 +25420,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -25217,6 +25477,12 @@ components: title: payment_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] + payment_intent_payment_method_options_mandate_options_bacs_debit: + description: '' + properties: {} + title: payment_intent_payment_method_options_mandate_options_bacs_debit + type: object + x-expandableFields: [] payment_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} @@ -25239,26 +25505,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -25277,26 +25541,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -25322,26 +25584,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -25368,26 +25628,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -25482,26 +25740,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -26276,19 +26532,18 @@ components: type: string statement_descriptor: description: >- - Extra information about the payment. This will appear on your - customer's statement when this payment succeeds in creating a + For a non-card payment, information about the charge that appears on + the customer's statement when this payment succeeds in creating a charge. maxLength: 5000 nullable: true type: string statement_descriptor_suffix: description: >- - Provides information about the charge that customers see on their - statements. Concatenated with the prefix (shortened descriptor) or - statement descriptor that's set on the account to form the complete - statement descriptor. Maximum 22 characters for the concatenated - descriptor. + For a card payment, information about the charge that appears on the + customer's statement when this payment succeeds in creating a + charge. Concatenated with the account's statement descriptor prefix + to form the complete statement descriptor. maxLength: 5000 nullable: true type: string @@ -26688,8 +26943,14 @@ components: enabled: description: Indicates whether tax ID collection is enabled for the session. type: boolean + required: + enum: + - if_supported + - never + type: string required: - enabled + - required title: PaymentLinksResourceTaxIdCollection type: object x-expandableFields: [] @@ -27347,6 +27608,11 @@ components: Contains information about card networks that can be used to process the payment. nullable: true + offline: + anyOf: + - $ref: '#/components/schemas/payment_method_details_card_present_offline' + description: Details about payment methods collected offline. + nullable: true preferred_locales: description: >- EMV tag 5F2D. Preferred languages specified by the integrated @@ -27366,6 +27632,9 @@ components: - magnetic_stripe_track2 nullable: true type: string + wallet: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet required: - exp_month - exp_year @@ -27373,6 +27642,8 @@ components: type: object x-expandableFields: - networks + - offline + - wallet payment_method_card_present_networks: description: '' properties: @@ -28350,6 +28621,11 @@ components: description: The authorized amount. nullable: true type: integer + authorization_code: + description: Authorization code on the charge. + maxLength: 5000 + nullable: true + type: string brand: description: >- Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, @@ -28687,16 +28963,13 @@ components: network_transaction_id: description: >- This is used by the financial networks to identify a transaction. - Visa calls this the Transaction ID, Mastercard calls this the Trace - ID, and American Express calls this the Acquirer Reference Data. - - The first three digits of the Trace ID is the Financial Network - Code, the next 6 digits is the Banknet Reference Number, and the - last 4 digits represent the date (MM/DD). - - This field will be available for successful Visa, Mastercard, or - American Express transactions and always null for other card brands. + ID, and American Express calls this the Acquirer Reference Data. The + first three digits of the Trace ID is the Financial Network Code, + the next 6 digits is the Banknet Reference Number, and the last 4 + digits represent the date (MM/DD). This field will be available for + successful Visa, Mastercard, or American Express transactions and + always null for other card brands. maxLength: 5000 nullable: true type: string @@ -28734,6 +29007,9 @@ components: A collection of fields required to be displayed on receipts. Only required for EMV transactions. nullable: true + wallet: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet required: - exp_month - exp_year @@ -28744,6 +29020,7 @@ components: x-expandableFields: - offline - receipt + - wallet payment_method_details_card_present_offline: description: '' properties: @@ -28752,6 +29029,14 @@ components: format: unix-time nullable: true type: integer + type: + description: >- + The method used to process this payment method offline. Only + deferred is allowed. + enum: + - deferred + nullable: true + type: string title: payment_method_details_card_present_offline type: object x-expandableFields: [] @@ -29357,16 +29642,13 @@ components: network_transaction_id: description: >- This is used by the financial networks to identify a transaction. - Visa calls this the Transaction ID, Mastercard calls this the Trace - ID, and American Express calls this the Acquirer Reference Data. - - The first three digits of the Trace ID is the Financial Network - Code, the next 6 digits is the Banknet Reference Number, and the - last 4 digits represent the date (MM/DD). - - This field will be available for successful Visa, Mastercard, or - American Express transactions and always null for other card brands. + ID, and American Express calls this the Acquirer Reference Data. The + first three digits of the Trace ID is the Financial Network Code, + the next 6 digits is the Banknet Reference Number, and the last 4 + digits represent the date (MM/DD). This field will be available for + successful Visa, Mastercard, or American Express transactions and + always null for other card brands. maxLength: 5000 nullable: true type: string @@ -29471,6 +29753,11 @@ components: payment_method_details_klarna: description: '' properties: + payer_details: + anyOf: + - $ref: '#/components/schemas/klarna_payer_details' + description: The payer details for this transaction. + nullable: true payment_method_category: description: >- The Klarna payment method used for this transaction. @@ -29497,7 +29784,8 @@ components: type: string title: payment_method_details_klarna type: object - x-expandableFields: [] + x-expandableFields: + - payer_details payment_method_details_konbini: description: '' properties: @@ -30421,26 +30709,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -30473,26 +30759,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -30509,26 +30793,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -30552,26 +30834,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -30579,43 +30859,6 @@ components: title: payment_method_options_amazon_pay type: object x-expandableFields: [] - payment_method_options_bacs_debit: - description: '' - properties: - setup_future_usage: - description: >- - Indicates that you intend to make future payments with this - PaymentIntent's payment method. - - - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a - Customer after the transaction completes. - - - If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. - - - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). - enum: - - none - - off_session - - on_session - type: string - title: payment_method_options_bacs_debit - type: object - x-expandableFields: [] payment_method_options_bancontact: description: '' properties: @@ -30635,26 +30878,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -30680,26 +30921,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -30872,26 +31111,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -30920,26 +31157,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31021,26 +31256,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31056,26 +31289,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31091,26 +31322,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31126,26 +31355,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -31182,26 +31409,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31247,26 +31472,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31282,26 +31505,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31324,26 +31545,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31361,26 +31580,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31396,26 +31613,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31454,26 +31669,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -31500,26 +31713,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31535,26 +31746,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31577,26 +31786,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -31627,26 +31834,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none - off_session @@ -31663,26 +31868,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31726,26 +31929,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -31761,26 +31962,24 @@ components: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a + If you provide a Customer with the PaymentIntent, you can use this + parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after the + PaymentIntent is confirmed and the customer completes any required + actions. If you don't provide a Customer, you can still + [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, - then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached to the - Customer instead. + Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer instead. - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses `setup_future_usage` to + help you comply with regional legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - none type: string @@ -32991,17 +33190,17 @@ components: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, - `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, - `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, - `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, - `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, - `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, - `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, - `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, - `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, - `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, `ch_uid`, or `unknown` + `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, + `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, + `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, + `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, + `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, + `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, + `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, + `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, + `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, + `om_vat`, `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -33035,6 +33234,7 @@ components: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -33094,8 +33294,15 @@ components: enabled: description: Indicates whether tax ID collection is enabled for the session type: boolean + required: + description: Indicates whether a tax ID is required on the payment page + enum: + - if_supported + - never + type: string required: - enabled + - required title: PaymentPagesCheckoutSessionTaxIDCollection type: object x-expandableFields: [] @@ -33671,9 +33878,12 @@ components: description: '' properties: account: - $ref: '#/components/schemas/person_additional_tos_acceptance' - required: - - account + anyOf: + - $ref: '#/components/schemas/person_additional_tos_acceptance' + description: >- + Details on the legal guardian's acceptance of the main Stripe + service agreement. + nullable: true title: PersonAdditionalTOSAcceptances type: object x-expandableFields: @@ -38119,7 +38329,7 @@ components: description: >- ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the - [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) + [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. nullable: true @@ -38301,6 +38511,12 @@ components: #/components/schemas/setup_intent_payment_method_options_amazon_pay - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client + bacs_debit: + anyOf: + - $ref: >- + #/components/schemas/setup_intent_payment_method_options_bacs_debit + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client card: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options_card' @@ -38339,6 +38555,7 @@ components: x-expandableFields: - acss_debit - amazon_pay + - bacs_debit - card - card_present - link @@ -38376,6 +38593,16 @@ components: title: setup_intent_payment_method_options_amazon_pay type: object x-expandableFields: [] + setup_intent_payment_method_options_bacs_debit: + description: '' + properties: + mandate_options: + $ref: >- + #/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit + title: setup_intent_payment_method_options_bacs_debit + type: object + x-expandableFields: + - mandate_options setup_intent_payment_method_options_card: description: '' properties: @@ -38398,6 +38625,7 @@ components: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -38571,6 +38799,12 @@ components: title: setup_intent_payment_method_options_mandate_options_acss_debit type: object x-expandableFields: [] + setup_intent_payment_method_options_mandate_options_bacs_debit: + description: '' + properties: {} + title: setup_intent_payment_method_options_mandate_options_bacs_debit + type: object + x-expandableFields: [] setup_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: {} @@ -40850,6 +41084,7 @@ components: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -42648,15 +42883,15 @@ components: `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, - `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, - `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, - `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, - `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, - `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, - `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, - `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have - type `unknown` + `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, + `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, + `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, + `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, + `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, + `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, + `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, + `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax + IDs have type `unknown` enum: - ad_nrt - ae_trn @@ -42690,6 +42925,7 @@ components: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -43122,6 +43358,9 @@ components: 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 type: string + state_sales_tax: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax type: description: Type of registration in the US. enum: @@ -43139,6 +43378,7 @@ components: x-expandableFields: - local_amusement_tax - local_lease_tax + - state_sales_tax tax_product_registrations_resource_country_options_us_local_amusement_tax: description: '' properties: @@ -43169,6 +43409,41 @@ components: title: TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax type: object x-expandableFields: [] + tax_product_registrations_resource_country_options_us_state_sales_tax: + description: '' + properties: + elections: + description: Elections for the state sales tax registration. + items: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election + type: array + title: TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax + type: object + x-expandableFields: + - elections + tax_product_registrations_resource_country_options_us_state_sales_tax_election: + description: '' + properties: + jurisdiction: + description: >- + A [FIPS + code](https://www.census.gov/library/reference/code-lists/ansi.html) + representing the local jurisdiction. + maxLength: 5000 + type: string + type: + description: The type of the election for the state sales tax registration. + enum: + - local_use_tax + - simplified_sellers_use_tax + - single_local_use_tax + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection + type: object + x-expandableFields: [] tax_product_resource_customer_details: description: '' properties: @@ -43219,17 +43494,17 @@ components: description: >- The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, - `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, - `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, - `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, - `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, - `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, - `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, - `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, - `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, - `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, - `de_stn`, `ch_uid`, or `unknown` + `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, + `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, + `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, + `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, + `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, + `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, + `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, + `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, + `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, + `om_vat`, `de_stn`, `ch_uid`, or `unknown` enum: - ad_nrt - ae_trn @@ -43263,6 +43538,7 @@ components: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -44187,7 +44463,9 @@ components: maxLength: 5000 type: string status: - description: The networking status of the reader. + description: >- + The networking status of the reader. We do not recommend using this + field in flows that may block taking payments. enum: - offline - online @@ -44698,6 +44976,9 @@ components: - internal_failure - ready type: string + status_details: + $ref: >- + #/components/schemas/billing_clocks_resource_status_details_status_details required: - created - deletes_after @@ -44706,9 +44987,11 @@ components: - livemode - object - status + - status_details title: TestClock type: object - x-expandableFields: [] + x-expandableFields: + - status_details x-resourceId: test_helpers.test_clock three_d_secure_details: description: '' @@ -44879,6 +45162,54 @@ components: title: three_d_secure_usage type: object x-expandableFields: [] + thresholds_resource_alert_filter: + description: '' + properties: + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + description: Limit the scope of the alert to this customer ID + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + title: ThresholdsResourceAlertFilter + type: object + x-expandableFields: + - customer + thresholds_resource_usage_threshold_config: + description: >- + The usage threshold alert configuration enables setting up alerts for + when a certain usage threshold on a specific meter is crossed. + properties: + gte: + description: The value at which this alert will trigger. + type: integer + meter: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/billing.meter' + description: 'The [Billing Meter](/api/billing/meter) ID whose usage is monitored.' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/billing.meter' + recurrence: + description: Defines how the alert will behave. + enum: + - one_time + type: string + x-stripeBypassValidation: true + required: + - gte + - meter + - recurrence + title: ThresholdsResourceUsageThresholdConfig + type: object + x-expandableFields: + - meter token: description: >- Tokenization is the process Stripe uses to collect sensitive card or @@ -45294,8 +45625,8 @@ components: type: string - $ref: '#/components/schemas/charge' description: >- - ID of the charge or payment that was used to fund the transfer. If - null, the transfer was funded from the available balance. + ID of the charge that was used to fund the transfer. If null, the + transfer was funded from the available balance. nullable: true x-expansionResources: oneOf: @@ -45800,6 +46131,7 @@ components: - card_issuing - deposit_insurance - financial_addresses.aba + - financial_addresses.aba.forwarding - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach @@ -45865,6 +46197,7 @@ components: - card_issuing - deposit_insurance - financial_addresses.aba + - financial_addresses.aba.forwarding - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach @@ -45890,6 +46223,7 @@ components: - card_issuing - deposit_insurance - financial_addresses.aba + - financial_addresses.aba.forwarding - inbound_transfers.ach - intra_stripe_flows - outbound_payments.ach @@ -45990,11 +46324,15 @@ components: treasury.inbound_transfer: description: >- Use - [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) + [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + + + Related guide: [Moving money with Treasury using InboundTransfer + objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) properties: amount: description: Amount (in cents) transferred. @@ -46144,8 +46482,9 @@ components: x-resourceId: treasury.inbound_transfer treasury.outbound_payment: description: >- - Use OutboundPayments to send funds to another party's external bank - account or + Use + [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) + to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). @@ -46154,6 +46493,10 @@ components: Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. + + + Related guide: [Moving money with Treasury using OutboundPayment + objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) properties: amount: description: Amount (in cents) transferred. @@ -46327,7 +46670,9 @@ components: x-resourceId: treasury.outbound_payment treasury.outbound_transfer: description: >- - Use OutboundTransfers to transfer funds from a + Use + [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) + to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use @@ -46339,6 +46684,10 @@ components: Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. + + + Related guide: [Moving money with Treasury using OutboundTransfer + objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) properties: amount: description: Amount (in cents) transferred. @@ -46660,6 +47009,7 @@ components: - account_closed - account_frozen - insufficient_funds + - international_transaction - other nullable: true type: string @@ -47525,11 +47875,19 @@ components: treasury_outbound_payments_resource_us_domestic_wire_tracking_details: description: '' properties: + chips: + description: >- + CHIPS System Sequence Number (SSN) of the OutboundPayment for + payments sent over the `us_domestic_wire` network. + maxLength: 5000 + nullable: true + type: string imad: description: >- IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. maxLength: 5000 + nullable: true type: string omad: description: >- @@ -47538,8 +47896,6 @@ components: maxLength: 5000 nullable: true type: string - required: - - imad title: TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails type: object x-expandableFields: [] @@ -47649,11 +48005,19 @@ components: treasury_outbound_transfers_resource_us_domestic_wire_tracking_details: description: '' properties: + chips: + description: >- + CHIPS System Sequence Number (SSN) of the OutboundTransfer for + transfers sent over the `us_domestic_wire` network. + maxLength: 5000 + nullable: true + type: string imad: description: >- IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. maxLength: 5000 + nullable: true type: string omad: description: >- @@ -47662,8 +48026,6 @@ components: maxLength: 5000 nullable: true type: string - required: - - imad title: TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails type: object x-expandableFields: [] @@ -48392,8 +48754,6 @@ paths: - include - omit type: string - required: - - fields title: collection_options_params type: object expand: @@ -50123,7 +50483,7 @@ paths: balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

+ href="/api/balance/balance_object">balances are zero.

If you want to delete your own account, use the - - Details on the legal guardian's acceptance of the required - Stripe agreements. + Details on the legal guardian's or authorizer's acceptance + of the required Stripe agreements. properties: account: properties: @@ -53308,8 +53668,8 @@ paths: properties: additional_tos_acceptances: description: >- - Details on the legal guardian's acceptance of the required - Stripe agreements. + Details on the legal guardian's or authorizer's acceptance + of the required Stripe agreements. properties: account: properties: @@ -53869,8 +54229,8 @@ paths: properties: additional_tos_acceptances: description: >- - Details on the legal guardian's acceptance of the required - Stripe agreements. + Details on the legal guardian's or authorizer's acceptance + of the required Stripe agreements. properties: account: properties: @@ -54400,8 +54760,8 @@ paths: properties: additional_tos_acceptances: description: >- - Details on the legal guardian's acceptance of the required - Stripe agreements. + Details on the legal guardian's or authorizer's acceptance + of the required Stripe agreements. properties: account: properties: @@ -56465,147 +56825,530 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/billing/meter_event_adjustments: - post: - description:

Creates a billing meter event adjustment

- operationId: PostBillingMeterEventAdjustments - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - cancel: - explode: true - style: deepObject - expand: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - cancel: - description: Specifies which event to cancel. - properties: - identifier: - maxLength: 100 - type: string - title: event_adjustment_cancel_settings_param - type: object - event_name: - description: >- - The name of the meter event. Corresponds with the - `event_name` field on a meter. - maxLength: 100 - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - type: - description: >- - Specifies whether to cancel a single event or a range of - events for a time period. Time period cancellation is not - supported yet. - enum: - - cancel - type: string - required: - - event_name - - type - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing.meter_event_adjustment' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/billing/meter_events: - post: - description:

Creates a billing meter event

- operationId: PostBillingMeterEvents - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - payload: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - event_name: - description: >- - The name of the meter event. Corresponds with the - `event_name` field on a meter. - maxLength: 100 - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - identifier: - description: >- - A unique identifier for the event. If not provided, one will - be generated. We recommend using a globally unique - identifier for this. We'll enforce uniqueness within a - rolling 24 hour period. - maxLength: 100 - type: string - payload: - additionalProperties: - type: string - description: >- - The payload of the event. This must contain the fields - corresponding to a meter's - `customer_mapping.event_payload_key` (default is - `stripe_customer_id`) and `value_settings.event_payload_key` - (default is `value`). Read more about the - [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). - type: object - timestamp: - description: >- - The time of the event. Measured in seconds since the Unix - epoch. Must be within the past 35 calendar days or up to 5 - minutes in the future. Defaults to current timestamp if not - specified. - format: unix-time - type: integer - required: - - event_name - - payload - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing.meter_event' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/billing/meters: + /v1/billing/alerts: get: - description:

Retrieve a list of billing meters.

- operationId: GetBillingMeters + description:

Lists billing active and inactive alerts

+ operationId: GetBillingAlerts + parameters: + - description: Filter results to only include this type of alert. + in: query + name: alert_type + required: false + schema: + enum: + - usage_threshold + type: string + x-stripeBypassValidation: true + style: form + - 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. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: Filter results to only include alerts with the given meter. + in: query + name: meter + required: false + schema: + maxLength: 5000 + type: string + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/billing.alert' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/billing/alerts + type: string + required: + - data + - has_more + - object + - url + title: ThresholdsResourceAlertList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Creates a billing alert

+ operationId: PostBillingAlerts + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + filter: + explode: true + style: deepObject + usage_threshold_config: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + alert_type: + description: The type of alert to create. + enum: + - usage_threshold + type: string + x-stripeBypassValidation: true + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + filter: + description: Filters to limit the scope of an alert. + properties: + customer: + maxLength: 5000 + type: string + subscription: + maxLength: 5000 + type: string + subscription_item: + maxLength: 5000 + type: string + title: alert_filter + type: object + title: + description: The title of the alert. + maxLength: 256 + type: string + usage_threshold_config: + description: The configuration of the usage threshold. + properties: + gte: + type: integer + meter: + maxLength: 5000 + type: string + recurrence: + enum: + - one_time + type: string + x-stripeBypassValidation: true + required: + - gte + - recurrence + title: usage_threshold_config + type: object + required: + - alert_type + - title + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/billing/alerts/{id}': + get: + description:

Retrieves a billing alert given an ID

+ operationId: GetBillingAlertsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/billing/alerts/{id}/activate': + post: + description: '

Reactivates this alert, allowing it to trigger again.

' + operationId: PostBillingAlertsIdActivate + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + 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 + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/billing/alerts/{id}/archive': + post: + description: >- +

Archives this alert, removing it from the list view and APIs. This is + non-reversible.

+ operationId: PostBillingAlertsIdArchive + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + 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 + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/billing/alerts/{id}/deactivate': + post: + description: '

Deactivates this alert, preventing it from triggering.

' + operationId: PostBillingAlertsIdDeactivate + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + 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 + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.alert' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/billing/meter_event_adjustments: + post: + description:

Creates a billing meter event adjustment

+ operationId: PostBillingMeterEventAdjustments + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + cancel: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + cancel: + description: Specifies which event to cancel. + properties: + identifier: + maxLength: 100 + type: string + title: event_adjustment_cancel_settings_param + type: object + event_name: + description: >- + The name of the meter event. Corresponds with the + `event_name` field on a meter. + maxLength: 100 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: + description: >- + Specifies whether to cancel a single event or a range of + events for a time period. Time period cancellation is not + supported yet. + enum: + - cancel + type: string + required: + - event_name + - type + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.meter_event_adjustment' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/billing/meter_events: + post: + description:

Creates a billing meter event

+ operationId: PostBillingMeterEvents + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + payload: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + event_name: + description: >- + The name of the meter event. Corresponds with the + `event_name` field on a meter. + maxLength: 100 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + identifier: + description: >- + A unique identifier for the event. If not provided, one will + be generated. We recommend using a globally unique + identifier for this. We'll enforce uniqueness within a + rolling 24 hour period. + maxLength: 100 + type: string + payload: + additionalProperties: + type: string + description: >- + The payload of the event. This must contain the fields + corresponding to a meter's + `customer_mapping.event_payload_key` (default is + `stripe_customer_id`) and `value_settings.event_payload_key` + (default is `value`). Read more about the + [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). + type: object + timestamp: + description: >- + The time of the event. Measured in seconds since the Unix + epoch. Must be within the past 35 calendar days or up to 5 + minutes in the future. Defaults to current timestamp if not + specified. + format: unix-time + type: integer + required: + - event_name + - payload + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.meter_event' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/billing/meters: + get: + description:

Retrieve a list of billing meters.

+ operationId: GetBillingMeters parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that @@ -58161,7 +58904,7 @@ paths: schema: type: string style: form - - description: Only return charges for this transfer group. + - description: 'Only return charges for this transfer group, limited to 100.' in: query name: transfer_group required: false @@ -58506,19 +59249,28 @@ paths: x-stripeBypassValidation: true statement_descriptor: description: >- - For card charges, use `statement_descriptor_suffix` instead. - Otherwise, you can use this value as the complete - description of a charge on your customers’ statements. Must - contain at least one letter, maximum 22 characters. + For a non-card charge, text that appears on the customer's + statement as the statement descriptor. This value overrides + the account's default statement descriptor. For information + about requirements, including the 22-character limit, see + [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + For a card charge, this value is ignored unless you don't + specify a `statement_descriptor_suffix`, in which case this + value is used as the suffix. maxLength: 22 type: string statement_descriptor_suffix: description: >- - Provides information about the charge that customers see on - their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the - account to form the complete statement descriptor. Maximum - 22 characters for the concatenated descriptor. + Provides information about a card charge. Concatenated to + the account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on + the customer's statement. If the account has no prefix + value, the suffix is concatenated to the account's statement + descriptor. maxLength: 22 type: string transfer_data: @@ -58956,19 +59708,28 @@ paths: type: string statement_descriptor: description: >- - For card charges, use `statement_descriptor_suffix` instead. - Otherwise, you can use this value as the complete - description of a charge on your customers’ statements. Must - contain at least one letter, maximum 22 characters. + For a non-card charge, text that appears on the customer's + statement as the statement descriptor. This value overrides + the account's default statement descriptor. For information + about requirements, including the 22-character limit, see + [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + For a card charge, this value is ignored unless you don't + specify a `statement_descriptor_suffix`, in which case this + value is used as the suffix. maxLength: 22 type: string statement_descriptor_suffix: description: >- - Provides information about the charge that customers see on - their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the - account to form the complete statement descriptor. Maximum - 22 characters for the concatenated descriptor. + Provides information about a card charge. Concatenated to + the account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on + the customer's statement. If the account has no prefix + value, the suffix is concatenated to the account's statement + descriptor. maxLength: 22 type: string transfer_data: @@ -60063,7 +60824,8 @@ paths: description: >- If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and - return to your website. + return to your website. This parameter is not allowed if + ui_mode is `embedded`. maxLength: 5000 type: string client_reference_id: @@ -61347,7 +62109,7 @@ paths: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect - behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. enum: - always @@ -61874,6 +62636,11 @@ paths: properties: enabled: type: boolean + required: + enum: + - if_supported + - never + type: string required: - enabled title: tax_id_collection_params @@ -65099,6 +65866,9 @@ paths: - exclude_tax - include_inclusive_tax type: string + template: + maxLength: 5000 + type: string title: customer_rendering_options_param type: object - enum: @@ -65262,6 +66032,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -65844,6 +66615,9 @@ paths: - exclude_tax - include_inclusive_tax type: string + template: + maxLength: 5000 + type: string title: customer_rendering_options_param type: object - enum: @@ -69514,6 +70288,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -69700,7 +70475,7 @@ paths: given subscription at the specified interval. promotion_code: description: >- - The ID of a promotion code to apply to this subscription. A + The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future @@ -70597,6 +71372,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -70785,7 +71561,9 @@ paths: description: >- The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect - invoices created for that particular subscription. + invoices created for that particular subscription. This + field has been deprecated and will be removed in a future + API version. Use `discounts` instead. maxLength: 5000 type: string proration_behavior: @@ -71132,14 +71910,14 @@ paths: `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, - `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, - `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, - `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, - `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, - `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, - `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, - `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, - or `za_vat` + `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, + `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, + `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, + `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, + `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, + `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, + `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, + `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn @@ -71173,6 +71951,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -72832,8 +73611,8 @@ paths: following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, - `pci_document`, `selfie`, `sigma_scheduled_query`, - `tax_document_user_upload`, or + `issuing_regulatory_reporting`, `pci_document`, `selfie`, + `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. maxLength: 5000 type: string @@ -73072,6 +73851,7 @@ paths: - finance_report_run - identity_document - identity_document_downloadable + - issuing_regulatory_reporting - pci_document - selfie - sigma_scheduled_query @@ -73219,6 +73999,7 @@ paths: - customer_signature - dispute_evidence - identity_document + - issuing_regulatory_reporting - pci_document - tax_document_user_upload - terminal_reader_splashscreen @@ -74725,6 +75506,13 @@ paths: schema: type: integer style: form + - in: query + name: related_customer + required: false + schema: + maxLength: 5000 + type: string + style: form - 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 @@ -74906,6 +75694,10 @@ paths: type: string title: provided_details_param type: object + related_customer: + description: Token referencing a Customer resource. + maxLength: 5000 + type: string return_url: description: >- The URL that the user will be redirected to upon completing @@ -75158,7 +75950,311 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/identity.verification_session' + $ref: '#/components/schemas/identity.verification_session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/identity/verification_sessions/{session}/redact': + post: + description: >- +

Redact a VerificationSession to remove all collected information from + Stripe. This will redact + + the VerificationSession and all objects related to it, including + VerificationReports, Events, + + request logs, etc.

+ + +

A VerificationSession object can be redacted when it is in + requires_input or verified + + status. Redacting a + VerificationSession in requires_action + + state will automatically cancel it.

+ + +

The redaction process may take up to four days. When the redaction + process is in progress, the + + VerificationSession’s redaction.status field will be set to + processing; when the process is + + finished, it will change to redacted and an + identity.verification_session.redacted event + + will be emitted.

+ + +

Redaction is irreversible. Redacted objects are still accessible in + the Stripe API, but all the + + fields that contain personal data will be replaced by the string + [redacted] or a similar + + placeholder. The metadata field will also be erased. + Redacted objects cannot be updated or + + used for any purpose.

+ + +

Learn + more.

+ operationId: PostIdentityVerificationSessionsSessionRedact + parameters: + - in: path + name: session + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + 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 + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/identity.verification_session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/invoice_rendering_templates: + get: + description: >- +

List all templates, ordered by creation date, with the most recently + created template appearing first.

+ operationId: GetInvoiceRenderingTemplates + parameters: + - 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. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - in: query + name: status + required: false + schema: + enum: + - active + - archived + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/invoice_rendering_template' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: InvoiceRenderingTemplatesList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/invoice_rendering_templates/{template}': + get: + description: >- +

Retrieves an invoice rendering template with the given ID. It by + default returns the latest version of the template. Optionally, specify + a version to see previous versions.

+ operationId: GetInvoiceRenderingTemplatesTemplate + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: template + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: query + name: version + required: false + schema: + type: integer + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice_rendering_template' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/invoice_rendering_templates/{template}/archive': + post: + description: >- +

Updates the status of an invoice rendering template to ‘archived’ so + no new Stripe objects (customers, invoices, etc.) can reference it. The + template can also no longer be updated. However, if the template is + already set on a Stripe object, it will continue to be applied on + invoices generated by it.

+ operationId: PostInvoiceRenderingTemplatesTemplateArchive + parameters: + - in: path + name: template + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + 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 + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice_rendering_template' description: Successful response. default: content: @@ -75166,57 +76262,15 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/identity/verification_sessions/{session}/redact': + '/v1/invoice_rendering_templates/{template}/unarchive': post: description: >- -

Redact a VerificationSession to remove all collected information from - Stripe. This will redact - - the VerificationSession and all objects related to it, including - VerificationReports, Events, - - request logs, etc.

- - -

A VerificationSession object can be redacted when it is in - requires_input or verified - - status. Redacting a - VerificationSession in requires_action - - state will automatically cancel it.

- - -

The redaction process may take up to four days. When the redaction - process is in progress, the - - VerificationSession’s redaction.status field will be set to - processing; when the process is - - finished, it will change to redacted and an - identity.verification_session.redacted event - - will be emitted.

- - -

Redaction is irreversible. Redacted objects are still accessible in - the Stripe API, but all the - - fields that contain personal data will be replaced by the string - [redacted] or a similar - - placeholder. The metadata field will also be erased. - Redacted objects cannot be updated or - - used for any purpose.

- - -

Learn - more.

- operationId: PostIdentityVerificationSessionsSessionRedact +

Unarchive an invoice rendering template so it can be used on new + Stripe objects again.

+ operationId: PostInvoiceRenderingTemplatesTemplateUnarchive parameters: - in: path - name: session + name: template required: true schema: maxLength: 5000 @@ -75245,7 +76299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/identity.verification_session' + $ref: '#/components/schemas/invoice_rendering_template' description: Successful response. default: content: @@ -76563,8 +77617,6 @@ paths: type: string x-stripeBypassValidation: true required: - - count - - interval - type title: installment_plan type: object @@ -76750,6 +77802,15 @@ paths: type: string title: rendering_pdf_param type: object + template: + maxLength: 5000 + type: string + template_version: + anyOf: + - type: integer + - enum: + - '' + type: string title: rendering_param type: object shipping_cost: @@ -77175,6 +78236,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -77264,7 +78326,7 @@ paths: invoice_items: description: >- List of invoice items to add or update in the upcoming - invoice preview. + invoice preview (up to 250). items: properties: amount: @@ -78295,6 +79357,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -78393,7 +79456,7 @@ paths: style: deepObject - description: >- List of invoice items to add or update in the upcoming invoice - preview. + preview (up to 250). explode: true in: query name: invoice_items @@ -79603,6 +80666,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -79714,7 +80778,7 @@ paths: style: deepObject - description: >- List of invoice items to add or update in the upcoming invoice - preview. + preview (up to 250). explode: true in: query name: invoice_items @@ -81265,8 +82329,6 @@ paths: type: string x-stripeBypassValidation: true required: - - count - - interval - type title: installment_plan type: object @@ -81443,6 +82505,15 @@ paths: type: string title: rendering_pdf_param type: object + template: + maxLength: 5000 + type: string + template_version: + anyOf: + - type: integer + - enum: + - '' + type: string title: rendering_param type: object shipping_cost: @@ -90746,6 +91817,7 @@ paths: - capture - refund type: string + x-stripeBypassValidation: true style: form requestBody: content: @@ -91842,7 +92914,7 @@ paths: Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. maxLength: 5000 @@ -92582,6 +93654,10 @@ paths: bacs_debit: anyOf: - properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object setup_future_usage: enum: - '' @@ -92589,7 +93665,7 @@ paths: - off_session - on_session type: string - title: payment_method_options_param + title: payment_intent_payment_method_options_param type: object - enum: - '' @@ -92679,8 +93755,6 @@ paths: type: string x-stripeBypassValidation: true required: - - count - - interval - type title: installment_plan type: object @@ -92741,6 +93815,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -93578,28 +94653,26 @@ paths: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) - to the PaymentIntent's Customer, if present, after the - PaymentIntent is confirmed and any required actions from the - user are complete. If no Customer was provided, the payment - method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) - to a Customer after the transaction completes. + If you provide a Customer with the PaymentIntent, you can + use this parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after + the PaymentIntent is confirmed and the customer completes + any required actions. If you don't provide a Customer, you + can still [attach](/api/payment_methods/attach) the payment + method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital - wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached - to the Customer instead. + wallet, Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer + instead. - When processing card payments, Stripe also uses - `setup_future_usage` to dynamically optimize your payment - flow and comply with regional legislation and network rules, - such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses + `setup_future_usage` to help you comply with regional + legislation and network rules, such as + [SCA](/strong-customer-authentication). enum: - off_session - on_session @@ -93648,21 +94721,27 @@ paths: type: object statement_descriptor: description: >- - For card charges, use - [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). - Otherwise, you can use this value as the complete - description of a charge on your customers' statements. It - must contain at least one letter and be 1–22 characters - long. + Text that appears on the customer's statement as the + statement descriptor for a non-card charge. This value + overrides the account's default statement descriptor. For + information about requirements, including the 22-character + limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + Setting this value for a card charge returns an error. For + card charges, set the + [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) + instead. maxLength: 22 type: string statement_descriptor_suffix: description: >- - Provides information about a card payment that customers see - on their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the - account to form the complete statement descriptor. The - concatenated descriptor must contain 1-22 characters. + Provides information about a card charge. Concatenated to + the account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on + the customer's statement. maxLength: 22 type: string transfer_data: @@ -94015,7 +95094,7 @@ paths: Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. maxLength: 5000 @@ -94669,6 +95748,10 @@ paths: bacs_debit: anyOf: - properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object setup_future_usage: enum: - '' @@ -94676,7 +95759,7 @@ paths: - off_session - on_session type: string - title: payment_method_options_param + title: payment_intent_payment_method_options_param type: object - enum: - '' @@ -94766,8 +95849,6 @@ paths: type: string x-stripeBypassValidation: true required: - - count - - interval - type title: installment_plan type: object @@ -94828,6 +95909,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -95650,31 +96732,29 @@ paths: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) - to the PaymentIntent's Customer, if present, after the - PaymentIntent is confirmed and any required actions from the - user are complete. If no Customer was provided, the payment - method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) - to a Customer after the transaction completes. + If you provide a Customer with the PaymentIntent, you can + use this parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after + the PaymentIntent is confirmed and the customer completes + any required actions. If you don't provide a Customer, you + can still [attach](/api/payment_methods/attach) the payment + method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital - wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached - to the Customer instead. + wallet, Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer + instead. - When processing card payments, Stripe also uses - `setup_future_usage` to dynamically optimize your payment - flow and comply with regional legislation and network rules, - such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses + `setup_future_usage` to help you comply with regional + legislation and network rules, such as + [SCA](/strong-customer-authentication). - If `setup_future_usage` is already set and you are + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. enum: @@ -95730,21 +96810,27 @@ paths: description: Shipping information for this PaymentIntent. statement_descriptor: description: >- - For card charges, use - [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). - Otherwise, you can use this value as the complete - description of a charge on your customers' statements. It - must contain at least one letter and be 1–22 characters - long. + Text that appears on the customer's statement as the + statement descriptor for a non-card charge. This value + overrides the account's default statement descriptor. For + information about requirements, including the 22-character + limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + Setting this value for a card charge returns an error. For + card charges, set the + [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) + instead. maxLength: 22 type: string statement_descriptor_suffix: description: >- - Provides information about a card payment that customers see - on their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the - account to form the complete statement descriptor. Maximum - 22 characters for the concatenated descriptor. + Provides information about a card charge. Concatenated to + the account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on + the customer's statement. maxLength: 22 type: string transfer_data: @@ -96013,21 +97099,27 @@ paths: value to `metadata`. statement_descriptor: description: >- - For card charges, use - [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). - Otherwise, you can use this value as the complete - description of a charge on your customers' statements. It - must contain at least one letter and be 1–22 characters - long. + Text that appears on the customer's statement as the + statement descriptor for a non-card charge. This value + overrides the account's default statement descriptor. For + information about requirements, including the 22-character + limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). + + + Setting this value for a card charge returns an error. For + card charges, set the + [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) + instead. maxLength: 22 type: string statement_descriptor_suffix: description: >- - Provides information about a card payment that customers see - on their statements. Concatenated with the prefix (shortened - descriptor) or statement descriptor that’s set on the - account to form the complete statement descriptor. The - concatenated descriptor must be 1-22 characters long. + Provides information about a card charge. Concatenated to + the account's [statement descriptor + prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) + to form the complete statement descriptor that appears on + the customer's statement. maxLength: 22 type: string transfer_data: @@ -96114,7 +97206,14 @@ paths: explicitly re-confirm the PaymentIntent to initiate the next payment - attempt.

+ attempt. + + There is a variable upper limit on how many times a PaymentIntent can be + confirmed. + + After this limit is reached, any further calls to this endpoint will + + transition the PaymentIntent to the canceled state.

operationId: PostPaymentIntentsIntentConfirm parameters: - in: path @@ -96897,6 +97996,10 @@ paths: bacs_debit: anyOf: - properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object setup_future_usage: enum: - '' @@ -96904,7 +98007,7 @@ paths: - off_session - on_session type: string - title: payment_method_options_param + title: payment_intent_payment_method_options_param type: object - enum: - '' @@ -96994,8 +98097,6 @@ paths: type: string x-stripeBypassValidation: true required: - - count - - interval - type title: installment_plan type: object @@ -97056,6 +98157,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -97900,31 +99002,29 @@ paths: PaymentIntent's payment method. - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) - to the PaymentIntent's Customer, if present, after the - PaymentIntent is confirmed and any required actions from the - user are complete. If no Customer was provided, the payment - method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) - to a Customer after the transaction completes. + If you provide a Customer with the PaymentIntent, you can + use this parameter to [attach the payment + method](/payments/save-during-payment) to the Customer after + the PaymentIntent is confirmed and the customer completes + any required actions. If you don't provide a Customer, you + can still [attach](/api/payment_methods/attach) the payment + method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital - wallet, then a - [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) - payment method representing the card is created and attached - to the Customer instead. + wallet, Stripe creates and attaches a + [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card to the Customer + instead. - When processing card payments, Stripe also uses - `setup_future_usage` to dynamically optimize your payment - flow and comply with regional legislation and network rules, - such as - [SCA](https://stripe.com/docs/strong-customer-authentication). + When processing card payments, Stripe uses + `setup_future_usage` to help you comply with regional + legislation and network rules, such as + [SCA](/strong-customer-authentication). - If `setup_future_usage` is already set and you are + If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`. enum: @@ -98121,12 +99221,12 @@ paths: type: object statement_descriptor: description: >- - For card charges, use - [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). - Otherwise, you can use this value as the complete - description of a charge on your customers' statements. It - must contain at least one letter and be 1–22 characters - long. + Text that appears on the customer's statement as the + statement descriptor for a non-card or card charge. This + value overrides the account's default statement descriptor. + For information about requirements, including the + 22-character limit, see [the Statement Descriptor + docs](https://docs.stripe.com/get-started/account/statement-descriptors). maxLength: 22 type: string transfer_data: @@ -99259,6 +100359,11 @@ paths: properties: enabled: type: boolean + required: + enum: + - if_supported + - never + type: string required: - enabled title: tax_id_collection_params @@ -100205,6 +101310,11 @@ paths: properties: enabled: type: boolean + required: + enum: + - if_supported + - never + type: string required: - enabled title: tax_id_collection_params @@ -108011,9 +109121,7 @@ paths: - enum: - '' type: string - description: >- - The discounts applied to the quote. You can only set up to - one discount. + description: The discounts applied to the quote. expand: description: Specifies which fields in the response should be expanded. items: @@ -108480,9 +109588,7 @@ paths: - enum: - '' type: string - description: >- - The discounts applied to the quote. You can only set up to - one discount. + description: The discounts applied to the quote. expand: description: Specifies which fields in the response should be expanded. items: @@ -109081,7 +110187,7 @@ paths: description: >-

Download the PDF for a finalized quote. Explanation for special handling can be found here

+ href="https://docs.stripe.com/quotes/overview#quote_pdf">here

operationId: GetQuotesQuotePdf parameters: - description: Specifies which fields in the response should be expanded. @@ -112668,6 +113774,14 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + bacs_debit: + properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -112725,6 +113839,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -113664,6 +114779,14 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + bacs_debit: + properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -113721,6 +114844,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -114654,6 +115778,14 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + bacs_debit: + properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -114711,6 +115843,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -118960,7 +120093,10 @@ paths: type: object - type: integer style: deepObject - - explode: true + - description: >- + Only return subscriptions whose current_period_end falls within the + given date interval. + explode: true in: query name: current_period_end required: false @@ -118979,7 +120115,10 @@ paths: type: object - type: integer style: deepObject - - explode: true + - description: >- + Only return subscriptions whose current_period_start falls within + the given date interval. + explode: true in: query name: current_period_start required: false @@ -119799,6 +120938,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -119985,7 +121125,7 @@ paths: given subscription at the specified interval. promotion_code: description: >- - The ID of a promotion code to apply to this subscription. A + The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future @@ -121092,6 +122232,7 @@ paths: - diners - discover - eftpos_au + - girocard - interac - jcb - mastercard @@ -121280,7 +122421,9 @@ paths: description: >- The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect - invoices created for that particular subscription. + invoices created for that particular subscription. This + field has been deprecated and will be removed in a future + API version. Use `discounts` instead. maxLength: 5000 type: string proration_behavior: @@ -121643,6 +122786,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -121830,6 +122974,53 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/tax/calculations/{calculation}': + get: + description: >- +

Retrieves a Tax Calculation object, if the calculation + hasn’t expired.

+ operationId: GetTaxCalculationsCalculation + parameters: + - in: path + name: calculation + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax.calculation' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/tax/calculations/{calculation}/line_items': get: description: >- @@ -123044,6 +124235,29 @@ paths: state: maxLength: 5000 type: string + state_sales_tax: + properties: + elections: + items: + properties: + jurisdiction: + maxLength: 5000 + type: string + type: + enum: + - local_use_tax + - simplified_sellers_use_tax + - single_local_use_tax + type: string + required: + - type + title: state_sales_tax_election + type: object + type: array + required: + - elections + title: state_sales_tax + type: object type: enum: - local_amusement_tax @@ -124063,14 +125277,14 @@ paths: `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, - `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, - `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, - `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, - `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, - `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, - `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, - `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, - or `za_vat` + `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, + `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, + `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, + `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, + `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, + `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, + `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, + `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn @@ -124104,6 +125318,7 @@ paths: - gb_vat - ge_vat - hk_br + - hr_oib - hu_tin - id_npwp - il_vat @@ -125753,10 +126968,10 @@ paths: description: >- The ID of a configuration that will be used to customize all readers in this location. - maxLength: 1000 + maxLength: 500 type: string display_name: - description: A name for the location. + description: A name for the location. Maximum length is 1000 characters. maxLength: 1000 type: string expand: @@ -126527,7 +127742,6 @@ paths: maxLength: 5000 type: string required: - - customer_consent_collected - setup_intent type: object required: true @@ -128885,6 +130099,86 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/test_helpers/issuing/settlements: + post: + description:

Allows the user to create an Issuing settlement.

+ operationId: PostTestHelpersIssuingSettlements + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + bin: + description: >- + The Bank Identification Number reflecting this settlement + record. + maxLength: 5000 + type: string + clearing_date: + description: >- + The date that the transactions are cleared and posted to + user's accounts. + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + interchange_fees: + description: >- + The total interchange received as reimbursement for the + transactions. + type: integer + net_total: + description: The total net amount required to settle with the network. + type: integer + network_settlement_identifier: + description: >- + The Settlement Identification Number assigned by the + network. + maxLength: 5000 + type: string + transaction_count: + description: >- + The total number of transactions reflected in this + settlement. + type: integer + transaction_volume: + description: The total transaction amount reflected in this settlement. + type: integer + required: + - bin + - clearing_date + - currency + - net_total + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.settlement' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/test_helpers/issuing/transactions/create_force_capture: post: description: >- @@ -130699,6 +131993,9 @@ paths: type: string us_domestic_wire: properties: + chips: + maxLength: 5000 + type: string imad: maxLength: 5000 type: string @@ -130940,6 +132237,9 @@ paths: type: string us_domestic_wire: properties: + chips: + maxLength: 5000 + type: string imad: maxLength: 5000 type: string @@ -132840,8 +134140,10 @@ paths: type: integer currency: description: >- - 3-letter [ISO code for - currency](https://stripe.com/docs/payouts). + Three-letter [ISO code for + currency](https://www.iso.org/iso-4217-currency-codes.html) + in lowercase. Must be a [supported + currency](https://docs.stripe.com/currencies). type: string description: description: >- diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json index f5d54845f..73cafa4c7 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.16.0", + "@redocly/openapi-core": "^1.25.3", "ansi-colors": "^4.1.3", "change-case": "^5.4.4", "parse-json": "^8.1.0", @@ -75,7 +75,7 @@ "esbuild": "^0.20.2", "execa": "^8.0.1", "strip-ansi": "^7.1.0", - "typescript": "^5.5.4", - "vite-node": "^2.0.5" + "typescript": "^5.6.2", + "vite-node": "^2.1.1" } } diff --git a/packages/openapi-typescript/test/node-api.test.ts b/packages/openapi-typescript/test/node-api.test.ts index e476552a6..b0ff0c8f3 100644 --- a/packages/openapi-typescript/test/node-api.test.ts +++ b/packages/openapi-typescript/test/node-api.test.ts @@ -902,7 +902,7 @@ export type operations = Record;`, given: new URL("./github-api.yaml", EXAMPLES_DIR), want: new URL("./github-api.ts", EXAMPLES_DIR), // options: DEFAULT_OPTIONS, - ci: { timeout: 3_000 }, + ci: { timeout: 30_000 }, }, ], [ diff --git a/packages/openapi-typescript/vitest.config.ts b/packages/openapi-typescript/vitest.config.ts index 7c558a030..2e20c2d14 100644 --- a/packages/openapi-typescript/vitest.config.ts +++ b/packages/openapi-typescript/vitest.config.ts @@ -2,6 +2,7 @@ import { defineConfig } from "vitest/config"; export default defineConfig({ test: { + environment: "node", clearMocks: true, globals: true, }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e24438cdc..89f197c5e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -9,23 +9,23 @@ importers: .: devDependencies: '@biomejs/biome': - specifier: ^1.8.3 - version: 1.8.3 + specifier: ^1.9.2 + version: 1.9.2 '@changesets/changelog-github': specifier: ^0.5.0 version: 0.5.0 '@changesets/cli': - specifier: ^2.27.7 - version: 2.27.7 + specifier: ^2.27.8 + version: 2.27.8 '@playwright/test': - specifier: ^1.46.1 - version: 1.46.1 + specifier: ^1.47.1 + version: 1.47.1 '@size-limit/preset-small-lib': - specifier: ^11.1.4 - version: 11.1.4(size-limit@11.1.4) + specifier: ^11.1.5 + version: 11.1.5(size-limit@11.1.5) '@types/node': - specifier: ^22.5.2 - version: 22.5.2 + specifier: ^22.5.5 + version: 22.5.5 del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -33,20 +33,20 @@ importers: specifier: ^3.3.3 version: 3.3.3 size-limit: - specifier: ^11.1.4 - version: 11.1.4 + specifier: ^11.1.5 + version: 11.1.5 typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vitest: - specifier: ^2.0.5 - version: 2.0.5(@types/node@22.5.2)(jsdom@20.0.3) + specifier: ^2.1.1 + version: 2.1.1(@types/node@22.5.5)(jsdom@20.0.3)(msw@2.4.1(graphql@16.8.2)(typescript@5.6.2)) docs: devDependencies: vitepress: specifier: 1.3.2 - version: 1.3.2(@algolia/client-search@4.24.0)(@types/node@22.5.2)(@types/react@18.3.3)(axios@1.7.7)(postcss@8.4.44)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.5.4) + version: 1.3.2(@algolia/client-search@4.24.0)(@types/node@22.5.5)(@types/react@18.3.8)(axios@1.7.7)(postcss@8.4.47)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.6.2) packages/openapi-fetch: dependencies: @@ -82,17 +82,17 @@ importers: specifier: ^10.1.0 version: 10.1.0 typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vite: - specifier: ^5.4.2 - version: 5.4.2(@types/node@22.5.2) + specifier: ^5.4.6 + version: 5.4.6(@types/node@22.5.5) packages/openapi-fetch/examples/nextjs: dependencies: next: specifier: 14.2.3 - version: 14.2.3(@playwright/test@1.46.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + version: 14.2.3(@playwright/test@1.47.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) openapi-fetch: specifier: workspace:^ version: link:../.. @@ -104,8 +104,8 @@ importers: version: 18.3.1(react@18.3.1) devDependencies: '@types/react': - specifier: ^18.3.3 - version: 18.3.3 + specifier: ^18.3.8 + version: 18.3.8 '@types/react-dom': specifier: ^18.3.0 version: 18.3.0 @@ -119,8 +119,8 @@ importers: packages/openapi-fetch/examples/react-query: dependencies: '@tanstack/react-query': - specifier: ^5.53.3 - version: 5.53.3(react@18.3.1) + specifier: ^5.56.2 + version: 5.56.2(react@18.3.1) openapi-fetch: specifier: workspace:^ version: link:../.. @@ -142,13 +142,13 @@ importers: version: 18.3.0 '@vitejs/plugin-react-swc': specifier: ^3.7.0 - version: 3.7.0(@swc/helpers@0.5.5)(vite@5.4.3(@types/node@22.5.2)) + version: 3.7.0(@swc/helpers@0.5.5)(vite@5.4.6(@types/node@22.5.5)) typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vite: - specifier: ^5.4.3 - version: 5.4.3(@types/node@22.5.2) + specifier: ^5.4.6 + version: 5.4.6(@types/node@22.5.5) packages/openapi-fetch/examples/sveltekit: dependencies: @@ -157,14 +157,14 @@ importers: version: link:../.. devDependencies: '@sveltejs/adapter-auto': - specifier: ^3.2.4 - version: 3.2.4(@sveltejs/kit@2.5.25(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2))) + specifier: ^3.2.5 + version: 3.2.5(@sveltejs/kit@2.5.28(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5))) '@sveltejs/kit': - specifier: ^2.5.25 - version: 2.5.25(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) + specifier: ^2.5.28 + version: 2.5.28(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) '@sveltejs/vite-plugin-svelte': specifier: ^3.1.2 - version: 3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) + version: 3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) openapi-typescript: specifier: workspace:^ version: link:../../../openapi-typescript @@ -173,16 +173,16 @@ importers: version: 4.2.19 svelte-check: specifier: ^3.8.6 - version: 3.8.6(@babel/core@7.25.2)(postcss@8.4.44)(svelte@4.2.19) + version: 3.8.6(@babel/core@7.25.2)(postcss@8.4.47)(svelte@4.2.19) tslib: specifier: ^2.7.0 version: 2.7.0 typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vite: - specifier: ^5.4.3 - version: 5.4.3(@types/node@22.5.2) + specifier: ^5.4.6 + version: 5.4.6(@types/node@22.5.5) packages/openapi-fetch/examples/vue-3: dependencies: @@ -190,15 +190,15 @@ importers: specifier: workspace:^ version: link:../.. vue: - specifier: ^3.5.0 - version: 3.5.0(typescript@5.5.4) + specifier: ^3.5.6 + version: 3.5.6(typescript@5.6.2) devDependencies: '@tsconfig/node20': specifier: ^20.1.4 version: 20.1.4 '@vitejs/plugin-vue': - specifier: ^5.1.3 - version: 5.1.3(vite@5.4.3(@types/node@22.5.2))(vue@3.5.0(typescript@5.5.4)) + specifier: ^5.1.4 + version: 5.1.4(vite@5.4.6(@types/node@22.5.5))(vue@3.5.6(typescript@5.6.2)) '@vue/tsconfig': specifier: ^0.5.1 version: 0.5.1 @@ -206,23 +206,20 @@ importers: specifier: workspace:^ version: link:../../../openapi-typescript typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vite: - specifier: ^5.4.3 - version: 5.4.3(@types/node@22.5.2) + specifier: ^5.4.6 + version: 5.4.6(@types/node@22.5.5) vue-tsc: - specifier: ^2.1.4 - version: 2.1.4(typescript@5.5.4) + specifier: ^2.1.6 + version: 2.1.6(typescript@5.6.2) packages/openapi-react-query: dependencies: '@tanstack/react-query': specifier: ^5.0.0 version: 5.53.3(react@18.3.1) - openapi-fetch: - specifier: workspace:^ - version: link:../openapi-fetch openapi-typescript-helpers: specifier: workspace:^ version: link:../openapi-typescript-helpers @@ -235,7 +232,7 @@ importers: version: 18.3.1 '@vitejs/plugin-react': specifier: ^4.3.1 - version: 4.3.1(vite@5.4.3(@types/node@22.5.2)) + version: 4.3.1(vite@5.4.6(@types/node@22.5.5)) del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -247,7 +244,10 @@ importers: version: 8.0.1 msw: specifier: ^2.4.1 - version: 2.4.1(graphql@16.8.2)(typescript@5.5.4) + version: 2.4.1(graphql@16.8.2)(typescript@5.6.2) + openapi-fetch: + specifier: workspace:^ + version: link:../openapi-fetch openapi-typescript: specifier: workspace:^ version: link:../openapi-typescript @@ -261,8 +261,8 @@ importers: packages/openapi-typescript: dependencies: '@redocly/openapi-core': - specifier: ^1.16.0 - version: 1.16.0(supports-color@9.4.0) + specifier: ^1.25.3 + version: 1.25.3(supports-color@9.4.0) ansi-colors: specifier: ^4.1.3 version: 4.1.3 @@ -301,11 +301,11 @@ importers: specifier: ^7.1.0 version: 7.1.0 typescript: - specifier: ^5.5.4 - version: 5.5.4 + specifier: ^5.6.2 + version: 5.6.2 vite-node: - specifier: ^2.0.5 - version: 2.0.5(@types/node@22.5.2)(supports-color@9.4.0) + specifier: ^2.1.1 + version: 2.1.1(@types/node@22.5.5)(supports-color@9.4.0) packages/openapi-typescript-helpers: devDependencies: @@ -478,55 +478,55 @@ packages: resolution: {integrity: sha512-/l42B1qxpG6RdfYf343Uw1vmDjeNhneUXtzhojE7pDgfpEypmRhI6j1kr17XCVv4Cgl9HdAiQY2x0GwKm7rWCw==} engines: {node: '>=6.9.0'} - '@biomejs/biome@1.8.3': - resolution: {integrity: sha512-/uUV3MV+vyAczO+vKrPdOW0Iaet7UnJMU4bNMinggGJTAnBPjCoLEYcyYtYHNnUNYlv4xZMH6hVIQCAozq8d5w==} + '@biomejs/biome@1.9.2': + resolution: {integrity: sha512-4j2Gfwft8Jqp1X0qLYvK4TEy4xhTo4o6rlvJPsjPeEame8gsmbGQfOPBkw7ur+7/Z/f0HZmCZKqbMvR7vTXQYQ==} engines: {node: '>=14.21.3'} hasBin: true - '@biomejs/cli-darwin-arm64@1.8.3': - resolution: {integrity: sha512-9DYOjclFpKrH/m1Oz75SSExR8VKvNSSsLnVIqdnKexj6NwmiMlKk94Wa1kZEdv6MCOHGHgyyoV57Cw8WzL5n3A==} + '@biomejs/cli-darwin-arm64@1.9.2': + resolution: {integrity: sha512-rbs9uJHFmhqB3Td0Ro+1wmeZOHhAPTL3WHr8NtaVczUmDhXkRDWScaxicG9+vhSLj1iLrW47itiK6xiIJy6vaA==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [darwin] - '@biomejs/cli-darwin-x64@1.8.3': - resolution: {integrity: sha512-UeW44L/AtbmOF7KXLCoM+9PSgPo0IDcyEUfIoOXYeANaNXXf9mLUwV1GeF2OWjyic5zj6CnAJ9uzk2LT3v/wAw==} + '@biomejs/cli-darwin-x64@1.9.2': + resolution: {integrity: sha512-BlfULKijNaMigQ9GH9fqJVt+3JTDOSiZeWOQtG/1S1sa8Lp046JHG3wRJVOvekTPL9q/CNFW1NVG8J0JN+L1OA==} engines: {node: '>=14.21.3'} cpu: [x64] os: [darwin] - '@biomejs/cli-linux-arm64-musl@1.8.3': - resolution: {integrity: sha512-9yjUfOFN7wrYsXt/T/gEWfvVxKlnh3yBpnScw98IF+oOeCYb5/b/+K7YNqKROV2i1DlMjg9g/EcN9wvj+NkMuQ==} + '@biomejs/cli-linux-arm64-musl@1.9.2': + resolution: {integrity: sha512-ZATvbUWhNxegSALUnCKWqetTZqrK72r2RsFD19OK5jXDj/7o1hzI1KzDNG78LloZxftrwr3uI9SqCLh06shSZw==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [linux] - '@biomejs/cli-linux-arm64@1.8.3': - resolution: {integrity: sha512-fed2ji8s+I/m8upWpTJGanqiJ0rnlHOK3DdxsyVLZQ8ClY6qLuPc9uehCREBifRJLl/iJyQpHIRufLDeotsPtw==} + '@biomejs/cli-linux-arm64@1.9.2': + resolution: {integrity: sha512-T8TJuSxuBDeQCQzxZu2o3OU4eyLumTofhCxxFd3+aH2AEWVMnH7Z/c3QP1lHI5RRMBP9xIJeMORqDQ5j+gVZzw==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [linux] - '@biomejs/cli-linux-x64-musl@1.8.3': - resolution: {integrity: sha512-UHrGJX7PrKMKzPGoEsooKC9jXJMa28TUSMjcIlbDnIO4EAavCoVmNQaIuUSH0Ls2mpGMwUIf+aZJv657zfWWjA==} + '@biomejs/cli-linux-x64-musl@1.9.2': + resolution: {integrity: sha512-CjPM6jT1miV5pry9C7qv8YJk0FIZvZd86QRD3atvDgfgeh9WQU0k2Aoo0xUcPdTnoz0WNwRtDicHxwik63MmSg==} engines: {node: '>=14.21.3'} cpu: [x64] os: [linux] - '@biomejs/cli-linux-x64@1.8.3': - resolution: {integrity: sha512-I8G2QmuE1teISyT8ie1HXsjFRz9L1m5n83U1O6m30Kw+kPMPSKjag6QGUn+sXT8V+XWIZxFFBoTDEDZW2KPDDw==} + '@biomejs/cli-linux-x64@1.9.2': + resolution: {integrity: sha512-T0cPk3C3Jr2pVlsuQVTBqk2qPjTm8cYcTD9p/wmR9MeVqui1C/xTVfOIwd3miRODFMrJaVQ8MYSXnVIhV9jTjg==} engines: {node: '>=14.21.3'} cpu: [x64] os: [linux] - '@biomejs/cli-win32-arm64@1.8.3': - resolution: {integrity: sha512-J+Hu9WvrBevfy06eU1Na0lpc7uR9tibm9maHynLIoAjLZpQU3IW+OKHUtyL8p6/3pT2Ju5t5emReeIS2SAxhkQ==} + '@biomejs/cli-win32-arm64@1.9.2': + resolution: {integrity: sha512-2x7gSty75bNIeD23ZRPXyox6Z/V0M71ObeJtvQBhi1fgrvPdtkEuw7/0wEHg6buNCubzOFuN9WYJm6FKoUHfhg==} engines: {node: '>=14.21.3'} cpu: [arm64] os: [win32] - '@biomejs/cli-win32-x64@1.8.3': - resolution: {integrity: sha512-/PJ59vA1pnQeKahemaQf4Nyj7IKUvGQSc3Ze1uIGi+Wvr1xF7rGobSrAAG01T/gUDG21vkDsZYM03NAmPiVkqg==} + '@biomejs/cli-win32-x64@1.9.2': + resolution: {integrity: sha512-JC3XvdYcjmu1FmAehVwVV0SebLpeNTnO2ZaMdGCSOdS7f8O9Fq14T2P1gTG1Q29Q8Dt1S03hh0IdVpIZykOL8g==} engines: {node: '>=14.21.3'} cpu: [x64] os: [win32] @@ -546,11 +546,11 @@ packages: '@bundled-es-modules/tough-cookie@0.1.6': resolution: {integrity: sha512-dvMHbL464C0zI+Yqxbz6kZ5TOEp7GLW+pry/RWndAR8MJQAXZ2rPmIs8tziTZjeIyhSNZgZbCePtfSbdWqStJw==} - '@changesets/apply-release-plan@7.0.4': - resolution: {integrity: sha512-HLFwhKWayKinWAul0Vj+76jVx1Pc2v55MGPVjZ924Y/ROeSsBMFutv9heHmCUj48lJyRfOTJG5+ar+29FUky/A==} + '@changesets/apply-release-plan@7.0.5': + resolution: {integrity: sha512-1cWCk+ZshEkSVEZrm2fSj1Gz8sYvxgUL4Q78+1ZZqeqfuevPTPk033/yUZ3df8BKMohkqqHfzj0HOOrG0KtXTw==} - '@changesets/assemble-release-plan@6.0.3': - resolution: {integrity: sha512-bLNh9/Lgl1VwkjWZTq8JmRqH+hj7/Yzfz0jsQ/zJJ+FTmVqmqPj3szeKOri8O/hEM8JmHW019vh2gTO9iq5Cuw==} + '@changesets/assemble-release-plan@6.0.4': + resolution: {integrity: sha512-nqICnvmrwWj4w2x0fOhVj2QEGdlUuwVAwESrUo5HLzWMI1rE5SWfsr9ln+rDqWB6RQ2ZyaMZHUcU7/IRaUJS+Q==} '@changesets/changelog-git@0.2.0': resolution: {integrity: sha512-bHOx97iFI4OClIT35Lok3sJAwM31VbUM++gnMBV16fdbtBhgYu4dxsphBF/0AZZsyAHMrnM0yFcj5gZM1py6uQ==} @@ -558,45 +558,45 @@ packages: '@changesets/changelog-github@0.5.0': resolution: {integrity: sha512-zoeq2LJJVcPJcIotHRJEEA2qCqX0AQIeFE+L21L8sRLPVqDhSXY8ZWAt2sohtBpFZkBwu+LUwMSKRr2lMy3LJA==} - '@changesets/cli@2.27.7': - resolution: {integrity: sha512-6lr8JltiiXPIjDeYg4iM2MeePP6VN/JkmqBsVA5XRiy01hGS3y629LtSDvKcycj/w/5Eur1rEwby/MjcYS+e2A==} + '@changesets/cli@2.27.8': + resolution: {integrity: sha512-gZNyh+LdSsI82wBSHLQ3QN5J30P4uHKJ4fXgoGwQxfXwYFTJzDdvIJasZn8rYQtmKhyQuiBj4SSnLuKlxKWq4w==} hasBin: true - '@changesets/config@3.0.2': - resolution: {integrity: sha512-cdEhS4t8woKCX2M8AotcV2BOWnBp09sqICxKapgLHf9m5KdENpWjyrFNMjkLqGJtUys9U+w93OxWT0czorVDfw==} + '@changesets/config@3.0.3': + resolution: {integrity: sha512-vqgQZMyIcuIpw9nqFIpTSNyc/wgm/Lu1zKN5vECy74u95Qx/Wa9g27HdgO4NkVAaq+BGA8wUc/qvbvVNs93n6A==} '@changesets/errors@0.2.0': resolution: {integrity: sha512-6BLOQUscTpZeGljvyQXlWOItQyU71kCdGz7Pi8H8zdw6BI0g3m43iL4xKUVPWtG+qrrL9DTjpdn8eYuCQSRpow==} - '@changesets/get-dependents-graph@2.1.1': - resolution: {integrity: sha512-LRFjjvigBSzfnPU2n/AhFsuWR5DK++1x47aq6qZ8dzYsPtS/I5mNhIGAS68IAxh1xjO9BTtz55FwefhANZ+FCA==} + '@changesets/get-dependents-graph@2.1.2': + resolution: {integrity: sha512-sgcHRkiBY9i4zWYBwlVyAjEM9sAzs4wYVwJUdnbDLnVG3QwAaia1Mk5P8M7kraTOZN+vBET7n8KyB0YXCbFRLQ==} '@changesets/get-github-info@0.6.0': resolution: {integrity: sha512-v/TSnFVXI8vzX9/w3DU2Ol+UlTZcu3m0kXTjTT4KlAdwSvwutcByYwyYn9hwerPWfPkT2JfpoX0KgvCEi8Q/SA==} - '@changesets/get-release-plan@4.0.3': - resolution: {integrity: sha512-6PLgvOIwTSdJPTtpdcr3sLtGatT+Jr22+cQwEBJBy6wP0rjB4yJ9lv583J9fVpn1bfQlBkDa8JxbS2g/n9lIyA==} + '@changesets/get-release-plan@4.0.4': + resolution: {integrity: sha512-SicG/S67JmPTrdcc9Vpu0wSQt7IiuN0dc8iR5VScnnTVPfIaLvKmEGRvIaF0kcn8u5ZqLbormZNTO77bCEvyWw==} '@changesets/get-version-range-type@0.4.0': resolution: {integrity: sha512-hwawtob9DryoGTpixy1D3ZXbGgJu1Rhr+ySH2PvTLHvkZuQ7sRT4oQwMh0hbqZH1weAooedEjRsbrWcGLCeyVQ==} - '@changesets/git@3.0.0': - resolution: {integrity: sha512-vvhnZDHe2eiBNRFHEgMiGd2CT+164dfYyrJDhwwxTVD/OW0FUD6G7+4DIx1dNwkwjHyzisxGAU96q0sVNBns0w==} + '@changesets/git@3.0.1': + resolution: {integrity: sha512-pdgHcYBLCPcLd82aRcuO0kxCDbw/yISlOtkmwmE8Odo1L6hSiZrBOsRl84eYG7DRCab/iHnOkWqExqc4wxk2LQ==} - '@changesets/logger@0.1.0': - resolution: {integrity: sha512-pBrJm4CQm9VqFVwWnSqKEfsS2ESnwqwH+xR7jETxIErZcfd1u2zBSqrHbRHR7xjhSgep9x2PSKFKY//FAshA3g==} + '@changesets/logger@0.1.1': + resolution: {integrity: sha512-OQtR36ZlnuTxKqoW4Sv6x5YIhOmClRd5pWsjZsddYxpWs517R0HkyiefQPIytCVh4ZcC5x9XaG8KTdd5iRQUfg==} '@changesets/parse@0.4.0': resolution: {integrity: sha512-TS/9KG2CdGXS27S+QxbZXgr8uPsP4yNJYb4BC2/NeFUj80Rni3TeD2qwWmabymxmrLo7JEsytXH1FbpKTbvivw==} - '@changesets/pre@2.0.0': - resolution: {integrity: sha512-HLTNYX/A4jZxc+Sq8D1AMBsv+1qD6rmmJtjsCJa/9MSRybdxh0mjbTvE6JYZQ/ZiQ0mMlDOlGPXTm9KLTU3jyw==} + '@changesets/pre@2.0.1': + resolution: {integrity: sha512-vvBJ/If4jKM4tPz9JdY2kGOgWmCowUYOi5Ycv8dyLnEE8FgpYYUo1mgJZxcdtGGP3aG8rAQulGLyyXGSLkIMTQ==} - '@changesets/read@0.6.0': - resolution: {integrity: sha512-ZypqX8+/im1Fm98K4YcZtmLKgjs1kDQ5zHpc2U1qdtNBmZZfo/IBiG162RoP0CUF05tvp2y4IspH11PLnPxuuw==} + '@changesets/read@0.6.1': + resolution: {integrity: sha512-jYMbyXQk3nwP25nRzQQGa1nKLY0KfoOV7VLgwucI0bUO8t8ZLCr6LZmgjXsiKuRDc+5A6doKPr9w2d+FEJ55zQ==} - '@changesets/should-skip-package@0.1.0': - resolution: {integrity: sha512-FxG6Mhjw7yFStlSM7Z0Gmg3RiyQ98d/9VpQAZ3Fzr59dCOM9G6ZdYbjiSAt0XtFr9JR5U2tBaJWPjrkGGc618g==} + '@changesets/should-skip-package@0.1.1': + resolution: {integrity: sha512-H9LjLbF6mMHLtJIc/eHR9Na+MifJ3VxtgP/Y+XLn4BF7tDTEN1HNYtH6QMcjP1uxp9sjaFYmW8xqloaCi/ckTg==} '@changesets/types@4.1.0': resolution: {integrity: sha512-LDQvVDv5Kb50ny2s25Fhm3d9QSZimsoUGBsUioj6MC3qbMUCuC8GPIvk/M6IvXx3lYhAs0lwWUQLb+VIEUCECw==} @@ -604,8 +604,8 @@ packages: '@changesets/types@6.0.0': resolution: {integrity: sha512-b1UkfNulgKoWfqyHtzKS5fOZYSJO+77adgL7DLRDr+/7jhChN+QcHnbjiQVOz/U+Ts3PGNySq7diAItzDgugfQ==} - '@changesets/write@0.3.1': - resolution: {integrity: sha512-SyGtMXzH3qFqlHKcvFY2eX+6b0NGiFcNav8AFsYwy5l8hejOeoeTDemu5Yjmke2V5jpzY+pBvM0vCCQ3gdZpfw==} + '@changesets/write@0.3.2': + resolution: {integrity: sha512-kDxDrPNpUgsjDbWBvUo27PzKX4gqeKOlhibaOXDJA6kuBisGqNHv/HwGJrAu8U/dSf8ZEFIeHIPtvSlZI1kULw==} '@docsearch/css@3.6.1': resolution: {integrity: sha512-VtVb5DS+0hRIprU2CO6ZQjK2Zg4QU5HrDM1+ix6rT0umsYvFvatMAnf97NHZlVWDaaLlx7GRfR/7FikANiM2Fg==} @@ -1175,138 +1175,146 @@ packages: '@open-draft/until@2.1.0': resolution: {integrity: sha512-U69T3ItWHvLwGg5eJ0n3I62nWuE6ilHlmz7zM0npLBRvPRd7e6NYmg54vvRtP5mZG7kZqZCFVdsTWo7BPtBujg==} - '@playwright/test@1.46.1': - resolution: {integrity: sha512-Fq6SwLujA/DOIvNC2EL/SojJnkKf/rAwJ//APpJJHRyMi1PdKrY3Az+4XNQ51N4RTbItbIByQ0jgd1tayq1aeA==} + '@playwright/test@1.47.1': + resolution: {integrity: sha512-dbWpcNQZ5nj16m+A5UNScYx7HX5trIy7g4phrcitn+Nk83S32EBX/CLU4hiF4RGKX/yRc93AAqtfaXB7JWBd4Q==} engines: {node: '>=18'} hasBin: true - '@polka/url@1.0.0-next.25': - resolution: {integrity: sha512-j7P6Rgr3mmtdkeDGTe0E/aYyWEWVtc5yFXtHCRHs28/jptDEWfaVOc5T7cblqy1XKPPfCxJc/8DwQ5YgLOZOVQ==} + '@polka/url@1.0.0-next.28': + resolution: {integrity: sha512-8LduaNlMZGwdZ6qWrKlfa+2M4gahzFkprZiAt2TF8uS0qQgBizKXpXURqvTJ4WtmupWxaLqjRb2UCTe72mu+Aw==} - '@redocly/ajv@8.11.0': - resolution: {integrity: sha512-9GWx27t7xWhDIR02PA18nzBdLcKQRgc46xNQvjFkrYk4UOmvKhJ/dawwiX0cCOeetN5LcaaiqQbVOWYK62SGHw==} + '@redocly/ajv@8.11.2': + resolution: {integrity: sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==} - '@redocly/config@0.6.0': - resolution: {integrity: sha512-hNVN3eTxFj2nHYX0gGzZxxXwdE0DXWeWou1TIK3HYf0S9VKVxTxjO9EZbMB7iVUqaHkeqy4PSjlBQcEgD0Ftjg==} + '@redocly/config@0.11.0': + resolution: {integrity: sha512-vAc77vCuWsVgLx2LN02P6jqLBhHuot6O1LsSJEAAkWEvXARSGSQVon50QW7jlbCMg9OFTYYYRPN4W6K/YmnM3w==} - '@redocly/openapi-core@1.16.0': - resolution: {integrity: sha512-z06h+svyqbUcdAaePq8LPSwTPlm6Ig7j2VlL8skPBYnJvyaQ2IN7x/JkOvRL4ta+wcOCBdAex5JWnZbKaNktJg==} + '@redocly/openapi-core@1.25.3': + resolution: {integrity: sha512-dqJkyydgagW3FXX5cjtSUAnabsld4K6yq7RFgQ+ngI1m43PkEoSQt8pp+SfQDszSEoMbc7QKj8afbe7mZw17TA==} engines: {node: '>=14.19.0', npm: '>=7.0.0'} - '@rollup/rollup-android-arm-eabi@4.21.2': - resolution: {integrity: sha512-fSuPrt0ZO8uXeS+xP3b+yYTCBUd05MoSp2N/MFOgjhhUhMmchXlpTQrTpI8T+YAwAQuK7MafsCOxW7VrPMrJcg==} + '@rollup/rollup-android-arm-eabi@4.22.2': + resolution: {integrity: sha512-8Ao+EDmTPjZ1ZBABc1ohN7Ylx7UIYcjReZinigedTOnGFhIctyGPxY2II+hJ6gD2/vkDKZTyQ0e7++kwv6wDrw==} cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.21.2': - resolution: {integrity: sha512-xGU5ZQmPlsjQS6tzTTGwMsnKUtu0WVbl0hYpTPauvbRAnmIvpInhJtgjj3mcuJpEiuUw4v1s4BimkdfDWlh7gA==} + '@rollup/rollup-android-arm64@4.22.2': + resolution: {integrity: sha512-I+B1v0a4iqdS9DvYt1RJZ3W+Oh9EVWjbY6gp79aAYipIbxSLEoQtFQlZEnUuwhDXCqMxJ3hluxKAdPD+GiluFQ==} cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.21.2': - resolution: {integrity: sha512-99AhQ3/ZMxU7jw34Sq8brzXqWH/bMnf7ZVhvLk9QU2cOepbQSVTns6qoErJmSiAvU3InRqC2RRZ5ovh1KN0d0Q==} + '@rollup/rollup-darwin-arm64@4.22.2': + resolution: {integrity: sha512-BTHO7rR+LC67OP7I8N8GvdvnQqzFujJYWo7qCQ8fGdQcb8Gn6EQY+K1P+daQLnDCuWKbZ+gHAQZuKiQkXkqIYg==} cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.21.2': - resolution: {integrity: sha512-ZbRaUvw2iN/y37x6dY50D8m2BnDbBjlnMPotDi/qITMJ4sIxNY33HArjikDyakhSv0+ybdUxhWxE6kTI4oX26w==} + '@rollup/rollup-darwin-x64@4.22.2': + resolution: {integrity: sha512-1esGwDNFe2lov4I6GsEeYaAMHwkqk0IbuGH7gXGdBmd/EP9QddJJvTtTF/jv+7R8ZTYPqwcdLpMTxK8ytP6k6Q==} cpu: [x64] os: [darwin] - '@rollup/rollup-linux-arm-gnueabihf@4.21.2': - resolution: {integrity: sha512-ztRJJMiE8nnU1YFcdbd9BcH6bGWG1z+jP+IPW2oDUAPxPjo9dverIOyXz76m6IPA6udEL12reYeLojzW2cYL7w==} + '@rollup/rollup-linux-arm-gnueabihf@4.22.2': + resolution: {integrity: sha512-GBHuY07x96OTEM3OQLNaUSUwrOhdMea/LDmlFHi/HMonrgF6jcFrrFFwJhhe84XtA1oK/Qh4yFS+VMREf6dobg==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.21.2': - resolution: {integrity: sha512-flOcGHDZajGKYpLV0JNc0VFH361M7rnV1ee+NTeC/BQQ1/0pllYcFmxpagltANYt8FYf9+kL6RSk80Ziwyhr7w==} + '@rollup/rollup-linux-arm-musleabihf@4.22.2': + resolution: {integrity: sha512-Dbfa9Sc1G1lWxop0gNguXOfGhaXQWAGhZUcqA0Vs6CnJq8JW/YOw/KvyGtQFmz4yDr0H4v9X248SM7bizYj4yQ==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.21.2': - resolution: {integrity: sha512-69CF19Kp3TdMopyteO/LJbWufOzqqXzkrv4L2sP8kfMaAQ6iwky7NoXTp7bD6/irKgknDKM0P9E/1l5XxVQAhw==} + '@rollup/rollup-linux-arm64-gnu@4.22.2': + resolution: {integrity: sha512-Z1YpgBvFYhZIyBW5BoopwSg+t7yqEhs5HCei4JbsaXnhz/eZehT18DaXl957aaE9QK7TRGFryCAtStZywcQe1A==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.21.2': - resolution: {integrity: sha512-48pD/fJkTiHAZTnZwR0VzHrao70/4MlzJrq0ZsILjLW/Ab/1XlVUStYyGt7tdyIiVSlGZbnliqmult/QGA2O2w==} + '@rollup/rollup-linux-arm64-musl@4.22.2': + resolution: {integrity: sha512-66Zszr7i/JaQ0u/lefcfaAw16wh3oT72vSqubIMQqWzOg85bGCPhoeykG/cC5uvMzH80DQa2L539IqKht6twVA==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.21.2': - resolution: {integrity: sha512-cZdyuInj0ofc7mAQpKcPR2a2iu4YM4FQfuUzCVA2u4HI95lCwzjoPtdWjdpDKyHxI0UO82bLDoOaLfpZ/wviyQ==} + '@rollup/rollup-linux-powerpc64le-gnu@4.22.2': + resolution: {integrity: sha512-HpJCMnlMTfEhwo19bajvdraQMcAq3FX08QDx3OfQgb+414xZhKNf3jNvLFYKbbDSGBBrQh5yNwWZrdK0g0pokg==} cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.21.2': - resolution: {integrity: sha512-RL56JMT6NwQ0lXIQmMIWr1SW28z4E4pOhRRNqwWZeXpRlykRIlEpSWdsgNWJbYBEWD84eocjSGDu/XxbYeCmwg==} + '@rollup/rollup-linux-riscv64-gnu@4.22.2': + resolution: {integrity: sha512-/egzQzbOSRef2vYCINKITGrlwkzP7uXRnL+xU2j75kDVp3iPdcF0TIlfwTRF8woBZllhk3QaxNOEj2Ogh3t9hg==} cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.21.2': - resolution: {integrity: sha512-PMxkrWS9z38bCr3rWvDFVGD6sFeZJw4iQlhrup7ReGmfn7Oukrr/zweLhYX6v2/8J6Cep9IEA/SmjXjCmSbrMQ==} + '@rollup/rollup-linux-s390x-gnu@4.22.2': + resolution: {integrity: sha512-qgYbOEbrPfEkH/OnUJd1/q4s89FvNJQIUldx8X2F/UM5sEbtkqZpf2s0yly2jSCKr1zUUOY1hnTP2J1WOzMAdA==} cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.21.2': - resolution: {integrity: sha512-B90tYAUoLhU22olrafY3JQCFLnT3NglazdwkHyxNDYF/zAxJt5fJUB/yBoWFoIQ7SQj+KLe3iL4BhOMa9fzgpw==} + '@rollup/rollup-linux-x64-gnu@4.22.2': + resolution: {integrity: sha512-a0lkvNhFLhf+w7A95XeBqGQaG0KfS3hPFJnz1uraSdUe/XImkp/Psq0Ca0/UdD5IEAGoENVmnYrzSC9Y2a2uKQ==} cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.21.2': - resolution: {integrity: sha512-7twFizNXudESmC9oneLGIUmoHiiLppz/Xs5uJQ4ShvE6234K0VB1/aJYU3f/4g7PhssLGKBVCC37uRkkOi8wjg==} + '@rollup/rollup-linux-x64-musl@4.22.2': + resolution: {integrity: sha512-sSWBVZgzwtsuG9Dxi9kjYOUu/wKW+jrbzj4Cclabqnfkot8Z3VEHcIgyenA3lLn/Fu11uDviWjhctulkhEO60g==} cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.21.2': - resolution: {integrity: sha512-9rRero0E7qTeYf6+rFh3AErTNU1VCQg2mn7CQcI44vNUWM9Ze7MSRS/9RFuSsox+vstRt97+x3sOhEey024FRQ==} + '@rollup/rollup-win32-arm64-msvc@4.22.2': + resolution: {integrity: sha512-t/YgCbZ638R/r7IKb9yCM6nAek1RUvyNdfU0SHMDLOf6GFe/VG1wdiUAsxTWHKqjyzkRGg897ZfCpdo1bsCSsA==} cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.21.2': - resolution: {integrity: sha512-5rA4vjlqgrpbFVVHX3qkrCo/fZTj1q0Xxpg+Z7yIo3J2AilW7t2+n6Q8Jrx+4MrYpAnjttTYF8rr7bP46BPzRw==} + '@rollup/rollup-win32-ia32-msvc@4.22.2': + resolution: {integrity: sha512-kTmX5uGs3WYOA+gYDgI6ITkZng9SP71FEMoHNkn+cnmb9Zuyyay8pf0oO5twtTwSjNGy1jlaWooTIr+Dw4tIbw==} cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.21.2': - resolution: {integrity: sha512-6UUxd0+SKomjdzuAcp+HAmxw1FlGBnl1v2yEPSabtx4lBfdXHDVsW7+lQkgz9cNFJGY3AWR7+V8P5BqkD9L9nA==} + '@rollup/rollup-win32-x64-msvc@4.22.2': + resolution: {integrity: sha512-Yy8So+SoRz8I3NS4Bjh91BICPOSVgdompTIPYTByUqU66AXSIOgmW3Lv1ke3NORPqxdF+RdrZET+8vYai6f4aA==} cpu: [x64] os: [win32] - '@shikijs/core@1.12.1': - resolution: {integrity: sha512-biCz/mnkMktImI6hMfMX3H9kOeqsInxWEyCHbSlL8C/2TR1FqfmGxTLRNwYCKsyCyxWLbB8rEqXRVZuyxuLFmA==} + '@shikijs/core@1.18.0': + resolution: {integrity: sha512-VK4BNVCd2leY62Nm2JjyxtRLkyrZT/tv104O81eyaCjHq4Adceq2uJVFJJAIof6lT1mBwZrEo2qT/T+grv3MQQ==} - '@shikijs/transformers@1.12.1': - resolution: {integrity: sha512-zOpj/S2thBvnJV4Ty3EE8aRs/VqCbV+lgtEYeBRkPxTW22uLADEIZq0qjt5W2Rfy2KSu29e73nRyzp4PefjUTg==} + '@shikijs/engine-javascript@1.18.0': + resolution: {integrity: sha512-qoP/aO/ATNwYAUw1YMdaip/YVEstMZEgrwhePm83Ll9OeQPuxDZd48szZR8oSQNQBT8m8UlWxZv8EA3lFuyI5A==} - '@sindresorhus/merge-streams@2.3.0': - resolution: {integrity: sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==} - engines: {node: '>=18'} + '@shikijs/engine-oniguruma@1.18.0': + resolution: {integrity: sha512-B9u0ZKI/cud+TcmF8Chyh+R4V5qQVvyDOqXC2l2a4x73PBSBc6sZ0JRAX3eqyJswqir6ktwApUUGBYePdKnMJg==} + + '@shikijs/transformers@1.18.0': + resolution: {integrity: sha512-EdX/UIVaaS8qp9NWRyHIXp2dmuLpdVvx+UVpbIn9eafFlLemAuljPb2+K40ie6jrlg0uUIqkg25CM/8I34yBNw==} + + '@shikijs/types@1.18.0': + resolution: {integrity: sha512-O9N36UEaGGrxv1yUrN2nye7gDLG5Uq0/c1LyfmxsvzNPqlHzWo9DI0A4+fhW2y3bGKuQu/fwS7EPdKJJCowcVA==} + + '@shikijs/vscode-textmate@9.2.2': + resolution: {integrity: sha512-TMp15K+GGYrWlZM8+Lnj9EaHEFmOen0WJBrfa17hF7taDOYthuPPV0GWzfd/9iMij0akS/8Yw2ikquH7uVi/fg==} - '@size-limit/esbuild@11.1.4': - resolution: {integrity: sha512-Nxh+Fw4Z7sFjRLeT7GDZIy297VXyJrMvG20UDSWP31QgglriEBDkW9U77T7W6js5FaEr89bYVrGzpHfmE1CLFw==} + '@size-limit/esbuild@11.1.5': + resolution: {integrity: sha512-AywMXRGzJmgAXb8bPAHjK+zxPwuPmIazL2BKDT3zp//8Fb3B/8ld1D4yXMYro4QgJEp47W2KZAZdM5RGrc6Z/A==} engines: {node: ^18.0.0 || >=20.0.0} peerDependencies: - size-limit: 11.1.4 + size-limit: 11.1.5 - '@size-limit/file@11.1.4': - resolution: {integrity: sha512-QxnGj9cxhCEuqMAV01gqonXIKcc+caZqFHZpV51oL2ZJNGSPP9Q/yyf+7HbVe00faOFd1dZZwMwzZmX7HQ9LbA==} + '@size-limit/file@11.1.5': + resolution: {integrity: sha512-oz/XBVUJh95GpzDb9/f4sEQD/ACJ9zEKSRgBtvMUTN0c+O/9uq+RzvFeXFN2Kjpx3Dmur1ta+oZsp3zQFxlb3Q==} engines: {node: ^18.0.0 || >=20.0.0} peerDependencies: - size-limit: 11.1.4 + size-limit: 11.1.5 - '@size-limit/preset-small-lib@11.1.4': - resolution: {integrity: sha512-wELW374esv+2Nlzf7g+qW4Af9L69duLoO9F52f0sGk/nzb6et7u8gLRvweWrBfm3itUrqHCpGSSVabTsIU8kNw==} + '@size-limit/preset-small-lib@11.1.5': + resolution: {integrity: sha512-++IMlbAQpCFQp8UN9XHrcZ3SHY+u/ZzxSUA8zIHXDjZJdkb9WIW12CJXwJADj8tMRgWHWC4ixbi1DdnHYJ3ZpA==} peerDependencies: - size-limit: 11.1.4 + size-limit: 11.1.5 - '@sveltejs/adapter-auto@3.2.4': - resolution: {integrity: sha512-a64AKYbfTUrVwU0xslzv1Jf3M8bj0IwhptaXmhgIkjXspBXhD0od9JiItQHchijpLMGdEDcYBlvqySkEawv6mQ==} + '@sveltejs/adapter-auto@3.2.5': + resolution: {integrity: sha512-27LR+uKccZ62lgq4N/hvyU2G+hTP9fxWEAfnZcl70HnyfAjMSsGk1z/SjAPXNCD1mVJIE7IFu3TQ8cQ/UH3c0A==} peerDependencies: '@sveltejs/kit': ^2.0.0 - '@sveltejs/kit@2.5.25': - resolution: {integrity: sha512-5hBSEN8XEjDZ5+2bHkFh8Z0QyOk0C187cyb12aANe1c8aeKbfu5ZD5XaC2vEH4h0alJFDXPdUkXQBmeeXeMr1A==} + '@sveltejs/kit@2.5.28': + resolution: {integrity: sha512-/O7pvFGBsQPcFa9UrW8eUC5uHTOXLsUp3SN0dY6YmRAL9nfPSrJsSJk//j5vMpinSshzUjteAFcfQTU+04Ka1w==} engines: {node: '>=18.13'} hasBin: true peerDependencies: @@ -1329,68 +1337,68 @@ packages: svelte: ^4.0.0 || ^5.0.0-next.0 vite: ^5.0.0 - '@swc/core-darwin-arm64@1.7.23': - resolution: {integrity: sha512-yyOHPfti6yKlQulfVWMt7BVKst+SyEZYCWuQSGMn1KgmNCH/bYufRWfQXIhkGSj44ZkEepJmsJ8tDyIb4k5WyA==} + '@swc/core-darwin-arm64@1.7.26': + resolution: {integrity: sha512-FF3CRYTg6a7ZVW4yT9mesxoVVZTrcSWtmZhxKCYJX9brH4CS/7PRPjAKNk6kzWgWuRoglP7hkjQcd6EpMcZEAw==} engines: {node: '>=10'} cpu: [arm64] os: [darwin] - '@swc/core-darwin-x64@1.7.23': - resolution: {integrity: sha512-GzqHwQ0Y1VyjdI/bBKFX2GKm5HD3PIB6OhuAQtWZMTtEr2yIrlT0YK2T+XKh7oIg31JwxGBeQdBk3KTI7DARmQ==} + '@swc/core-darwin-x64@1.7.26': + resolution: {integrity: sha512-az3cibZdsay2HNKmc4bjf62QVukuiMRh5sfM5kHR/JMTrLyS6vSw7Ihs3UTkZjUxkLTT8ro54LI6sV6sUQUbLQ==} engines: {node: '>=10'} cpu: [x64] os: [darwin] - '@swc/core-linux-arm-gnueabihf@1.7.23': - resolution: {integrity: sha512-qwX4gB41OS6/OZkHcpTqLFGsdmvoZyffnJIlgB/kZKwH3lfeJWzv6vx57zXtNpM/t7GoQEe0VZUVdmNjxSxBZw==} + '@swc/core-linux-arm-gnueabihf@1.7.26': + resolution: {integrity: sha512-VYPFVJDO5zT5U3RpCdHE5v1gz4mmR8BfHecUZTmD2v1JeFY6fv9KArJUpjrHEEsjK/ucXkQFmJ0jaiWXmpOV9Q==} engines: {node: '>=10'} cpu: [arm] os: [linux] - '@swc/core-linux-arm64-gnu@1.7.23': - resolution: {integrity: sha512-TsrbUZdMaUwzI7+g/8rHPLWbntMKYSu5Bn5IBSqVKPeyqaXxNnlIUnWXgXcUcRAc+T+Y8ADfr7EiFz9iz5DuSA==} + '@swc/core-linux-arm64-gnu@1.7.26': + resolution: {integrity: sha512-YKevOV7abpjcAzXrhsl+W48Z9mZvgoVs2eP5nY+uoMAdP2b3GxC0Df1Co0I90o2lkzO4jYBpTMcZlmUXLdXn+Q==} engines: {node: '>=10'} cpu: [arm64] os: [linux] - '@swc/core-linux-arm64-musl@1.7.23': - resolution: {integrity: sha512-JEdtwdthazKq4PBz53KSubwwK8MvqODAihGSAzc8u3Unq4ojcvaS8b0CwLBeD+kTQ78HpxOXTt3DsFIxpgaCAA==} + '@swc/core-linux-arm64-musl@1.7.26': + resolution: {integrity: sha512-3w8iZICMkQQON0uIcvz7+Q1MPOW6hJ4O5ETjA0LSP/tuKqx30hIniCGOgPDnv3UTMruLUnQbtBwVCZTBKR3Rkg==} engines: {node: '>=10'} cpu: [arm64] os: [linux] - '@swc/core-linux-x64-gnu@1.7.23': - resolution: {integrity: sha512-V51gFPWaVAHbI1yg9ahsoya3aB4uawye3SZ5uQWgcP7wdCdiv60dw4F5nuPJf5Z1oXD3U/BslXuamv8Oh9vXqQ==} + '@swc/core-linux-x64-gnu@1.7.26': + resolution: {integrity: sha512-c+pp9Zkk2lqb06bNGkR2Looxrs7FtGDMA4/aHjZcCqATgp348hOKH5WPvNLBl+yPrISuWjbKDVn3NgAvfvpH4w==} engines: {node: '>=10'} cpu: [x64] os: [linux] - '@swc/core-linux-x64-musl@1.7.23': - resolution: {integrity: sha512-BBqQi4+UdeRqag3yM4IJjaHG4yc1o3l9ksENHToE0o/u2DT0FY5+K/DiYGZLC1JHbSFzNqRCYsa7DIzRtZ0A1A==} + '@swc/core-linux-x64-musl@1.7.26': + resolution: {integrity: sha512-PgtyfHBF6xG87dUSSdTJHwZ3/8vWZfNIXQV2GlwEpslrOkGqy+WaiiyE7Of7z9AvDILfBBBcJvJ/r8u980wAfQ==} engines: {node: '>=10'} cpu: [x64] os: [linux] - '@swc/core-win32-arm64-msvc@1.7.23': - resolution: {integrity: sha512-JPk6pvCKncL6bXG7p+NLZf8PWx4FakVvKNdwGeMrYunb+yk1IZf7qf9LJk8+GDGF5QviDXPs8opZrTrfsW80fA==} + '@swc/core-win32-arm64-msvc@1.7.26': + resolution: {integrity: sha512-9TNXPIJqFynlAOrRD6tUQjMq7KApSklK3R/tXgIxc7Qx+lWu8hlDQ/kVPLpU7PWvMMwC/3hKBW+p5f+Tms1hmA==} engines: {node: '>=10'} cpu: [arm64] os: [win32] - '@swc/core-win32-ia32-msvc@1.7.23': - resolution: {integrity: sha512-2Whxi8d+bLQBzJcQ5qYPHlk02YYVGsMVav0fWk+FnX2z1QRREIu1L1xvrpi7gBpjXp6BIU40ya8GiKeekNT2bg==} + '@swc/core-win32-ia32-msvc@1.7.26': + resolution: {integrity: sha512-9YngxNcG3177GYdsTum4V98Re+TlCeJEP4kEwEg9EagT5s3YejYdKwVAkAsJszzkXuyRDdnHUpYbTrPG6FiXrQ==} engines: {node: '>=10'} cpu: [ia32] os: [win32] - '@swc/core-win32-x64-msvc@1.7.23': - resolution: {integrity: sha512-82fARk4/yJ40kwWKY/gdKDisPdtgJE9jgpl/vkNG3alyJxrCzuNM7+CtiKoYbXLeqM8GQTS3wlvCaJu9oQ8dag==} + '@swc/core-win32-x64-msvc@1.7.26': + resolution: {integrity: sha512-VR+hzg9XqucgLjXxA13MtV5O3C0bK0ywtLIBw/+a+O+Oc6mxFWHtdUeXDbIi5AiPbn0fjgVJMqYnyjGyyX8u0w==} engines: {node: '>=10'} cpu: [x64] os: [win32] - '@swc/core@1.7.23': - resolution: {integrity: sha512-VDNkpDvDlreGh2E3tlDj8B3piiuLhhQA/7rIVZpiLUvG1YpucAa6N7iDXA7Gc/+Hah8spaCg/qvEaBkCmcIYCQ==} + '@swc/core@1.7.26': + resolution: {integrity: sha512-f5uYFf+TmMQyYIoxkn/evWhNGuUzC730dFwAKGwBVHHVoPyak1/GvJUm6i1SKl+2Hrj9oN0i3WSoWWZ4pgI8lw==} engines: {node: '>=10'} peerDependencies: '@swc/helpers': '*' @@ -1410,11 +1418,19 @@ packages: '@tanstack/query-core@5.53.3': resolution: {integrity: sha512-ZfjAgd7NpqDx0e4aYBt7EmS2enbulPrJwowTy+mayRE93WUUH+sIYHun1TdRjpGwDPMNNZ5D6goh7n3CwoO+HA==} + '@tanstack/query-core@5.56.2': + resolution: {integrity: sha512-gor0RI3/R5rVV3gXfddh1MM+hgl0Z4G7tj6Xxpq6p2I03NGPaJ8dITY9Gz05zYYb/EJq9vPas/T4wn9EaDPd4Q==} + '@tanstack/react-query@5.53.3': resolution: {integrity: sha512-286mN/91CeM7vC6CZFLKYDHSw+WyMX6ekIvzoTbpM4xyPb99VSyCKPLyPgaOatKqYm6ooMBquSq9NGRdKgsJfg==} peerDependencies: react: ^18 || ^19 + '@tanstack/react-query@5.56.2': + resolution: {integrity: sha512-SR0GzHVo6yzhN72pnRhkEFRAHMsUo5ZPzAxfTMvUxFIDVS6W9LYUp6nXW3fcHVdg0ZJl8opSH85jqahvm6DSVg==} + peerDependencies: + react: ^18 || ^19 + '@testing-library/dom@10.1.0': resolution: {integrity: sha512-wdsYKy5zupPyLCW2Je5DLHSxSfbIp6h80WoHOQc+RPtmPGA52O9x5MJEkv92Sjonpq+poOAtUKhh1kBGAXBrNA==} engines: {node: '>=18'} @@ -1465,6 +1481,9 @@ packages: '@types/estree@1.0.5': resolution: {integrity: sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==} + '@types/estree@1.0.6': + resolution: {integrity: sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==} + '@types/hast@3.0.4': resolution: {integrity: sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==} @@ -1480,6 +1499,9 @@ packages: '@types/markdown-it@14.1.2': resolution: {integrity: sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==} + '@types/mdast@4.0.4': + resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==} + '@types/mdurl@2.0.0': resolution: {integrity: sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==} @@ -1492,17 +1514,14 @@ packages: '@types/node@12.20.55': resolution: {integrity: sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==} - '@types/node@20.16.3': - resolution: {integrity: sha512-/wdGiWRkMOm53gAsSyFMXFZHbVg7C6CbkrzHNpaHoYfsUWPg7m6ZRKtvQjgvQ9i8WT540a3ydRlRQbxjY30XxQ==} - - '@types/node@22.5.2': - resolution: {integrity: sha512-acJsPTEqYqulZS/Yp/S3GgeE6GZ0qYODUR8aVr/DkhHQ8l9nd4j5x1/ZJy9/gHrRlFMqkO6i0I3E27Alu4jjPg==} + '@types/node@22.5.5': + resolution: {integrity: sha512-Xjs4y5UPO/CLdzpgR6GirZJx36yScjh73+2NlLlkFRSoQN8B0DpfXPdZGnvVmLRLOsqDpOfTNv7D9trgGhmOIA==} '@types/normalize-package-data@2.4.4': resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} - '@types/prop-types@15.7.12': - resolution: {integrity: sha512-5zvhXYtRNRluoE/jAp4GVsSduVUzNWKkOZrCDBWYtE7biZywwdC2AcEzg+cSMLFRfVgeAFqpfNabiPjxFddV1Q==} + '@types/prop-types@15.7.13': + resolution: {integrity: sha512-hCZTSvwbzWGvhqxp/RqVqwU999pBf2vp7hzIjiYOsl8wqOmUxkQ6ddw1cV3l8811+kdUFus/q4d1Y3E3SyEifA==} '@types/pug@2.0.10': resolution: {integrity: sha512-Sk/uYFOBAB7mb74XcpizmH0KOR2Pv3D2Hmrh1Dmy5BmK3MpdSa5kqZcg6EKBdklU0bFXX9gCfzvpnyUehrPIuA==} @@ -1513,8 +1532,8 @@ packages: '@types/react@18.3.1': resolution: {integrity: sha512-V0kuGBX3+prX+DQ/7r2qsv1NsdfnCLnTgnRJ1pYnxykBhGMz+qj+box5lq7XsO5mtZsBqpjwwTu/7wszPfMBcw==} - '@types/react@18.3.3': - resolution: {integrity: sha512-hti/R0pS0q1/xx+TsI73XIqk26eBsISZ2R0wUijXIngRK9R/e7Xw/cXVxQK7R5JjW+SV4zGcn5hXjudkN/pLIw==} + '@types/react@18.3.8': + resolution: {integrity: sha512-syBUrW3/XpnW4WJ41Pft+I+aPoDVbrBVQGEnbD7NijDGlVC+8gV/XKRY+7vMDlfPpbwYt0l1vd/Sj8bJGMbs9Q==} '@types/semver@7.5.8': resolution: {integrity: sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==} @@ -1525,8 +1544,8 @@ packages: '@types/tough-cookie@4.0.5': resolution: {integrity: sha512-/Ad8+nIOV7Rl++6f1BdKxFSMgmoqEoYbHRpPcx3JEfv8VRsQe9Z4mCXeJBzxs7mbHY/XOZZuXlRNfhpVPbs6ZA==} - '@types/unist@3.0.2': - resolution: {integrity: sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==} + '@types/unist@3.0.3': + resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==} '@types/web-bluetooth@0.0.20': resolution: {integrity: sha512-g9gZnnXVq7gM7v3tJCWV/qw7w+KeOlSHAhgF9RytFyifW6AF61hdT2ucrYhPq9hLs5JIryeupHV3qGk95dH9ow==} @@ -1534,6 +1553,9 @@ packages: '@types/wrap-ansi@3.0.0': resolution: {integrity: sha512-ltIpx+kM7g/MLRZfkbL7EsCEjfzCcScLpkg37eXEtx5kmrAKBkTJwd1GIAjDSL8wTpM6Hzn5YO4pSb91BEwu1g==} + '@ungap/structured-clone@1.2.0': + resolution: {integrity: sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==} + '@vitejs/plugin-react-swc@3.7.0': resolution: {integrity: sha512-yrknSb3Dci6svCd/qhHqhFPDSw0QtjumcqdKMoNNzmOl5lMXTTiqzjWtG4Qask2HdvvzaNgSunbQGet8/GrKdA==} peerDependencies: @@ -1545,91 +1567,100 @@ packages: peerDependencies: vite: ^4.2.0 || ^5.0.0 - '@vitejs/plugin-vue@5.1.3': - resolution: {integrity: sha512-3xbWsKEKXYlmX82aOHufFQVnkbMC/v8fLpWwh6hWOUrK5fbbtBh9Q/WWse27BFgSy2/e2c0fz5Scgya9h2GLhw==} + '@vitejs/plugin-vue@5.1.4': + resolution: {integrity: sha512-N2XSI2n3sQqp5w7Y/AN/L2XDjBIRGqXko+eDp42sydYSBeJuSm5a1sLf8zakmo8u7tA8NmBgoDLA1HeOESjp9A==} engines: {node: ^18.0.0 || >=20.0.0} peerDependencies: vite: ^5.0.0 vue: ^3.2.25 - '@vitest/expect@2.0.5': - resolution: {integrity: sha512-yHZtwuP7JZivj65Gxoi8upUN2OzHTi3zVfjwdpu2WrvCZPLwsJ2Ey5ILIPccoW23dd/zQBlJ4/dhi7DWNyXCpA==} + '@vitest/expect@2.1.1': + resolution: {integrity: sha512-YeueunS0HiHiQxk+KEOnq/QMzlUuOzbU1Go+PgAsHvvv3tUkJPm9xWt+6ITNTlzsMXUjmgm5T+U7KBPK2qQV6w==} + + '@vitest/mocker@2.1.1': + resolution: {integrity: sha512-LNN5VwOEdJqCmJ/2XJBywB11DLlkbY0ooDJW3uRX5cZyYCrc4PI/ePX0iQhE3BiEGiQmK4GE7Q/PqCkkaiPnrA==} + peerDependencies: + '@vitest/spy': 2.1.1 + msw: ^2.3.5 + vite: ^5.0.0 + peerDependenciesMeta: + msw: + optional: true + vite: + optional: true - '@vitest/pretty-format@2.0.5': - resolution: {integrity: sha512-h8k+1oWHfwTkyTkb9egzwNMfJAEx4veaPSnMeKbVSjp4euqGSbQlm5+6VHwTr7u4FJslVVsUG5nopCaAYdOmSQ==} + '@vitest/pretty-format@2.1.1': + resolution: {integrity: sha512-SjxPFOtuINDUW8/UkElJYQSFtnWX7tMksSGW0vfjxMneFqxVr8YJ979QpMbDW7g+BIiq88RAGDjf7en6rvLPPQ==} - '@vitest/runner@2.0.5': - resolution: {integrity: sha512-TfRfZa6Bkk9ky4tW0z20WKXFEwwvWhRY+84CnSEtq4+3ZvDlJyY32oNTJtM7AW9ihW90tX/1Q78cb6FjoAs+ig==} + '@vitest/runner@2.1.1': + resolution: {integrity: sha512-uTPuY6PWOYitIkLPidaY5L3t0JJITdGTSwBtwMjKzo5O6RCOEncz9PUN+0pDidX8kTHYjO0EwUIvhlGpnGpxmA==} - '@vitest/snapshot@2.0.5': - resolution: {integrity: sha512-SgCPUeDFLaM0mIUHfaArq8fD2WbaXG/zVXjRupthYfYGzc8ztbFbu6dUNOblBG7XLMR1kEhS/DNnfCZ2IhdDew==} + '@vitest/snapshot@2.1.1': + resolution: {integrity: sha512-BnSku1WFy7r4mm96ha2FzN99AZJgpZOWrAhtQfoxjUU5YMRpq1zmHRq7a5K9/NjqonebO7iVDla+VvZS8BOWMw==} - '@vitest/spy@2.0.5': - resolution: {integrity: sha512-c/jdthAhvJdpfVuaexSrnawxZz6pywlTPe84LUB2m/4t3rl2fTo9NFGBG4oWgaD+FTgDDV8hJ/nibT7IfH3JfA==} + '@vitest/spy@2.1.1': + resolution: {integrity: sha512-ZM39BnZ9t/xZ/nF4UwRH5il0Sw93QnZXd9NAZGRpIgj0yvVwPpLd702s/Cx955rGaMlyBQkZJ2Ir7qyY48VZ+g==} - '@vitest/utils@2.0.5': - resolution: {integrity: sha512-d8HKbqIcya+GR67mkZbrzhS5kKhtp8dQLcmRZLGTscGVg7yImT82cIrhtn2L8+VujWcy6KZweApgNmPsTAO/UQ==} + '@vitest/utils@2.1.1': + resolution: {integrity: sha512-Y6Q9TsI+qJ2CC0ZKj6VBb+T8UPz593N113nnUykqwANqhgf3QkZeHFlusgKLTqrnVHbj/XDKZcDHol+dxVT+rQ==} - '@volar/language-core@2.4.1': - resolution: {integrity: sha512-9AKhC7Qn2mQYxj7Dz3bVxeOk7gGJladhWixUYKef/o0o7Bm4an+A3XvmcTHVqZ8stE6lBVH++g050tBtJ4TZPQ==} + '@volar/language-core@2.4.5': + resolution: {integrity: sha512-F4tA0DCO5Q1F5mScHmca0umsi2ufKULAnMOVBfMsZdT4myhVl4WdKRwCaKcfOkIEuyrAVvtq1ESBdZ+rSyLVww==} - '@volar/source-map@2.4.1': - resolution: {integrity: sha512-Xq6ep3OZg9xUqN90jEgB9ztX5SsTz1yiV8wiQbcYNjWkek+Ie3dc8l7AVt3EhDm9mSIR58oWczHkzM2H6HIsmQ==} + '@volar/source-map@2.4.5': + resolution: {integrity: sha512-varwD7RaKE2J/Z+Zu6j3mNNJbNT394qIxXwdvz/4ao/vxOfyClZpSDtLKkwWmecinkOVos5+PWkWraelfMLfpw==} - '@volar/typescript@2.4.1': - resolution: {integrity: sha512-UoRzC0PXcwajFQTu8XxKSYNsWNBtVja6Y9gC8eLv7kYm+UEKJCcZ8g7dialsOYA0HKs3Vpg57MeCsawFLC6m9Q==} + '@volar/typescript@2.4.5': + resolution: {integrity: sha512-mcT1mHvLljAEtHviVcBuOyAwwMKz1ibXTi5uYtP/pf4XxoAzpdkQ+Br2IC0NPCvLCbjPZmbf3I0udndkfB1CDg==} - '@vue/compiler-core@3.5.0': - resolution: {integrity: sha512-ja7cpqAOfw4tyFAxgBz70Z42miNDeaqTxExTsnXDLomRpqfyCgyvZvFp482fmsElpfvsoMJUsvzULhvxUTW6Iw==} + '@vue/compiler-core@3.5.6': + resolution: {integrity: sha512-r+gNu6K4lrvaQLQGmf+1gc41p3FO2OUJyWmNqaIITaJU6YFiV5PtQSFZt8jfztYyARwqhoCayjprC7KMvT3nRA==} - '@vue/compiler-dom@3.5.0': - resolution: {integrity: sha512-xYjUybWZXl+1R/toDy815i4PbeehL2hThiSGkcpmIOCy2HoYyeeC/gAWK/Y/xsoK+GSw198/T5O31bYuQx5uvQ==} + '@vue/compiler-dom@3.5.6': + resolution: {integrity: sha512-xRXqxDrIqK8v8sSScpistyYH0qYqxakpsIvqMD2e5sV/PXQ1mTwtXp4k42yHK06KXxKSmitop9e45Ui/3BrTEw==} - '@vue/compiler-sfc@3.5.0': - resolution: {integrity: sha512-B9DgLtrqok2GLuaFjLlSL15ZG3ZDBiitUH1ecex9guh/ZcA5MCdwuVE6nsfQxktuZY/QY0awJ35/ripIviCQTQ==} + '@vue/compiler-sfc@3.5.6': + resolution: {integrity: sha512-pjWJ8Kj9TDHlbF5LywjVso+BIxCY5wVOLhkEXRhuCHDxPFIeX1zaFefKs8RYoHvkSMqRWt93a0f2gNJVJixHwg==} - '@vue/compiler-ssr@3.5.0': - resolution: {integrity: sha512-E263QZmA1dqRd7c3u/sWTLRMpQOT0aZ8av/L9SoD/v/BVMZaWFHPUUBswS+bzrfvG2suJF8vSLKx6k6ba5SUdA==} + '@vue/compiler-ssr@3.5.6': + resolution: {integrity: sha512-VpWbaZrEOCqnmqjE83xdwegtr5qO/2OPUC6veWgvNqTJ3bYysz6vY3VqMuOijubuUYPRpG3OOKIh9TD0Stxb9A==} '@vue/compiler-vue2@2.7.16': resolution: {integrity: sha512-qYC3Psj9S/mfu9uVi5WvNZIzq+xnXMhOwbTFKKDD7b1lhpnn71jXSFdTQ+WsIEk0ONCd7VV2IMm7ONl6tbQ86A==} - '@vue/devtools-api@7.3.7': - resolution: {integrity: sha512-kvjQ6nmsqTp7SrmpwI2G0MgbC4ys0bPsgQirHXJM8y1m7siQ5RnWQUHJVfyUrHNguCySW1cevAdIw87zrPTl9g==} + '@vue/devtools-api@7.4.5': + resolution: {integrity: sha512-PX9uXirHOY2P99kb1cP3DxWZojFW3acNMqd+l4i5nKcqY59trXTOfwDZXt2Qifu0OU1izAQb76Ur6NPVldF2KQ==} - '@vue/devtools-kit@7.3.7': - resolution: {integrity: sha512-ktHhhjI4CoUrwdSUF5b/MFfjrtAtK8r4vhOkFyRN5Yp9kdXTwsRBYcwarHuP+wFPKf4/KM7DVBj2ELO8SBwdsw==} + '@vue/devtools-kit@7.4.5': + resolution: {integrity: sha512-Uuki4Z6Bc/ExvtlPkeDNGSAe4580R+HPcVABfTE9TF7BTz3Nntk7vxIRUyWblZkUEcB/x+wn2uofyt5i2LaUew==} - '@vue/devtools-shared@7.3.7': - resolution: {integrity: sha512-M9EU1/bWi5GNS/+IZrAhwGOVZmUTN4MH22Hvh35nUZZg9AZP2R2OhfCb+MG4EtAsrUEYlu3R43/SIj3G7EZYtQ==} + '@vue/devtools-shared@7.4.5': + resolution: {integrity: sha512-2XgUOkL/7QDmyYI9J7cm+rz/qBhcGv+W5+i1fhwdQ0HQ1RowhdK66F0QBuJSz/5k12opJY8eN6m03/XZMs7imQ==} - '@vue/language-core@2.1.4': - resolution: {integrity: sha512-i8pfAgNjTNjabBX1xRsuV6aRw2E8bdQXwd5H8m3cUkTVJju3QN5nfdoXET0uK+yXsuloNJPzo6PXFujRRPNmMA==} + '@vue/language-core@2.1.6': + resolution: {integrity: sha512-MW569cSky9R/ooKMh6xa2g1D0AtRKbL56k83dzus/bx//RDJk24RHWkMzbAlXjMdDNyxAaagKPRquBIxkxlCkg==} peerDependencies: typescript: '*' peerDependenciesMeta: typescript: optional: true - '@vue/reactivity@3.5.0': - resolution: {integrity: sha512-Ew3F5riP3B3ZDGjD3ZKb9uZylTTPSqt8hAf4sGbvbjrjDjrFb3Jm15Tk1/w7WwTE5GbQ2Qhwxx1moc9hr8A/OQ==} + '@vue/reactivity@3.5.6': + resolution: {integrity: sha512-shZ+KtBoHna5GyUxWfoFVBCVd7k56m6lGhk5e+J9AKjheHF6yob5eukssHRI+rzvHBiU1sWs/1ZhNbLExc5oYQ==} - '@vue/runtime-core@3.5.0': - resolution: {integrity: sha512-mQyW0F9FaNRdt8ghkAs+BMG3iQ7LGgWKOpkzUzR5AI5swPNydHGL5hvVTqFaeMzwecF1g0c86H4yFQsSxJhH1w==} + '@vue/runtime-core@3.5.6': + resolution: {integrity: sha512-FpFULR6+c2lI+m1fIGONLDqPQO34jxV8g6A4wBOgne8eSRHP6PQL27+kWFIx5wNhhjkO7B4rgtsHAmWv7qKvbg==} - '@vue/runtime-dom@3.5.0': - resolution: {integrity: sha512-NQQXjpdXgyYVJ2M56FJ+lSJgZiecgQ2HhxhnQBN95FymXegRNY/N2htI7vOTwpP75pfxhIeYOJ8mE8sW8KAW6A==} + '@vue/runtime-dom@3.5.6': + resolution: {integrity: sha512-SDPseWre45G38ENH2zXRAHL1dw/rr5qp91lS4lt/nHvMr0MhsbCbihGAWLXNB/6VfFOJe2O+RBRkXU+CJF7/sw==} - '@vue/server-renderer@3.5.0': - resolution: {integrity: sha512-HyDIFUg+l7L4PKrEnJlCYWHUOlm6NxZhmSxIefZ5MTYjkIPfDfkwhX7hqxAQHfgIAE1uLMLQZwuNR/ozI0NhZg==} + '@vue/server-renderer@3.5.6': + resolution: {integrity: sha512-zivnxQnOnwEXVaT9CstJ64rZFXMS5ZkKxCjDQKiMSvUhXRzFLWZVbaBiNF4HGDqGNNsTgmjcCSmU6TB/0OOxLA==} peerDependencies: - vue: 3.5.0 + vue: 3.5.6 - '@vue/shared@3.4.37': - resolution: {integrity: sha512-nIh8P2fc3DflG8+5Uw8PT/1i17ccFn0xxN/5oE9RfV5SVnd7G0XEFRwakrnNFE/jlS95fpGXDVG5zDETS26nmg==} - - '@vue/shared@3.5.0': - resolution: {integrity: sha512-m9IgiteBpCkFaMNwCOBkFksA7z8QiKc30ooRuoXWUFRDu0mGyNPlFHmbncF0/Kra1RlX8QrmBbRaIxVvikaR0Q==} + '@vue/shared@3.5.6': + resolution: {integrity: sha512-eidH0HInnL39z6wAt6SFIwBrvGOpDWsDxlw3rCgo1B+CQ1781WzQUSU3YjxgdkcJo9Q8S6LmXTkvI+cLHGkQfA==} '@vue/tsconfig@0.5.1': resolution: {integrity: sha512-VcZK7MvpjuTPx2w6blwnwZAu5/LgBUtejFOi3pPGQFXQN5Ela03FUtd2Qtg4yWGGissVL0dr6Ro1LfOFh+PCuQ==} @@ -1691,8 +1722,8 @@ packages: acorn-globals@7.0.1: resolution: {integrity: sha512-umOSDSDrfHbTNPuNpC2NSnnA3LUrqpevPb4T9jRx4MagXNS0rs+gwiTcAvqCRmsD6utzsrzNt+ebm00SNWiC3Q==} - acorn-walk@8.3.3: - resolution: {integrity: sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==} + acorn-walk@8.3.4: + resolution: {integrity: sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==} engines: {node: '>=0.4.0'} acorn@8.12.1: @@ -1727,8 +1758,8 @@ packages: resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} engines: {node: '>=8'} - ansi-regex@6.0.1: - resolution: {integrity: sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==} + ansi-regex@6.1.0: + resolution: {integrity: sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==} engines: {node: '>=12'} ansi-styles@3.2.1: @@ -1756,6 +1787,10 @@ packages: aria-query@5.3.0: resolution: {integrity: sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==} + aria-query@5.3.1: + resolution: {integrity: sha512-Z/ZeOgVl7bcSYZ/u/rh0fOpvEpq//LZmdbkXyc7syVzjPAhfOa9ebsdTSjEBDU4vs5nC98Kfduj1uFo0qyET3g==} + engines: {node: '>= 0.4'} + array-union@2.1.0: resolution: {integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==} engines: {node: '>=8'} @@ -1841,11 +1876,11 @@ packages: resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} engines: {node: '>=10'} - caniuse-lite@1.0.30001646: - resolution: {integrity: sha512-dRg00gudiBDDTmUhClSdv3hqRfpbOnU28IpI1T6PBTLWa+kOj0681C8uML3PifYfREuBrVjDGhL3adYpBT6spw==} + caniuse-lite@1.0.30001662: + resolution: {integrity: sha512-sgMUVwLmGseH8ZIrm1d51UbrhqMCH3jvS7gF/M6byuHOnKyLOBL7W8yz5V02OHwgLGA36o/AFhWzzh4uc5aqTA==} - caniuse-lite@1.0.30001655: - resolution: {integrity: sha512-jRGVy3iSGO5Uutn2owlb5gR6qsGngTw9ZTb4ali9f3glshcNmJ2noam4Mo9zia5P9Dk3jNNydy7vQjuE5dQmfg==} + ccount@2.0.1: + resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} chai@5.1.1: resolution: {integrity: sha512-pT1ZgP8rPNqUgieVaEY+ryQr6Q4HXNg8Ei9UnLUrjN4IA7dvQC5JB+/kxVcPNDHyBcc/26CXPkbNzq3qwrOEKA==} @@ -1862,6 +1897,12 @@ packages: change-case@5.4.4: resolution: {integrity: sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==} + character-entities-html4@2.1.0: + resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==} + + character-entities-legacy@3.0.0: + resolution: {integrity: sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==} + chardet@0.7.0: resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==} @@ -1919,6 +1960,9 @@ packages: resolution: {integrity: sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==} engines: {node: '>= 0.8'} + comma-separated-tokens@2.0.3: + resolution: {integrity: sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==} + commander@11.1.0: resolution: {integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==} engines: {node: '>=16'} @@ -1984,17 +2028,8 @@ packages: de-indent@1.0.2: resolution: {integrity: sha512-e/1zu3xH5MQryN2zdVaF0OrdNLUbvWxzMbi+iNA6Bky7l1RoP8a2fIbRocyHclXt/arDrrR6lL3TqFD9pMQTsg==} - debug@4.3.5: - resolution: {integrity: sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==} - engines: {node: '>=6.0'} - peerDependencies: - supports-color: '*' - peerDependenciesMeta: - supports-color: - optional: true - - debug@4.3.6: - resolution: {integrity: sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==} + debug@4.3.7: + resolution: {integrity: sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==} engines: {node: '>=6.0'} peerDependencies: supports-color: '*' @@ -2058,6 +2093,9 @@ packages: devalue@5.0.0: resolution: {integrity: sha512-gO+/OMXF7488D+u3ue+G7Y4AA3ZmUnB3eHJXmBTgNHvr4ZNzl36A0ZtG+XCRNYCkYx/bFmw4qtkoFLa+wSrwAA==} + devlop@1.1.0: + resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} + dezalgo@1.0.4: resolution: {integrity: sha512-rXSP0bf+5n0Qonsb+SVVfNfIsimO4HEtmnIpPHY8Q1UCzKlQrDMfdobr8nJOOsRgWCyMRqeSBQzmWUMq7zvVig==} @@ -2183,6 +2221,14 @@ packages: fastq@1.17.1: resolution: {integrity: sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==} + fdir@6.3.0: + resolution: {integrity: sha512-QOnuT+BOtivR77wYvCWHfGt9s4Pz1VIMbD463vegT5MLqNXy8rYFT/lPVEqf/bhYeT6qmqrNHhsX+rWwe3rOCQ==} + peerDependencies: + picomatch: ^3 || ^4 + peerDependenciesMeta: + picomatch: + optional: true + feature-fetch@0.0.15: resolution: {integrity: sha512-fScwADZ5pZ5aXGTd4U+LUX1BQMNISIJHHEXZnAn0mDPDyhrGztXyU/A5EhnPNGXS9ajVxli99/YO3Vkvy/5Stg==} @@ -2198,14 +2244,11 @@ packages: resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} engines: {node: '>=10'} - find-yarn-workspace-root2@1.2.16: - resolution: {integrity: sha512-hr6hb1w8ePMpPVUK39S4RlwJzi+xPLuVuG8XlwXU3KD5Yn3qgBWVfy3AzNlDhWvE1EORCE65/Qm26rFQt3VLVA==} + focus-trap@7.6.0: + resolution: {integrity: sha512-1td0l3pMkWJLFipobUcGaf+5DTY4PLDDrcqoSaKP8ediO/CoWCCYk/fT/Y2A4e6TNB+Sh6clRJCjOPPnKoNHnQ==} - focus-trap@7.5.4: - resolution: {integrity: sha512-N7kHdlgsO/v+iD/dMoJKtsSqs5Dz/dXZVebRgJw23LDk+jMi/974zyiOYDziY2JPp8xivq9BmUGwIJMiuSBi7w==} - - follow-redirects@1.15.6: - resolution: {integrity: sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==} + follow-redirects@1.15.9: + resolution: {integrity: sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==} engines: {node: '>=4.0'} peerDependencies: debug: '*' @@ -2290,10 +2333,6 @@ packages: resolution: {integrity: sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} - globby@14.0.2: - resolution: {integrity: sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==} - engines: {node: '>=18'} - globrex@0.1.2: resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} @@ -2339,6 +2378,12 @@ packages: resolution: {integrity: sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==} engines: {node: '>= 0.4'} + hast-util-to-html@9.0.3: + resolution: {integrity: sha512-M17uBDzMJ9RPCqLMO92gNNUDuBSq10a25SDBI08iCCxmorf4Yy6sYHK57n9WAbRAAaU+DuR4W6GN9K4DFZesYg==} + + hast-util-whitespace@3.0.0: + resolution: {integrity: sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==} + he@1.2.0: resolution: {integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==} hasBin: true @@ -2361,6 +2406,9 @@ packages: resolution: {integrity: sha512-oWv4T4yJ52iKrufjnyZPkrN0CH3QnrUqdB6In1g5Fe1mia8GmF36gnfNySxoZtxD5+NmYw1EElVXiBk93UeskA==} engines: {node: '>=12'} + html-void-elements@3.0.0: + resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==} + http-proxy-agent@5.0.0: resolution: {integrity: sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w==} engines: {node: '>= 6'} @@ -2369,8 +2417,8 @@ packages: resolution: {integrity: sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==} engines: {node: '>= 6'} - https-proxy-agent@7.0.4: - resolution: {integrity: sha512-wlwpilI7YdjSkWaQ/7omYBMTliDcmCN8OLihO6I9B86g06lMyAoqgoDpV0XqoaPOKj+0DIdAvnsWfyAAhmimcg==} + https-proxy-agent@7.0.5: + resolution: {integrity: sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==} engines: {node: '>= 14'} human-id@1.0.2: @@ -2550,10 +2598,6 @@ packages: lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} - load-yaml-file@0.2.0: - resolution: {integrity: sha512-OfCBkGEw4nN6JLtgRidPX6QxjBQGQf72q3si2uvqyFEMbycSFFHwAZeXx6cJgFM9wmLrf9zBwCP3Ivqa+LLZPw==} - engines: {node: '>=6'} - locate-character@3.0.0: resolution: {integrity: sha512-SW13ws7BjaeJ6p7Q6CO2nchbYEc3X3J6WrmTTDto7yMPqVSZTUyY5Tjbid+Ab8gLnATtygYtiDIJGQRRn2ZOiA==} @@ -2606,6 +2650,9 @@ packages: mark.js@8.11.1: resolution: {integrity: sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==} + mdast-util-to-hast@13.2.0: + resolution: {integrity: sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==} + mdn-data@2.0.30: resolution: {integrity: sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==} @@ -2624,6 +2671,21 @@ packages: resolution: {integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==} engines: {node: '>= 0.6'} + micromark-util-character@2.1.0: + resolution: {integrity: sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==} + + micromark-util-encode@2.0.0: + resolution: {integrity: sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==} + + micromark-util-sanitize-uri@2.0.0: + resolution: {integrity: sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==} + + micromark-util-symbol@2.0.0: + resolution: {integrity: sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==} + + micromark-util-types@2.0.0: + resolution: {integrity: sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==} + micromatch@4.0.8: resolution: {integrity: sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==} engines: {node: '>=8.6'} @@ -2685,8 +2747,8 @@ packages: resolution: {integrity: sha512-eu38+hdgojoyq63s+yTpN4XMBdt5l8HhMhc4VKLO9KM5caLIBvUm4thi7fFaxyTmCKeNnXZ5pAlBwCUnhA09uw==} engines: {node: '>=10'} - ms@2.1.2: - resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==} + ms@2.1.3: + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} msw@2.4.1: resolution: {integrity: sha512-HXcoQPzYTwEmVk+BGIcRa0vLabBT+J20SSSeYh/QfajaK5ceA6dlD4ZZjfz2dqGEq4vRNCPLP6eXsB94KllPFg==} @@ -2780,6 +2842,9 @@ packages: resolution: {integrity: sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==} engines: {node: '>=12'} + oniguruma-to-js@0.4.3: + resolution: {integrity: sha512-X0jWUcAlxORhOqqBREgPMgnshB7ZGYszBNspP+tS9hPD3l13CdaXcHbgImoHUHlrvGx/7AvFEkTRhAGYh+jzjQ==} + openapi-typescript-codegen@0.25.0: resolution: {integrity: sha512-nN/TnIcGbP58qYgwEEy5FrAAjePcYgfMaCe3tsmYyTgI3v4RR9v8os14L+LEWDvV50+CmqiyTzRkKKtJeb6Ybg==} hasBin: true @@ -2830,6 +2895,9 @@ packages: resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} engines: {node: '>=6'} + package-manager-detector@0.2.0: + resolution: {integrity: sha512-E385OSk9qDcXhcM9LNSe4sdhx8a9mAPrZ4sMLW+tmxl5ZuGtPUcdFu+MPP2jbgiWAZ6Pfe5soGFMd+0Db5Vrog==} + parse-json@5.2.0: resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} engines: {node: '>=8'} @@ -2867,10 +2935,6 @@ packages: resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} engines: {node: '>=8'} - path-type@5.0.0: - resolution: {integrity: sha512-5HviZNaZcfqP95rwpv+1HDgUamezbqdSYTyzjTvwtJSnIH+3vnbmWsItli8OFEndS984VT55M3jduxZbX351gg==} - engines: {node: '>=12'} - pathe@1.1.2: resolution: {integrity: sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==} @@ -2884,9 +2948,6 @@ packages: periscopic@3.1.0: resolution: {integrity: sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==} - picocolors@1.0.1: - resolution: {integrity: sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==} - picocolors@1.1.0: resolution: {integrity: sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==} @@ -2894,21 +2955,21 @@ packages: resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==} engines: {node: '>=8.6'} + picomatch@4.0.2: + resolution: {integrity: sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==} + engines: {node: '>=12'} + pify@4.0.1: resolution: {integrity: sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==} engines: {node: '>=6'} - pkg-dir@4.2.0: - resolution: {integrity: sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==} - engines: {node: '>=8'} - - playwright-core@1.46.1: - resolution: {integrity: sha512-h9LqIQaAv+CYvWzsZ+h3RsrqCStkBHlgo6/TJlFst3cOTlLghBQlJwPOZKQJTKNaD3QIB7aAVQ+gfWbN3NXB7A==} + playwright-core@1.47.1: + resolution: {integrity: sha512-i1iyJdLftqtt51mEk6AhYFaAJCDx0xQ/O5NU8EKaWFgMjItPVma542Nh/Aq8aLCjIJSzjaiEQGW/nyqLkGF1OQ==} engines: {node: '>=18'} hasBin: true - playwright@1.46.1: - resolution: {integrity: sha512-oPcr1yqoXLCkgKtD5eNUPLiN40rYEM39odNpIb6VE6S7/15gJmA1NzVv6zJYusV0e7tzvkU/utBFNa/Kpxmwng==} + playwright@1.47.1: + resolution: {integrity: sha512-SUEKi6947IqYbKxRiqnbUobVZY4bF1uu+ZnZNJX9DfU1tlf2UhWfvVjLf01pQx9URsOr18bFVUKXmanYWhbfkw==} engines: {node: '>=18'} hasBin: true @@ -2920,16 +2981,12 @@ packages: resolution: {integrity: sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==} engines: {node: ^10 || ^12 || >=14} - postcss@8.4.44: - resolution: {integrity: sha512-Aweb9unOEpQ3ezu4Q00DPvvM2ZTUitJdNKeP/+uQgr1IBIqu574IaZoURId7BKtWMREwzKa9OgzPzezWGPWFQw==} + postcss@8.4.47: + resolution: {integrity: sha512-56rxCq7G/XfB4EkXq9Egn5GCqugWvDFjafDOThIdMBsI15iqPqR5r15TfSr1YPYeEI19YeaXMCbY6u88Y76GLQ==} engines: {node: ^10 || ^12 || >=14} - preact@10.23.1: - resolution: {integrity: sha512-O5UdRsNh4vdZaTieWe3XOgSpdMAmkIYBCT3VhQDlKrzyCm8lUYsk0fmVEvoQQifoOjFRTaHZO69ylrzTW2BH+A==} - - preferred-pm@3.1.4: - resolution: {integrity: sha512-lEHd+yEm22jXdCphDrkvIJQU66EuLojPPtvZkpKIkiD+l0DMThF/niqZKJSoU8Vl7iuvtmzyMhir9LdVy5WMnA==} - engines: {node: '>=10'} + preact@10.24.0: + resolution: {integrity: sha512-aK8Cf+jkfyuZ0ZZRG9FbYqwmEiGQ4y/PUO4SuTWoyWL244nZZh7bd5h2APd4rSNDYTBNghg1L+5iJN3Skxtbsw==} prettier@2.8.8: resolution: {integrity: sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==} @@ -2945,6 +3002,9 @@ packages: resolution: {integrity: sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==} engines: {node: ^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0} + property-information@6.5.0: + resolution: {integrity: sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==} + proxy-from-env@1.1.0: resolution: {integrity: sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==} @@ -3016,6 +3076,9 @@ packages: regenerator-runtime@0.14.1: resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} + regex@4.3.2: + resolution: {integrity: sha512-kK/AA3A9K6q2js89+VMymcboLOlF5lZRCYJv3gzszXFHBr6kO6qLGzbm+UIugBEV8SMMKCTR59txoY6ctRHYVw==} + require-directory@2.1.1: resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==} engines: {node: '>=0.10.0'} @@ -3048,8 +3111,8 @@ packages: deprecated: Rimraf versions prior to v4 are no longer supported hasBin: true - rollup@4.21.2: - resolution: {integrity: sha512-e3TapAgYf9xjdLvKQCkQTnbTKd4a6jwlpQSJJFokHGaX2IVjoEqkIIhiQfqsi0cdwlOD+tQGuOd5AJkc5RngBw==} + rollup@4.22.2: + resolution: {integrity: sha512-JWWpTrZmqQGQWt16xvNn6KVIUz16VtZwl984TKw0dfqqRpFwtLJYYk1/4BTgplndMQKWUk/yB4uOShYmMzA2Vg==} engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true @@ -3108,8 +3171,8 @@ packages: resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} engines: {node: '>=8'} - shiki@1.12.1: - resolution: {integrity: sha512-nwmjbHKnOYYAe1aaQyEBHvQymJgfm86ZSS7fT8OaPRr4sbAcBNz7PbfAikMEFSDQ6se2j2zobkXvVKcBOm0ysg==} + shiki@1.18.0: + resolution: {integrity: sha512-8jo7tOXr96h9PBQmOHVrltnETn1honZZY76YA79MHheGQg55jBvbm9dtU+MI5pjC5NJCFuA6rvVTLVeSW5cE4A==} side-channel@1.0.6: resolution: {integrity: sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==} @@ -3129,8 +3192,8 @@ packages: resolution: {integrity: sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==} engines: {node: '>= 10'} - size-limit@11.1.4: - resolution: {integrity: sha512-V2JAI/Z7h8sEuxU3V+Ig3XKA5FcYbI4CZ7sh6s7wvuy+TUwDZYqw7sAqrHhQ4cgcNfPKIAHAaH8VaqOdbcwJDA==} + size-limit@11.1.5: + resolution: {integrity: sha512-dtw/Tcm+9aonYySPG6wQCe1BwogK5HRGSrSqr0zXGfKtynJGvKAsyHCTGxdphFEHjHRoHFWua3D3zqYLUVVIig==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true @@ -3142,22 +3205,21 @@ packages: resolution: {integrity: sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==} engines: {node: '>=12'} - slash@5.1.0: - resolution: {integrity: sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==} - engines: {node: '>=14.16'} - sorcery@0.11.1: resolution: {integrity: sha512-o7npfeJE6wi6J9l0/5LKshFzZ2rMatRiCDwYeDQaOzqdzRJwALhX7mk/A/ecg6wjMu7wdZbmXfD2S/vpOg0bdQ==} hasBin: true - source-map-js@1.2.0: - resolution: {integrity: sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==} + source-map-js@1.2.1: + resolution: {integrity: sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==} engines: {node: '>=0.10.0'} source-map@0.6.1: resolution: {integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==} engines: {node: '>=0.10.0'} + space-separated-tokens@2.0.2: + resolution: {integrity: sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==} + spawndamnit@2.0.0: resolution: {integrity: sha512-j4JKEcncSjFlqIwU5L/rp2N5SIPsdxaRsIv678+TZxZ0SRDJTm8JrxJMjE/XuiEZNEir3S8l0Fa3Ke339WI4qA==} @@ -3201,6 +3263,9 @@ packages: resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} engines: {node: '>=8'} + stringify-entities@4.0.4: + resolution: {integrity: sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==} + strip-ansi@6.0.1: resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} engines: {node: '>=8'} @@ -3327,6 +3392,13 @@ packages: tinybench@2.9.0: resolution: {integrity: sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==} + tinyexec@0.3.0: + resolution: {integrity: sha512-tVGE0mVJPGb0chKhqmsoosjsS+qUnJVGJpZgsHYQcGoPlG3B51R3PouqTgEGH2Dc9jjFyOqOpix6ZHNMXp1FZg==} + + tinyglobby@0.2.6: + resolution: {integrity: sha512-NbBoFBpqfcgd1tCiO8Lkfdk+xrA7mlLR9zgvZcZWQQwU63XAfUePyd6wZBaU93Hqw347lHnwFzttAkemHzzz4g==} + engines: {node: '>=12.0.0'} + tinypool@1.0.1: resolution: {integrity: sha512-URZYihUbRPcGv95En+sz6MfghfIc2OJ1sv/RmhWZLouPY0/8Vo80viwPvg3dlaS9fuq7fQMEfgRRK7BBZThBEA==} engines: {node: ^18.0.0 || >=20.0.0} @@ -3335,8 +3407,8 @@ packages: resolution: {integrity: sha512-weEDEq7Z5eTHPDh4xjX789+fHfF+P8boiFB+0vbWzpbnbsEr/GRaohi/uMKxg8RZMXnl1ItAi/IUHWMsjDV7kQ==} engines: {node: '>=14.0.0'} - tinyspy@3.0.0: - resolution: {integrity: sha512-q5nmENpTHgiPVd1cJDDc9cVoYN5x4vCvwT3FMilvKPKneCBZAxn2YWQjDF0UMcE9k0Cay1gBiDfTMU0g+mPMQA==} + tinyspy@3.0.2: + resolution: {integrity: sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==} engines: {node: '>=14.0.0'} tmp@0.0.33: @@ -3366,6 +3438,9 @@ packages: resolution: {integrity: sha512-l7FvfAHlcmulp8kr+flpQZmVwtu7nfRV7NZujtN0OqES8EL4O4e0qqzL0DC5gAvx/ZC/9lk6rhcUwYvkBnBnYA==} engines: {node: '>=12'} + trim-lines@3.0.1: + resolution: {integrity: sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==} + trim-newlines@4.1.1: resolution: {integrity: sha512-jRKj0n0jXWo6kh62nA5TEh3+4igKDXLvzBJcPpiizP7oOolUrYIxmVBG9TOtHYFHoddUk6YvAkGeGoSVTXfQXQ==} engines: {node: '>=12'} @@ -3384,14 +3459,14 @@ packages: resolution: {integrity: sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==} engines: {node: '>=10'} - type-fest@4.20.1: - resolution: {integrity: sha512-R6wDsVsoS9xYOpy8vgeBlqpdOyzJ12HNfQhC/aAKWM3YoCV9TtunJzh/QpkMgeDhkoynDcw5f1y+qF9yc/HHyg==} - engines: {node: '>=16'} - type-fest@4.26.0: resolution: {integrity: sha512-OduNjVJsFbifKb57UqZ2EMP1i4u64Xwow3NYXUtBbD4vIwJdQd4+xl8YDou1dlm4DVrtwT/7Ky8z8WyCULVfxw==} engines: {node: '>=16'} + type-fest@4.26.1: + resolution: {integrity: sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==} + engines: {node: '>=16'} + typescript@5.4.5: resolution: {integrity: sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==} engines: {node: '>=14.17'} @@ -3402,6 +3477,11 @@ packages: engines: {node: '>=14.17'} hasBin: true + typescript@5.6.2: + resolution: {integrity: sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==} + 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'} @@ -3410,9 +3490,20 @@ packages: undici-types@6.19.8: resolution: {integrity: sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==} - unicorn-magic@0.1.0: - resolution: {integrity: sha512-lRfVq8fE8gz6QMBuDM6a+LO3IAzTi05H6gCVaUpir2E1Rwpo4ZUog45KpNXKC/Mn3Yb9UDuHumeFTo9iV/D9FQ==} - engines: {node: '>=18'} + unist-util-is@6.0.0: + resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==} + + unist-util-position@5.0.0: + resolution: {integrity: sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==} + + unist-util-stringify-position@4.0.0: + resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} + + unist-util-visit-parents@6.0.1: + resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==} + + unist-util-visit@5.0.0: + resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==} universalify@0.1.2: resolution: {integrity: sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==} @@ -3432,8 +3523,8 @@ packages: peerDependencies: browserslist: '>= 4.21.0' - uri-js@4.4.1: - resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} + uri-js-replace@1.0.1: + resolution: {integrity: sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g==} url-parse@1.5.10: resolution: {integrity: sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==} @@ -3441,44 +3532,19 @@ packages: validate-npm-package-license@3.0.4: resolution: {integrity: sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==} - vite-node@2.0.5: - resolution: {integrity: sha512-LdsW4pxj0Ot69FAoXZ1yTnA9bjGohr2yNBU7QKRxpz8ITSkhuDl6h3zS/tvgz4qrNjeRnvrWeXQ8ZF7Um4W00Q==} - engines: {node: ^18.0.0 || >=20.0.0} - hasBin: true + vfile-message@4.0.2: + resolution: {integrity: sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==} + + vfile@6.0.3: + resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} - vite@5.4.2: - resolution: {integrity: sha512-dDrQTRHp5C1fTFzcSaMxjk6vdpKvT+2/mIdE07Gw2ykehT49O0z/VHS3zZ8iV/Gh8BJJKHWOe5RjaNrW5xf/GA==} + vite-node@2.1.1: + resolution: {integrity: sha512-N/mGckI1suG/5wQI35XeR9rsMsPqKXzq1CdUndzVstBj/HvyxxGctwnK6WX43NGt5L3Z5tcRf83g4TITKJhPrA==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true - peerDependencies: - '@types/node': ^18.0.0 || >=20.0.0 - less: '*' - lightningcss: ^1.21.0 - sass: '*' - sass-embedded: '*' - stylus: '*' - sugarss: '*' - terser: ^5.4.0 - peerDependenciesMeta: - '@types/node': - optional: true - less: - optional: true - lightningcss: - optional: true - sass: - optional: true - sass-embedded: - optional: true - stylus: - optional: true - sugarss: - optional: true - terser: - optional: true - vite@5.4.3: - resolution: {integrity: sha512-IH+nl64eq9lJjFqU+/yrRnrHPVTlgy42/+IzbOdaFDVlyLgI/wDlf+FCobXLX1cT0X5+7LMyH1mIy2xJdLfo8Q==} + vite@5.4.6: + resolution: {integrity: sha512-IeL5f8OO5nylsgzd9tq4qD2QqI0k2CQLGrWD0rCN0EQJZpBK5vJAx0I+GDkMOXxQX/OfFHMuLIx6ddAxGX/k+Q==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: @@ -3528,15 +3594,15 @@ packages: postcss: optional: true - vitest@2.0.5: - resolution: {integrity: sha512-8GUxONfauuIdeSl5f9GTgVEpg5BTOlplET4WEDaeY2QBiN8wSm68vxN/tb5z405OwppfoCavnwXafiaYBC/xOA==} + vitest@2.1.1: + resolution: {integrity: sha512-97We7/VC0e9X5zBVkvt7SGQMGrRtn3KtySFQG5fpaMlS+l62eeXRQO633AYhSTC3z7IMebnPPNjGXVGNRFlxBA==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: '@edge-runtime/vm': '*' '@types/node': ^18.0.0 || >=20.0.0 - '@vitest/browser': 2.0.5 - '@vitest/ui': 2.0.5 + '@vitest/browser': 2.1.1 + '@vitest/ui': 2.1.1 happy-dom: '*' jsdom: '*' peerDependenciesMeta: @@ -3567,14 +3633,14 @@ packages: '@vue/composition-api': optional: true - vue-tsc@2.1.4: - resolution: {integrity: sha512-XTzMXQcsixAvNbpou/9qngEsZawaiJRZH3Ja+lfgRfv2A1TJv9vnZ/Kyv7XxPqv/TaZVFSnjGpM87VbWIg6yQg==} + vue-tsc@2.1.6: + resolution: {integrity: sha512-f98dyZp5FOukcYmbFpuSCJ4Z0vHSOSmxGttZJCsFeX0M4w/Rsq0s4uKXjcSRsZqsRgQa6z7SfuO+y0HVICE57Q==} hasBin: true peerDependencies: typescript: '>=5.0.0' - vue@3.5.0: - resolution: {integrity: sha512-1t70favYoFijwfWJ7g81aTd32obGaAnKYE9FNyMgnEzn3F4YncRi/kqAHHKloG0VXTD8vBYMhbgLKCA+Sk6QDw==} + vue@3.5.6: + resolution: {integrity: sha512-zv+20E2VIYbcJOzJPUWp03NOGFhMmpCKOfSxVTmCYyYFFko48H9tmuQFzYj7tu4qX1AeXlp9DmhIP89/sSxxhw==} peerDependencies: typescript: '*' peerDependenciesMeta: @@ -3607,10 +3673,6 @@ packages: whatwg-url@5.0.0: resolution: {integrity: sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==} - which-pm@2.2.0: - resolution: {integrity: sha512-MOiaDbA5ZZgUjkeMWM5EkJp4loW5ZRoa5bc3/aeMox/PJelMhE6t7S/mLuiY43DBupyxH+S0U1bTui9kWUlmsw==} - engines: {node: '>=8.15'} - which@1.3.1: resolution: {integrity: sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==} hasBin: true @@ -3694,6 +3756,9 @@ packages: resolution: {integrity: sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==} engines: {node: '>=18'} + zwitch@2.0.4: + resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} + snapshots: '@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.13.0)': @@ -3815,7 +3880,7 @@ snapshots: '@babel/code-frame@7.24.7': dependencies: '@babel/highlight': 7.24.7 - picocolors: 1.0.1 + picocolors: 1.1.0 '@babel/compat-data@7.25.4': {} @@ -3832,7 +3897,7 @@ snapshots: '@babel/traverse': 7.25.6 '@babel/types': 7.25.6 convert-source-map: 2.0.0 - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) gensync: 1.0.0-beta.2 json5: 2.2.3 semver: 6.3.1 @@ -3896,7 +3961,7 @@ snapshots: '@babel/helper-validator-identifier': 7.24.7 chalk: 2.4.2 js-tokens: 4.0.0 - picocolors: 1.0.1 + picocolors: 1.1.0 '@babel/parser@7.25.6': dependencies: @@ -3929,7 +3994,7 @@ snapshots: '@babel/parser': 7.25.6 '@babel/template': 7.25.0 '@babel/types': 7.25.6 - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) globals: 11.12.0 transitivePeerDependencies: - supports-color @@ -3940,39 +4005,39 @@ snapshots: '@babel/helper-validator-identifier': 7.24.7 to-fast-properties: 2.0.0 - '@biomejs/biome@1.8.3': + '@biomejs/biome@1.9.2': optionalDependencies: - '@biomejs/cli-darwin-arm64': 1.8.3 - '@biomejs/cli-darwin-x64': 1.8.3 - '@biomejs/cli-linux-arm64': 1.8.3 - '@biomejs/cli-linux-arm64-musl': 1.8.3 - '@biomejs/cli-linux-x64': 1.8.3 - '@biomejs/cli-linux-x64-musl': 1.8.3 - '@biomejs/cli-win32-arm64': 1.8.3 - '@biomejs/cli-win32-x64': 1.8.3 + '@biomejs/cli-darwin-arm64': 1.9.2 + '@biomejs/cli-darwin-x64': 1.9.2 + '@biomejs/cli-linux-arm64': 1.9.2 + '@biomejs/cli-linux-arm64-musl': 1.9.2 + '@biomejs/cli-linux-x64': 1.9.2 + '@biomejs/cli-linux-x64-musl': 1.9.2 + '@biomejs/cli-win32-arm64': 1.9.2 + '@biomejs/cli-win32-x64': 1.9.2 - '@biomejs/cli-darwin-arm64@1.8.3': + '@biomejs/cli-darwin-arm64@1.9.2': optional: true - '@biomejs/cli-darwin-x64@1.8.3': + '@biomejs/cli-darwin-x64@1.9.2': optional: true - '@biomejs/cli-linux-arm64-musl@1.8.3': + '@biomejs/cli-linux-arm64-musl@1.9.2': optional: true - '@biomejs/cli-linux-arm64@1.8.3': + '@biomejs/cli-linux-arm64@1.9.2': optional: true - '@biomejs/cli-linux-x64-musl@1.8.3': + '@biomejs/cli-linux-x64-musl@1.9.2': optional: true - '@biomejs/cli-linux-x64@1.8.3': + '@biomejs/cli-linux-x64@1.9.2': optional: true - '@biomejs/cli-win32-arm64@1.8.3': + '@biomejs/cli-win32-arm64@1.9.2': optional: true - '@biomejs/cli-win32-x64@1.8.3': + '@biomejs/cli-win32-x64@1.9.2': optional: true '@blgc/types@0.0.6': {} @@ -3992,13 +4057,12 @@ snapshots: '@types/tough-cookie': 4.0.5 tough-cookie: 4.1.4 - '@changesets/apply-release-plan@7.0.4': + '@changesets/apply-release-plan@7.0.5': dependencies: - '@babel/runtime': 7.25.6 - '@changesets/config': 3.0.2 + '@changesets/config': 3.0.3 '@changesets/get-version-range-type': 0.4.0 - '@changesets/git': 3.0.0 - '@changesets/should-skip-package': 0.1.0 + '@changesets/git': 3.0.1 + '@changesets/should-skip-package': 0.1.1 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 detect-indent: 6.1.0 @@ -4009,12 +4073,11 @@ snapshots: resolve-from: 5.0.0 semver: 7.6.3 - '@changesets/assemble-release-plan@6.0.3': + '@changesets/assemble-release-plan@6.0.4': dependencies: - '@babel/runtime': 7.25.6 '@changesets/errors': 0.2.0 - '@changesets/get-dependents-graph': 2.1.1 - '@changesets/should-skip-package': 0.1.0 + '@changesets/get-dependents-graph': 2.1.2 + '@changesets/should-skip-package': 0.1.1 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 semver: 7.6.3 @@ -4031,46 +4094,44 @@ snapshots: transitivePeerDependencies: - encoding - '@changesets/cli@2.27.7': + '@changesets/cli@2.27.8': dependencies: - '@babel/runtime': 7.25.6 - '@changesets/apply-release-plan': 7.0.4 - '@changesets/assemble-release-plan': 6.0.3 + '@changesets/apply-release-plan': 7.0.5 + '@changesets/assemble-release-plan': 6.0.4 '@changesets/changelog-git': 0.2.0 - '@changesets/config': 3.0.2 + '@changesets/config': 3.0.3 '@changesets/errors': 0.2.0 - '@changesets/get-dependents-graph': 2.1.1 - '@changesets/get-release-plan': 4.0.3 - '@changesets/git': 3.0.0 - '@changesets/logger': 0.1.0 - '@changesets/pre': 2.0.0 - '@changesets/read': 0.6.0 - '@changesets/should-skip-package': 0.1.0 + '@changesets/get-dependents-graph': 2.1.2 + '@changesets/get-release-plan': 4.0.4 + '@changesets/git': 3.0.1 + '@changesets/logger': 0.1.1 + '@changesets/pre': 2.0.1 + '@changesets/read': 0.6.1 + '@changesets/should-skip-package': 0.1.1 '@changesets/types': 6.0.0 - '@changesets/write': 0.3.1 + '@changesets/write': 0.3.2 '@manypkg/get-packages': 1.1.3 '@types/semver': 7.5.8 ansi-colors: 4.1.3 - chalk: 2.4.2 ci-info: 3.9.0 enquirer: 2.4.1 external-editor: 3.1.0 fs-extra: 7.0.1 - human-id: 1.0.2 mri: 1.2.0 outdent: 0.5.0 p-limit: 2.3.0 - preferred-pm: 3.1.4 + package-manager-detector: 0.2.0 + picocolors: 1.1.0 resolve-from: 5.0.0 semver: 7.6.3 spawndamnit: 2.0.0 term-size: 2.2.1 - '@changesets/config@3.0.2': + '@changesets/config@3.0.3': dependencies: '@changesets/errors': 0.2.0 - '@changesets/get-dependents-graph': 2.1.1 - '@changesets/logger': 0.1.0 + '@changesets/get-dependents-graph': 2.1.2 + '@changesets/logger': 0.1.1 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 fs-extra: 7.0.1 @@ -4080,12 +4141,11 @@ snapshots: dependencies: extendable-error: 0.1.7 - '@changesets/get-dependents-graph@2.1.1': + '@changesets/get-dependents-graph@2.1.2': dependencies: '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 - chalk: 2.4.2 - fs-extra: 7.0.1 + picocolors: 1.1.0 semver: 7.6.3 '@changesets/get-github-info@0.6.0': @@ -4095,59 +4155,53 @@ snapshots: transitivePeerDependencies: - encoding - '@changesets/get-release-plan@4.0.3': + '@changesets/get-release-plan@4.0.4': dependencies: - '@babel/runtime': 7.25.6 - '@changesets/assemble-release-plan': 6.0.3 - '@changesets/config': 3.0.2 - '@changesets/pre': 2.0.0 - '@changesets/read': 0.6.0 + '@changesets/assemble-release-plan': 6.0.4 + '@changesets/config': 3.0.3 + '@changesets/pre': 2.0.1 + '@changesets/read': 0.6.1 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 '@changesets/get-version-range-type@0.4.0': {} - '@changesets/git@3.0.0': + '@changesets/git@3.0.1': dependencies: - '@babel/runtime': 7.25.6 '@changesets/errors': 0.2.0 - '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 is-subdir: 1.2.0 micromatch: 4.0.8 spawndamnit: 2.0.0 - '@changesets/logger@0.1.0': + '@changesets/logger@0.1.1': dependencies: - chalk: 2.4.2 + picocolors: 1.1.0 '@changesets/parse@0.4.0': dependencies: '@changesets/types': 6.0.0 js-yaml: 3.14.1 - '@changesets/pre@2.0.0': + '@changesets/pre@2.0.1': dependencies: - '@babel/runtime': 7.25.6 '@changesets/errors': 0.2.0 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 fs-extra: 7.0.1 - '@changesets/read@0.6.0': + '@changesets/read@0.6.1': dependencies: - '@babel/runtime': 7.25.6 - '@changesets/git': 3.0.0 - '@changesets/logger': 0.1.0 + '@changesets/git': 3.0.1 + '@changesets/logger': 0.1.1 '@changesets/parse': 0.4.0 '@changesets/types': 6.0.0 - chalk: 2.4.2 fs-extra: 7.0.1 p-filter: 2.1.0 + picocolors: 1.1.0 - '@changesets/should-skip-package@0.1.0': + '@changesets/should-skip-package@0.1.1': dependencies: - '@babel/runtime': 7.25.6 '@changesets/types': 6.0.0 '@manypkg/get-packages': 1.1.3 @@ -4155,9 +4209,8 @@ snapshots: '@changesets/types@6.0.0': {} - '@changesets/write@0.3.1': + '@changesets/write@0.3.2': dependencies: - '@babel/runtime': 7.25.6 '@changesets/types': 6.0.0 fs-extra: 7.0.1 human-id: 1.0.2 @@ -4165,10 +4218,10 @@ snapshots: '@docsearch/css@3.6.1': {} - '@docsearch/js@3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': + '@docsearch/js@3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: - '@docsearch/react': 3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) - preact: 10.23.1 + '@docsearch/react': 3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) + preact: 10.24.0 transitivePeerDependencies: - '@algolia/client-search' - '@types/react' @@ -4176,14 +4229,14 @@ snapshots: - react-dom - search-insights - '@docsearch/react@3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': + '@docsearch/react@3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0)(search-insights@2.13.0) '@algolia/autocomplete-preset-algolia': 1.9.3(@algolia/client-search@4.24.0)(algoliasearch@4.24.0) '@docsearch/css': 3.6.1 algoliasearch: 4.24.0 optionalDependencies: - '@types/react': 18.3.3 + '@types/react': 18.3.8 react: 18.3.1 react-dom: 18.3.1(react@18.3.1) search-insights: 2.13.0 @@ -4410,7 +4463,7 @@ snapshots: '@inquirer/figures': 1.0.5 '@inquirer/type': 1.5.3 '@types/mute-stream': 0.0.4 - '@types/node': 22.5.2 + '@types/node': 22.5.5 '@types/wrap-ansi': 3.0.0 ansi-escapes: 4.3.2 cli-spinners: 2.9.2 @@ -4521,27 +4574,27 @@ snapshots: '@open-draft/until@2.1.0': {} - '@playwright/test@1.46.1': + '@playwright/test@1.47.1': dependencies: - playwright: 1.46.1 + playwright: 1.47.1 - '@polka/url@1.0.0-next.25': {} + '@polka/url@1.0.0-next.28': {} - '@redocly/ajv@8.11.0': + '@redocly/ajv@8.11.2': dependencies: fast-deep-equal: 3.1.3 json-schema-traverse: 1.0.0 require-from-string: 2.0.2 - uri-js: 4.4.1 + uri-js-replace: 1.0.1 - '@redocly/config@0.6.0': {} + '@redocly/config@0.11.0': {} - '@redocly/openapi-core@1.16.0(supports-color@9.4.0)': + '@redocly/openapi-core@1.25.3(supports-color@9.4.0)': dependencies: - '@redocly/ajv': 8.11.0 - '@redocly/config': 0.6.0 + '@redocly/ajv': 8.11.2 + '@redocly/config': 0.11.0 colorette: 1.4.0 - https-proxy-agent: 7.0.4(supports-color@9.4.0) + https-proxy-agent: 7.0.5(supports-color@9.4.0) js-levenshtein: 1.1.6 js-yaml: 4.1.0 lodash.isequal: 4.5.0 @@ -4553,88 +4606,109 @@ snapshots: - encoding - supports-color - '@rollup/rollup-android-arm-eabi@4.21.2': + '@rollup/rollup-android-arm-eabi@4.22.2': optional: true - '@rollup/rollup-android-arm64@4.21.2': + '@rollup/rollup-android-arm64@4.22.2': optional: true - '@rollup/rollup-darwin-arm64@4.21.2': + '@rollup/rollup-darwin-arm64@4.22.2': optional: true - '@rollup/rollup-darwin-x64@4.21.2': + '@rollup/rollup-darwin-x64@4.22.2': optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.21.2': + '@rollup/rollup-linux-arm-gnueabihf@4.22.2': optional: true - '@rollup/rollup-linux-arm-musleabihf@4.21.2': + '@rollup/rollup-linux-arm-musleabihf@4.22.2': optional: true - '@rollup/rollup-linux-arm64-gnu@4.21.2': + '@rollup/rollup-linux-arm64-gnu@4.22.2': optional: true - '@rollup/rollup-linux-arm64-musl@4.21.2': + '@rollup/rollup-linux-arm64-musl@4.22.2': optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.21.2': + '@rollup/rollup-linux-powerpc64le-gnu@4.22.2': optional: true - '@rollup/rollup-linux-riscv64-gnu@4.21.2': + '@rollup/rollup-linux-riscv64-gnu@4.22.2': optional: true - '@rollup/rollup-linux-s390x-gnu@4.21.2': + '@rollup/rollup-linux-s390x-gnu@4.22.2': optional: true - '@rollup/rollup-linux-x64-gnu@4.21.2': + '@rollup/rollup-linux-x64-gnu@4.22.2': optional: true - '@rollup/rollup-linux-x64-musl@4.21.2': + '@rollup/rollup-linux-x64-musl@4.22.2': optional: true - '@rollup/rollup-win32-arm64-msvc@4.21.2': + '@rollup/rollup-win32-arm64-msvc@4.22.2': optional: true - '@rollup/rollup-win32-ia32-msvc@4.21.2': + '@rollup/rollup-win32-ia32-msvc@4.22.2': optional: true - '@rollup/rollup-win32-x64-msvc@4.21.2': + '@rollup/rollup-win32-x64-msvc@4.22.2': optional: true - '@shikijs/core@1.12.1': + '@shikijs/core@1.18.0': dependencies: + '@shikijs/engine-javascript': 1.18.0 + '@shikijs/engine-oniguruma': 1.18.0 + '@shikijs/types': 1.18.0 + '@shikijs/vscode-textmate': 9.2.2 '@types/hast': 3.0.4 + hast-util-to-html: 9.0.3 - '@shikijs/transformers@1.12.1': + '@shikijs/engine-javascript@1.18.0': dependencies: - shiki: 1.12.1 + '@shikijs/types': 1.18.0 + '@shikijs/vscode-textmate': 9.2.2 + oniguruma-to-js: 0.4.3 - '@sindresorhus/merge-streams@2.3.0': {} + '@shikijs/engine-oniguruma@1.18.0': + dependencies: + '@shikijs/types': 1.18.0 + '@shikijs/vscode-textmate': 9.2.2 - '@size-limit/esbuild@11.1.4(size-limit@11.1.4)': + '@shikijs/transformers@1.18.0': dependencies: - esbuild: 0.21.5 + shiki: 1.18.0 + + '@shikijs/types@1.18.0': + dependencies: + '@shikijs/vscode-textmate': 9.2.2 + '@types/hast': 3.0.4 + + '@shikijs/vscode-textmate@9.2.2': {} + + '@size-limit/esbuild@11.1.5(size-limit@11.1.5)': + dependencies: + esbuild: 0.23.1 nanoid: 5.0.7 - size-limit: 11.1.4 + size-limit: 11.1.5 - '@size-limit/file@11.1.4(size-limit@11.1.4)': + '@size-limit/file@11.1.5(size-limit@11.1.5)': dependencies: - size-limit: 11.1.4 + size-limit: 11.1.5 - '@size-limit/preset-small-lib@11.1.4(size-limit@11.1.4)': + '@size-limit/preset-small-lib@11.1.5(size-limit@11.1.5)': dependencies: - '@size-limit/esbuild': 11.1.4(size-limit@11.1.4) - '@size-limit/file': 11.1.4(size-limit@11.1.4) - size-limit: 11.1.4 + '@size-limit/esbuild': 11.1.5(size-limit@11.1.5) + '@size-limit/file': 11.1.5(size-limit@11.1.5) + size-limit: 11.1.5 - '@sveltejs/adapter-auto@3.2.4(@sveltejs/kit@2.5.25(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))': + '@sveltejs/adapter-auto@3.2.5(@sveltejs/kit@2.5.28(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))': dependencies: - '@sveltejs/kit': 2.5.25(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) + '@sveltejs/kit': 2.5.28(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) import-meta-resolve: 4.1.0 - '@sveltejs/kit@2.5.25(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2))': + '@sveltejs/kit@2.5.28(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5))': dependencies: - '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) + '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) '@types/cookie': 0.6.0 cookie: 0.6.0 devalue: 5.0.0 @@ -4648,76 +4722,76 @@ snapshots: sirv: 2.0.4 svelte: 4.2.19 tiny-glob: 0.2.9 - vite: 5.4.3(@types/node@22.5.2) + vite: 5.4.6(@types/node@22.5.5) - '@sveltejs/vite-plugin-svelte-inspector@2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2))': + '@sveltejs/vite-plugin-svelte-inspector@2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5))': dependencies: - '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) - debug: 4.3.6(supports-color@9.4.0) + '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) + debug: 4.3.7(supports-color@9.4.0) svelte: 4.2.19 - vite: 5.4.3(@types/node@22.5.2) + vite: 5.4.6(@types/node@22.5.5) transitivePeerDependencies: - supports-color - '@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2))': + '@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5))': dependencies: - '@sveltejs/vite-plugin-svelte-inspector': 2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)))(svelte@4.2.19)(vite@5.4.3(@types/node@22.5.2)) - debug: 4.3.6(supports-color@9.4.0) + '@sveltejs/vite-plugin-svelte-inspector': 2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)))(svelte@4.2.19)(vite@5.4.6(@types/node@22.5.5)) + debug: 4.3.7(supports-color@9.4.0) deepmerge: 4.3.1 kleur: 4.1.5 magic-string: 0.30.11 svelte: 4.2.19 svelte-hmr: 0.16.0(svelte@4.2.19) - vite: 5.4.3(@types/node@22.5.2) - vitefu: 0.2.5(vite@5.4.3(@types/node@22.5.2)) + vite: 5.4.6(@types/node@22.5.5) + vitefu: 0.2.5(vite@5.4.6(@types/node@22.5.5)) transitivePeerDependencies: - supports-color - '@swc/core-darwin-arm64@1.7.23': + '@swc/core-darwin-arm64@1.7.26': optional: true - '@swc/core-darwin-x64@1.7.23': + '@swc/core-darwin-x64@1.7.26': optional: true - '@swc/core-linux-arm-gnueabihf@1.7.23': + '@swc/core-linux-arm-gnueabihf@1.7.26': optional: true - '@swc/core-linux-arm64-gnu@1.7.23': + '@swc/core-linux-arm64-gnu@1.7.26': optional: true - '@swc/core-linux-arm64-musl@1.7.23': + '@swc/core-linux-arm64-musl@1.7.26': optional: true - '@swc/core-linux-x64-gnu@1.7.23': + '@swc/core-linux-x64-gnu@1.7.26': optional: true - '@swc/core-linux-x64-musl@1.7.23': + '@swc/core-linux-x64-musl@1.7.26': optional: true - '@swc/core-win32-arm64-msvc@1.7.23': + '@swc/core-win32-arm64-msvc@1.7.26': optional: true - '@swc/core-win32-ia32-msvc@1.7.23': + '@swc/core-win32-ia32-msvc@1.7.26': optional: true - '@swc/core-win32-x64-msvc@1.7.23': + '@swc/core-win32-x64-msvc@1.7.26': optional: true - '@swc/core@1.7.23(@swc/helpers@0.5.5)': + '@swc/core@1.7.26(@swc/helpers@0.5.5)': dependencies: '@swc/counter': 0.1.3 '@swc/types': 0.1.12 optionalDependencies: - '@swc/core-darwin-arm64': 1.7.23 - '@swc/core-darwin-x64': 1.7.23 - '@swc/core-linux-arm-gnueabihf': 1.7.23 - '@swc/core-linux-arm64-gnu': 1.7.23 - '@swc/core-linux-arm64-musl': 1.7.23 - '@swc/core-linux-x64-gnu': 1.7.23 - '@swc/core-linux-x64-musl': 1.7.23 - '@swc/core-win32-arm64-msvc': 1.7.23 - '@swc/core-win32-ia32-msvc': 1.7.23 - '@swc/core-win32-x64-msvc': 1.7.23 + '@swc/core-darwin-arm64': 1.7.26 + '@swc/core-darwin-x64': 1.7.26 + '@swc/core-linux-arm-gnueabihf': 1.7.26 + '@swc/core-linux-arm64-gnu': 1.7.26 + '@swc/core-linux-arm64-musl': 1.7.26 + '@swc/core-linux-x64-gnu': 1.7.26 + '@swc/core-linux-x64-musl': 1.7.26 + '@swc/core-win32-arm64-msvc': 1.7.26 + '@swc/core-win32-ia32-msvc': 1.7.26 + '@swc/core-win32-x64-msvc': 1.7.26 '@swc/helpers': 0.5.5 '@swc/counter@0.1.3': {} @@ -4733,11 +4807,18 @@ snapshots: '@tanstack/query-core@5.53.3': {} + '@tanstack/query-core@5.56.2': {} + '@tanstack/react-query@5.53.3(react@18.3.1)': dependencies: '@tanstack/query-core': 5.53.3 react: 18.3.1 + '@tanstack/react-query@5.56.2(react@18.3.1)': + dependencies: + '@tanstack/query-core': 5.56.2 + react: 18.3.1 + '@testing-library/dom@10.1.0': dependencies: '@babel/code-frame': 7.24.7 @@ -4793,9 +4874,11 @@ snapshots: '@types/estree@1.0.5': {} + '@types/estree@1.0.6': {} + '@types/hast@3.0.4': dependencies: - '@types/unist': 3.0.2 + '@types/unist': 3.0.3 '@types/js-yaml@4.0.9': {} @@ -4808,27 +4891,27 @@ snapshots: '@types/linkify-it': 5.0.0 '@types/mdurl': 2.0.0 + '@types/mdast@4.0.4': + dependencies: + '@types/unist': 3.0.3 + '@types/mdurl@2.0.0': {} '@types/minimist@1.2.5': {} '@types/mute-stream@0.0.4': dependencies: - '@types/node': 20.16.3 + '@types/node': 22.5.5 '@types/node@12.20.55': {} - '@types/node@20.16.3': - dependencies: - undici-types: 6.19.8 - - '@types/node@22.5.2': + '@types/node@22.5.5': dependencies: undici-types: 6.19.8 '@types/normalize-package-data@2.4.4': {} - '@types/prop-types@15.7.12': {} + '@types/prop-types@15.7.13': {} '@types/pug@2.0.10': {} @@ -4838,12 +4921,12 @@ snapshots: '@types/react@18.3.1': dependencies: - '@types/prop-types': 15.7.12 + '@types/prop-types': 15.7.13 csstype: 3.1.3 - '@types/react@18.3.3': + '@types/react@18.3.8': dependencies: - '@types/prop-types': 15.7.12 + '@types/prop-types': 15.7.13 csstype: 3.1.3 '@types/semver@7.5.8': {} @@ -4852,122 +4935,132 @@ snapshots: '@types/tough-cookie@4.0.5': {} - '@types/unist@3.0.2': {} + '@types/unist@3.0.3': {} '@types/web-bluetooth@0.0.20': {} '@types/wrap-ansi@3.0.0': {} - '@vitejs/plugin-react-swc@3.7.0(@swc/helpers@0.5.5)(vite@5.4.3(@types/node@22.5.2))': + '@ungap/structured-clone@1.2.0': {} + + '@vitejs/plugin-react-swc@3.7.0(@swc/helpers@0.5.5)(vite@5.4.6(@types/node@22.5.5))': dependencies: - '@swc/core': 1.7.23(@swc/helpers@0.5.5) - vite: 5.4.3(@types/node@22.5.2) + '@swc/core': 1.7.26(@swc/helpers@0.5.5) + vite: 5.4.6(@types/node@22.5.5) transitivePeerDependencies: - '@swc/helpers' - '@vitejs/plugin-react@4.3.1(vite@5.4.3(@types/node@22.5.2))': + '@vitejs/plugin-react@4.3.1(vite@5.4.6(@types/node@22.5.5))': dependencies: '@babel/core': 7.25.2 '@babel/plugin-transform-react-jsx-self': 7.24.7(@babel/core@7.25.2) '@babel/plugin-transform-react-jsx-source': 7.24.7(@babel/core@7.25.2) '@types/babel__core': 7.20.5 react-refresh: 0.14.2 - vite: 5.4.3(@types/node@22.5.2) + vite: 5.4.6(@types/node@22.5.5) transitivePeerDependencies: - supports-color - '@vitejs/plugin-vue@5.1.3(vite@5.4.3(@types/node@22.5.2))(vue@3.5.0(typescript@5.5.4))': + '@vitejs/plugin-vue@5.1.4(vite@5.4.6(@types/node@22.5.5))(vue@3.5.6(typescript@5.6.2))': dependencies: - vite: 5.4.3(@types/node@22.5.2) - vue: 3.5.0(typescript@5.5.4) + vite: 5.4.6(@types/node@22.5.5) + vue: 3.5.6(typescript@5.6.2) - '@vitest/expect@2.0.5': + '@vitest/expect@2.1.1': dependencies: - '@vitest/spy': 2.0.5 - '@vitest/utils': 2.0.5 + '@vitest/spy': 2.1.1 + '@vitest/utils': 2.1.1 chai: 5.1.1 tinyrainbow: 1.2.0 - '@vitest/pretty-format@2.0.5': + '@vitest/mocker@2.1.1(@vitest/spy@2.1.1)(msw@2.4.1(graphql@16.8.2)(typescript@5.6.2))(vite@5.4.6(@types/node@22.5.5))': + dependencies: + '@vitest/spy': 2.1.1 + estree-walker: 3.0.3 + magic-string: 0.30.11 + optionalDependencies: + msw: 2.4.1(graphql@16.8.2)(typescript@5.6.2) + vite: 5.4.6(@types/node@22.5.5) + + '@vitest/pretty-format@2.1.1': dependencies: tinyrainbow: 1.2.0 - '@vitest/runner@2.0.5': + '@vitest/runner@2.1.1': dependencies: - '@vitest/utils': 2.0.5 + '@vitest/utils': 2.1.1 pathe: 1.1.2 - '@vitest/snapshot@2.0.5': + '@vitest/snapshot@2.1.1': dependencies: - '@vitest/pretty-format': 2.0.5 + '@vitest/pretty-format': 2.1.1 magic-string: 0.30.11 pathe: 1.1.2 - '@vitest/spy@2.0.5': + '@vitest/spy@2.1.1': dependencies: - tinyspy: 3.0.0 + tinyspy: 3.0.2 - '@vitest/utils@2.0.5': + '@vitest/utils@2.1.1': dependencies: - '@vitest/pretty-format': 2.0.5 - estree-walker: 3.0.3 + '@vitest/pretty-format': 2.1.1 loupe: 3.1.1 tinyrainbow: 1.2.0 - '@volar/language-core@2.4.1': + '@volar/language-core@2.4.5': dependencies: - '@volar/source-map': 2.4.1 + '@volar/source-map': 2.4.5 - '@volar/source-map@2.4.1': {} + '@volar/source-map@2.4.5': {} - '@volar/typescript@2.4.1': + '@volar/typescript@2.4.5': dependencies: - '@volar/language-core': 2.4.1 + '@volar/language-core': 2.4.5 path-browserify: 1.0.1 vscode-uri: 3.0.8 - '@vue/compiler-core@3.5.0': + '@vue/compiler-core@3.5.6': dependencies: '@babel/parser': 7.25.6 - '@vue/shared': 3.5.0 + '@vue/shared': 3.5.6 entities: 4.5.0 estree-walker: 2.0.2 - source-map-js: 1.2.0 + source-map-js: 1.2.1 - '@vue/compiler-dom@3.5.0': + '@vue/compiler-dom@3.5.6': dependencies: - '@vue/compiler-core': 3.5.0 - '@vue/shared': 3.5.0 + '@vue/compiler-core': 3.5.6 + '@vue/shared': 3.5.6 - '@vue/compiler-sfc@3.5.0': + '@vue/compiler-sfc@3.5.6': dependencies: '@babel/parser': 7.25.6 - '@vue/compiler-core': 3.5.0 - '@vue/compiler-dom': 3.5.0 - '@vue/compiler-ssr': 3.5.0 - '@vue/shared': 3.5.0 + '@vue/compiler-core': 3.5.6 + '@vue/compiler-dom': 3.5.6 + '@vue/compiler-ssr': 3.5.6 + '@vue/shared': 3.5.6 estree-walker: 2.0.2 magic-string: 0.30.11 - postcss: 8.4.44 - source-map-js: 1.2.0 + postcss: 8.4.47 + source-map-js: 1.2.1 - '@vue/compiler-ssr@3.5.0': + '@vue/compiler-ssr@3.5.6': dependencies: - '@vue/compiler-dom': 3.5.0 - '@vue/shared': 3.5.0 + '@vue/compiler-dom': 3.5.6 + '@vue/shared': 3.5.6 '@vue/compiler-vue2@2.7.16': dependencies: de-indent: 1.0.2 he: 1.2.0 - '@vue/devtools-api@7.3.7': + '@vue/devtools-api@7.4.5': dependencies: - '@vue/devtools-kit': 7.3.7 + '@vue/devtools-kit': 7.4.5 - '@vue/devtools-kit@7.3.7': + '@vue/devtools-kit@7.4.5': dependencies: - '@vue/devtools-shared': 7.3.7 + '@vue/devtools-shared': 7.4.5 birpc: 0.2.17 hookable: 5.5.3 mitt: 3.0.1 @@ -4975,78 +5068,76 @@ snapshots: speakingurl: 14.0.1 superjson: 2.2.1 - '@vue/devtools-shared@7.3.7': + '@vue/devtools-shared@7.4.5': dependencies: rfdc: 1.4.1 - '@vue/language-core@2.1.4(typescript@5.5.4)': + '@vue/language-core@2.1.6(typescript@5.6.2)': dependencies: - '@volar/language-core': 2.4.1 - '@vue/compiler-dom': 3.5.0 + '@volar/language-core': 2.4.5 + '@vue/compiler-dom': 3.5.6 '@vue/compiler-vue2': 2.7.16 - '@vue/shared': 3.5.0 + '@vue/shared': 3.5.6 computeds: 0.0.1 minimatch: 9.0.5 muggle-string: 0.4.1 path-browserify: 1.0.1 optionalDependencies: - typescript: 5.5.4 + typescript: 5.6.2 - '@vue/reactivity@3.5.0': + '@vue/reactivity@3.5.6': dependencies: - '@vue/shared': 3.5.0 + '@vue/shared': 3.5.6 - '@vue/runtime-core@3.5.0': + '@vue/runtime-core@3.5.6': dependencies: - '@vue/reactivity': 3.5.0 - '@vue/shared': 3.5.0 + '@vue/reactivity': 3.5.6 + '@vue/shared': 3.5.6 - '@vue/runtime-dom@3.5.0': + '@vue/runtime-dom@3.5.6': dependencies: - '@vue/reactivity': 3.5.0 - '@vue/runtime-core': 3.5.0 - '@vue/shared': 3.5.0 + '@vue/reactivity': 3.5.6 + '@vue/runtime-core': 3.5.6 + '@vue/shared': 3.5.6 csstype: 3.1.3 - '@vue/server-renderer@3.5.0(vue@3.5.0(typescript@5.5.4))': + '@vue/server-renderer@3.5.6(vue@3.5.6(typescript@5.6.2))': dependencies: - '@vue/compiler-ssr': 3.5.0 - '@vue/shared': 3.5.0 - vue: 3.5.0(typescript@5.5.4) - - '@vue/shared@3.4.37': {} + '@vue/compiler-ssr': 3.5.6 + '@vue/shared': 3.5.6 + vue: 3.5.6(typescript@5.6.2) - '@vue/shared@3.5.0': {} + '@vue/shared@3.5.6': {} '@vue/tsconfig@0.5.1': {} - '@vueuse/core@10.11.1(vue@3.5.0(typescript@5.5.4))': + '@vueuse/core@10.11.1(vue@3.5.6(typescript@5.6.2))': dependencies: '@types/web-bluetooth': 0.0.20 '@vueuse/metadata': 10.11.1 - '@vueuse/shared': 10.11.1(vue@3.5.0(typescript@5.5.4)) - vue-demi: 0.14.10(vue@3.5.0(typescript@5.5.4)) + '@vueuse/shared': 10.11.1(vue@3.5.6(typescript@5.6.2)) + vue-demi: 0.14.10(vue@3.5.6(typescript@5.6.2)) transitivePeerDependencies: - '@vue/composition-api' - vue - '@vueuse/integrations@10.11.1(axios@1.7.7)(focus-trap@7.5.4)(vue@3.5.0(typescript@5.5.4))': + '@vueuse/integrations@10.11.1(axios@1.7.7)(focus-trap@7.6.0)(vue@3.5.6(typescript@5.6.2))': dependencies: - '@vueuse/core': 10.11.1(vue@3.5.0(typescript@5.5.4)) - '@vueuse/shared': 10.11.1(vue@3.5.0(typescript@5.5.4)) - vue-demi: 0.14.10(vue@3.5.0(typescript@5.5.4)) + '@vueuse/core': 10.11.1(vue@3.5.6(typescript@5.6.2)) + '@vueuse/shared': 10.11.1(vue@3.5.6(typescript@5.6.2)) + vue-demi: 0.14.10(vue@3.5.6(typescript@5.6.2)) optionalDependencies: axios: 1.7.7 - focus-trap: 7.5.4 + focus-trap: 7.6.0 transitivePeerDependencies: - '@vue/composition-api' - vue '@vueuse/metadata@10.11.1': {} - '@vueuse/shared@10.11.1(vue@3.5.0(typescript@5.5.4))': + '@vueuse/shared@10.11.1(vue@3.5.6(typescript@5.6.2))': dependencies: - vue-demi: 0.14.10(vue@3.5.0(typescript@5.5.4)) + vue-demi: 0.14.10(vue@3.5.6(typescript@5.6.2)) transitivePeerDependencies: - '@vue/composition-api' - vue @@ -5057,10 +5148,10 @@ snapshots: acorn-globals@7.0.1: dependencies: acorn: 8.12.1 - acorn-walk: 8.3.3 + acorn-walk: 8.3.4 optional: true - acorn-walk@8.3.3: + acorn-walk@8.3.4: dependencies: acorn: 8.12.1 optional: true @@ -5069,14 +5160,14 @@ snapshots: agent-base@6.0.2: dependencies: - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true agent-base@7.1.1(supports-color@9.4.0): dependencies: - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) transitivePeerDependencies: - supports-color @@ -5111,7 +5202,7 @@ snapshots: ansi-regex@5.0.1: {} - ansi-regex@6.0.1: {} + ansi-regex@6.1.0: {} ansi-styles@3.2.1: dependencies: @@ -5138,6 +5229,8 @@ snapshots: dependencies: dequal: 2.0.3 + aria-query@5.3.1: {} + array-union@2.1.0: {} arrify@1.0.1: {} @@ -5150,7 +5243,7 @@ snapshots: axios@1.7.7: dependencies: - follow-redirects: 1.15.6 + follow-redirects: 1.15.9 form-data: 4.0.0 proxy-from-env: 1.1.0 transitivePeerDependencies: @@ -5183,7 +5276,7 @@ snapshots: browserslist@4.23.3: dependencies: - caniuse-lite: 1.0.30001655 + caniuse-lite: 1.0.30001662 electron-to-chromium: 1.5.13 node-releases: 2.0.18 update-browserslist-db: 1.1.0(browserslist@4.23.3) @@ -5217,9 +5310,9 @@ snapshots: camelcase@6.3.0: {} - caniuse-lite@1.0.30001646: {} + caniuse-lite@1.0.30001662: {} - caniuse-lite@1.0.30001655: {} + ccount@2.0.1: {} chai@5.1.1: dependencies: @@ -5242,6 +5335,10 @@ snapshots: change-case@5.4.4: {} + character-entities-html4@2.1.0: {} + + character-entities-legacy@3.0.0: {} + chardet@0.7.0: {} check-error@2.1.1: {} @@ -5279,7 +5376,7 @@ snapshots: code-red@1.0.4: dependencies: '@jridgewell/sourcemap-codec': 1.5.0 - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 acorn: 8.12.1 estree-walker: 3.0.3 periscopic: 3.1.0 @@ -5302,6 +5399,8 @@ snapshots: dependencies: delayed-stream: 1.0.0 + comma-separated-tokens@2.0.3: {} + commander@11.1.0: {} component-emitter@1.3.1: {} @@ -5337,7 +5436,7 @@ snapshots: css-tree@2.3.1: dependencies: mdn-data: 2.0.30 - source-map-js: 1.2.0 + source-map-js: 1.2.1 cssom@0.3.8: optional: true @@ -5363,15 +5462,9 @@ snapshots: de-indent@1.0.2: {} - debug@4.3.5(supports-color@9.4.0): - dependencies: - ms: 2.1.2 - optionalDependencies: - supports-color: 9.4.0 - - debug@4.3.6(supports-color@9.4.0): + debug@4.3.7(supports-color@9.4.0): dependencies: - ms: 2.1.2 + ms: 2.1.3 optionalDependencies: supports-color: 9.4.0 @@ -5423,6 +5516,10 @@ snapshots: devalue@5.0.0: {} + devlop@1.1.0: + dependencies: + dequal: 2.0.3 + dezalgo@1.0.4: dependencies: asap: 2.0.6 @@ -5569,7 +5666,7 @@ snapshots: estree-walker@3.0.3: dependencies: - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 esutils@2.0.3: optional: true @@ -5610,6 +5707,10 @@ snapshots: dependencies: reusify: 1.0.4 + fdir@6.3.0(picomatch@4.0.2): + optionalDependencies: + picomatch: 4.0.2 + feature-fetch@0.0.15: dependencies: '@blgc/types': 0.0.6 @@ -5630,16 +5731,11 @@ snapshots: locate-path: 6.0.0 path-exists: 4.0.0 - find-yarn-workspace-root2@1.2.16: - dependencies: - micromatch: 4.0.8 - pkg-dir: 4.2.0 - - focus-trap@7.5.4: + focus-trap@7.6.0: dependencies: tabbable: 6.2.0 - follow-redirects@1.15.6: {} + follow-redirects@1.15.9: {} form-data@4.0.0: dependencies: @@ -5731,15 +5827,6 @@ snapshots: merge2: 1.4.1 slash: 4.0.0 - globby@14.0.2: - dependencies: - '@sindresorhus/merge-streams': 2.3.0 - fast-glob: 3.3.2 - ignore: 5.3.2 - path-type: 5.0.0 - slash: 5.1.0 - unicorn-magic: 0.1.0 - globrex@0.1.2: {} gopd@1.0.1: @@ -5778,6 +5865,24 @@ snapshots: dependencies: function-bind: 1.1.2 + hast-util-to-html@9.0.3: + dependencies: + '@types/hast': 3.0.4 + '@types/unist': 3.0.3 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-whitespace: 3.0.0 + html-void-elements: 3.0.0 + mdast-util-to-hast: 13.2.0 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + stringify-entities: 4.0.4 + zwitch: 2.0.4 + + hast-util-whitespace@3.0.0: + dependencies: + '@types/hast': 3.0.4 + he@1.2.0: {} headers-polyfill@4.0.3: {} @@ -5795,11 +5900,13 @@ snapshots: whatwg-encoding: 2.0.0 optional: true + html-void-elements@3.0.0: {} + http-proxy-agent@5.0.0: dependencies: '@tootallnate/once': 2.0.0 agent-base: 6.0.2 - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true @@ -5807,15 +5914,15 @@ snapshots: https-proxy-agent@5.0.1: dependencies: agent-base: 6.0.2 - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true - https-proxy-agent@7.0.4(supports-color@9.4.0): + https-proxy-agent@7.0.5(supports-color@9.4.0): dependencies: agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.5(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) transitivePeerDependencies: - supports-color @@ -5882,7 +5989,7 @@ snapshots: is-reference@3.0.2: dependencies: - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 is-stream@3.0.0: {} @@ -5975,13 +6082,6 @@ snapshots: lines-and-columns@1.2.4: {} - load-yaml-file@0.2.0: - dependencies: - graceful-fs: 4.2.11 - js-yaml: 3.14.1 - pify: 4.0.1 - strip-bom: 3.0.0 - locate-character@3.0.0: {} locate-path@5.0.0: @@ -6029,6 +6129,18 @@ snapshots: mark.js@8.11.1: {} + mdast-util-to-hast@13.2.0: + dependencies: + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + '@ungap/structured-clone': 1.2.0 + devlop: 1.1.0 + micromark-util-sanitize-uri: 2.0.0 + trim-lines: 3.0.1 + unist-util-position: 5.0.0 + unist-util-visit: 5.0.0 + vfile: 6.0.3 + mdn-data@2.0.30: {} meow@10.1.5: @@ -6052,6 +6164,23 @@ snapshots: methods@1.1.2: {} + micromark-util-character@2.1.0: + dependencies: + micromark-util-symbol: 2.0.0 + micromark-util-types: 2.0.0 + + micromark-util-encode@2.0.0: {} + + micromark-util-sanitize-uri@2.0.0: + dependencies: + micromark-util-character: 2.1.0 + micromark-util-encode: 2.0.0 + micromark-util-symbol: 2.0.0 + + micromark-util-symbol@2.0.0: {} + + micromark-util-types@2.0.0: {} + micromatch@4.0.8: dependencies: braces: 3.0.3 @@ -6101,9 +6230,9 @@ snapshots: mrmime@2.0.0: {} - ms@2.1.2: {} + ms@2.1.3: {} - msw@2.4.1(graphql@16.8.2)(typescript@5.5.4): + msw@2.4.1(graphql@16.8.2)(typescript@5.6.2): dependencies: '@bundled-es-modules/cookie': 2.0.0 '@bundled-es-modules/statuses': 1.0.1 @@ -6123,7 +6252,7 @@ snapshots: yargs: 17.7.2 optionalDependencies: graphql: 16.8.2 - typescript: 5.5.4 + typescript: 5.6.2 muggle-string@0.4.1: {} @@ -6135,16 +6264,16 @@ snapshots: nanospinner@1.1.0: dependencies: - picocolors: 1.0.1 + picocolors: 1.1.0 neo-async@2.6.2: {} - next@14.2.3(@playwright/test@1.46.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1): + next@14.2.3(@playwright/test@1.47.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1): dependencies: '@next/env': 14.2.3 '@swc/helpers': 0.5.5 busboy: 1.6.0 - caniuse-lite: 1.0.30001646 + caniuse-lite: 1.0.30001662 graceful-fs: 4.2.11 postcss: 8.4.31 react: 18.3.1 @@ -6160,7 +6289,7 @@ snapshots: '@next/swc-win32-arm64-msvc': 14.2.3 '@next/swc-win32-ia32-msvc': 14.2.3 '@next/swc-win32-x64-msvc': 14.2.3 - '@playwright/test': 1.46.1 + '@playwright/test': 1.47.1 transitivePeerDependencies: - '@babel/core' - babel-plugin-macros @@ -6197,6 +6326,10 @@ snapshots: dependencies: mimic-fn: 4.0.0 + oniguruma-to-js@0.4.3: + dependencies: + regex: 4.3.2 + openapi-typescript-codegen@0.25.0: dependencies: camelcase: 6.3.0 @@ -6241,6 +6374,8 @@ snapshots: p-try@2.2.0: {} + package-manager-detector@0.2.0: {} + parse-json@5.2.0: dependencies: '@babel/code-frame': 7.24.7 @@ -6252,7 +6387,7 @@ snapshots: dependencies: '@babel/code-frame': 7.24.7 index-to-position: 0.1.2 - type-fest: 4.20.1 + type-fest: 4.26.1 parse5@7.1.2: dependencies: @@ -6273,8 +6408,6 @@ snapshots: path-type@4.0.0: {} - path-type@5.0.0: {} - pathe@1.1.2: {} pathval@2.0.0: {} @@ -6283,27 +6416,23 @@ snapshots: periscopic@3.1.0: dependencies: - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 estree-walker: 3.0.3 is-reference: 3.0.2 - picocolors@1.0.1: {} - picocolors@1.1.0: {} picomatch@2.3.1: {} - pify@4.0.1: {} + picomatch@4.0.2: {} - pkg-dir@4.2.0: - dependencies: - find-up: 4.1.0 + pify@4.0.1: {} - playwright-core@1.46.1: {} + playwright-core@1.47.1: {} - playwright@1.46.1: + playwright@1.47.1: dependencies: - playwright-core: 1.46.1 + playwright-core: 1.47.1 optionalDependencies: fsevents: 2.3.2 @@ -6312,23 +6441,16 @@ snapshots: postcss@8.4.31: dependencies: nanoid: 3.3.7 - picocolors: 1.0.1 - source-map-js: 1.2.0 + picocolors: 1.1.0 + source-map-js: 1.2.1 - postcss@8.4.44: + postcss@8.4.47: dependencies: nanoid: 3.3.7 - picocolors: 1.0.1 - source-map-js: 1.2.0 - - preact@10.23.1: {} + picocolors: 1.1.0 + source-map-js: 1.2.1 - preferred-pm@3.1.4: - dependencies: - find-up: 5.0.0 - find-yarn-workspace-root2: 1.2.16 - path-exists: 4.0.0 - which-pm: 2.2.0 + preact@10.24.0: {} prettier@2.8.8: {} @@ -6340,6 +6462,8 @@ snapshots: ansi-styles: 5.2.0 react-is: 17.0.2 + property-information@6.5.0: {} + proxy-from-env@1.1.0: {} pseudomap@1.0.2: {} @@ -6408,6 +6532,8 @@ snapshots: regenerator-runtime@0.14.1: {} + regex@4.3.2: {} + require-directory@2.1.1: {} require-from-string@2.0.2: {} @@ -6428,26 +6554,26 @@ snapshots: dependencies: glob: 7.2.3 - rollup@4.21.2: + rollup@4.22.2: dependencies: '@types/estree': 1.0.5 optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.21.2 - '@rollup/rollup-android-arm64': 4.21.2 - '@rollup/rollup-darwin-arm64': 4.21.2 - '@rollup/rollup-darwin-x64': 4.21.2 - '@rollup/rollup-linux-arm-gnueabihf': 4.21.2 - '@rollup/rollup-linux-arm-musleabihf': 4.21.2 - '@rollup/rollup-linux-arm64-gnu': 4.21.2 - '@rollup/rollup-linux-arm64-musl': 4.21.2 - '@rollup/rollup-linux-powerpc64le-gnu': 4.21.2 - '@rollup/rollup-linux-riscv64-gnu': 4.21.2 - '@rollup/rollup-linux-s390x-gnu': 4.21.2 - '@rollup/rollup-linux-x64-gnu': 4.21.2 - '@rollup/rollup-linux-x64-musl': 4.21.2 - '@rollup/rollup-win32-arm64-msvc': 4.21.2 - '@rollup/rollup-win32-ia32-msvc': 4.21.2 - '@rollup/rollup-win32-x64-msvc': 4.21.2 + '@rollup/rollup-android-arm-eabi': 4.22.2 + '@rollup/rollup-android-arm64': 4.22.2 + '@rollup/rollup-darwin-arm64': 4.22.2 + '@rollup/rollup-darwin-x64': 4.22.2 + '@rollup/rollup-linux-arm-gnueabihf': 4.22.2 + '@rollup/rollup-linux-arm-musleabihf': 4.22.2 + '@rollup/rollup-linux-arm64-gnu': 4.22.2 + '@rollup/rollup-linux-arm64-musl': 4.22.2 + '@rollup/rollup-linux-powerpc64le-gnu': 4.22.2 + '@rollup/rollup-linux-riscv64-gnu': 4.22.2 + '@rollup/rollup-linux-s390x-gnu': 4.22.2 + '@rollup/rollup-linux-x64-gnu': 4.22.2 + '@rollup/rollup-linux-x64-musl': 4.22.2 + '@rollup/rollup-win32-arm64-msvc': 4.22.2 + '@rollup/rollup-win32-ia32-msvc': 4.22.2 + '@rollup/rollup-win32-x64-msvc': 4.22.2 fsevents: 2.3.3 run-parallel@1.2.0: @@ -6505,9 +6631,13 @@ snapshots: shebang-regex@3.0.0: {} - shiki@1.12.1: + shiki@1.18.0: dependencies: - '@shikijs/core': 1.12.1 + '@shikijs/core': 1.18.0 + '@shikijs/engine-javascript': 1.18.0 + '@shikijs/engine-oniguruma': 1.18.0 + '@shikijs/types': 1.18.0 + '@shikijs/vscode-textmate': 9.2.2 '@types/hast': 3.0.4 side-channel@1.0.6: @@ -6525,26 +6655,24 @@ snapshots: sirv@2.0.4: dependencies: - '@polka/url': 1.0.0-next.25 + '@polka/url': 1.0.0-next.28 mrmime: 2.0.0 totalist: 3.0.1 - size-limit@11.1.4: + size-limit@11.1.5: dependencies: bytes-iec: 3.1.1 chokidar: 3.6.0 - globby: 14.0.2 jiti: 1.21.6 lilconfig: 3.1.2 nanospinner: 1.1.0 - picocolors: 1.0.1 + picocolors: 1.1.0 + tinyglobby: 0.2.6 slash@3.0.0: {} slash@4.0.0: {} - slash@5.1.0: {} - sorcery@0.11.1: dependencies: '@jridgewell/sourcemap-codec': 1.5.0 @@ -6552,10 +6680,12 @@ snapshots: minimist: 1.2.8 sander: 0.5.1 - source-map-js@1.2.0: {} + source-map-js@1.2.1: {} source-map@0.6.1: {} + space-separated-tokens@2.0.2: {} + spawndamnit@2.0.0: dependencies: cross-spawn: 5.1.0 @@ -6595,13 +6725,18 @@ snapshots: is-fullwidth-code-point: 3.0.0 strip-ansi: 6.0.1 + stringify-entities@4.0.4: + dependencies: + character-entities-html4: 2.1.0 + character-entities-legacy: 3.0.0 + strip-ansi@6.0.1: dependencies: ansi-regex: 5.0.1 strip-ansi@7.1.0: dependencies: - ansi-regex: 6.0.1 + ansi-regex: 6.1.0 strip-bom@3.0.0: {} @@ -6624,7 +6759,7 @@ snapshots: dependencies: component-emitter: 1.3.1 cookiejar: 2.1.4 - debug: 4.3.6(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) fast-safe-stringify: 2.1.1 form-data: 4.0.0 formidable: 3.5.1 @@ -6648,15 +6783,15 @@ snapshots: supports-color@9.4.0: {} - svelte-check@3.8.6(@babel/core@7.25.2)(postcss@8.4.44)(svelte@4.2.19): + svelte-check@3.8.6(@babel/core@7.25.2)(postcss@8.4.47)(svelte@4.2.19): dependencies: '@jridgewell/trace-mapping': 0.3.25 chokidar: 3.6.0 picocolors: 1.1.0 sade: 1.8.1 svelte: 4.2.19 - svelte-preprocess: 5.1.4(@babel/core@7.25.2)(postcss@8.4.44)(svelte@4.2.19)(typescript@5.5.4) - typescript: 5.5.4 + svelte-preprocess: 5.1.4(@babel/core@7.25.2)(postcss@8.4.47)(svelte@4.2.19)(typescript@5.6.2) + typescript: 5.6.2 transitivePeerDependencies: - '@babel/core' - coffeescript @@ -6672,7 +6807,7 @@ snapshots: dependencies: svelte: 4.2.19 - svelte-preprocess@5.1.4(@babel/core@7.25.2)(postcss@8.4.44)(svelte@4.2.19)(typescript@5.5.4): + svelte-preprocess@5.1.4(@babel/core@7.25.2)(postcss@8.4.47)(svelte@4.2.19)(typescript@5.6.2): dependencies: '@types/pug': 2.0.10 detect-indent: 6.1.0 @@ -6682,17 +6817,17 @@ snapshots: svelte: 4.2.19 optionalDependencies: '@babel/core': 7.25.2 - postcss: 8.4.44 - typescript: 5.5.4 + postcss: 8.4.47 + typescript: 5.6.2 svelte@4.2.19: dependencies: '@ampproject/remapping': 2.3.0 '@jridgewell/sourcemap-codec': 1.5.0 '@jridgewell/trace-mapping': 0.3.25 - '@types/estree': 1.0.5 + '@types/estree': 1.0.6 acorn: 8.12.1 - aria-query: 5.3.0 + aria-query: 5.3.1 axobject-query: 4.1.0 code-red: 1.0.4 css-tree: 2.3.1 @@ -6716,11 +6851,18 @@ snapshots: tinybench@2.9.0: {} + tinyexec@0.3.0: {} + + tinyglobby@0.2.6: + dependencies: + fdir: 6.3.0(picomatch@4.0.2) + picomatch: 4.0.2 + tinypool@1.0.1: {} tinyrainbow@1.2.0: {} - tinyspy@3.0.0: {} + tinyspy@3.0.2: {} tmp@0.0.33: dependencies: @@ -6748,6 +6890,8 @@ snapshots: punycode: 2.3.1 optional: true + trim-lines@3.0.1: {} + trim-newlines@4.1.1: {} ts-results-es@4.2.0: {} @@ -6758,20 +6902,43 @@ snapshots: type-fest@1.4.0: {} - type-fest@4.20.1: {} - type-fest@4.26.0: {} + type-fest@4.26.1: {} + typescript@5.4.5: {} typescript@5.5.4: {} + typescript@5.6.2: {} + uglify-js@3.19.3: optional: true undici-types@6.19.8: {} - unicorn-magic@0.1.0: {} + unist-util-is@6.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-position@5.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-stringify-position@4.0.0: + dependencies: + '@types/unist': 3.0.3 + + unist-util-visit-parents@6.0.1: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.0 + + unist-util-visit@5.0.0: + dependencies: + '@types/unist': 3.0.3 + unist-util-is: 6.0.0 + unist-util-visit-parents: 6.0.1 universalify@0.1.2: {} @@ -6785,9 +6952,7 @@ snapshots: escalade: 3.2.0 picocolors: 1.1.0 - uri-js@4.4.1: - dependencies: - punycode: 2.3.1 + uri-js-replace@1.0.1: {} url-parse@1.5.10: dependencies: @@ -6799,13 +6964,22 @@ snapshots: spdx-correct: 3.2.0 spdx-expression-parse: 3.0.1 - vite-node@2.0.5(@types/node@22.5.2)(supports-color@9.4.0): + vfile-message@4.0.2: + dependencies: + '@types/unist': 3.0.3 + unist-util-stringify-position: 4.0.0 + + vfile@6.0.3: + dependencies: + '@types/unist': 3.0.3 + vfile-message: 4.0.2 + + vite-node@2.1.1(@types/node@22.5.5)(supports-color@9.4.0): dependencies: cac: 6.7.14 - debug: 4.3.5(supports-color@9.4.0) + debug: 4.3.7(supports-color@9.4.0) pathe: 1.1.2 - tinyrainbow: 1.2.0 - vite: 5.4.3(@types/node@22.5.2) + vite: 5.4.6(@types/node@22.5.5) transitivePeerDependencies: - '@types/node' - less @@ -6817,48 +6991,39 @@ snapshots: - supports-color - terser - vite@5.4.2(@types/node@22.5.2): + vite@5.4.6(@types/node@22.5.5): dependencies: esbuild: 0.21.5 - postcss: 8.4.44 - rollup: 4.21.2 + postcss: 8.4.47 + rollup: 4.22.2 optionalDependencies: - '@types/node': 22.5.2 + '@types/node': 22.5.5 fsevents: 2.3.3 - vite@5.4.3(@types/node@22.5.2): - dependencies: - esbuild: 0.21.5 - postcss: 8.4.44 - rollup: 4.21.2 + vitefu@0.2.5(vite@5.4.6(@types/node@22.5.5)): optionalDependencies: - '@types/node': 22.5.2 - fsevents: 2.3.3 - - vitefu@0.2.5(vite@5.4.3(@types/node@22.5.2)): - optionalDependencies: - vite: 5.4.3(@types/node@22.5.2) + vite: 5.4.6(@types/node@22.5.5) - vitepress@1.3.2(@algolia/client-search@4.24.0)(@types/node@22.5.2)(@types/react@18.3.3)(axios@1.7.7)(postcss@8.4.44)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.5.4): + vitepress@1.3.2(@algolia/client-search@4.24.0)(@types/node@22.5.5)(@types/react@18.3.8)(axios@1.7.7)(postcss@8.4.47)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.6.2): dependencies: '@docsearch/css': 3.6.1 - '@docsearch/js': 3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.3)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) - '@shikijs/core': 1.12.1 - '@shikijs/transformers': 1.12.1 + '@docsearch/js': 3.6.1(@algolia/client-search@4.24.0)(@types/react@18.3.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) + '@shikijs/core': 1.18.0 + '@shikijs/transformers': 1.18.0 '@types/markdown-it': 14.1.2 - '@vitejs/plugin-vue': 5.1.3(vite@5.4.3(@types/node@22.5.2))(vue@3.5.0(typescript@5.5.4)) - '@vue/devtools-api': 7.3.7 - '@vue/shared': 3.4.37 - '@vueuse/core': 10.11.1(vue@3.5.0(typescript@5.5.4)) - '@vueuse/integrations': 10.11.1(axios@1.7.7)(focus-trap@7.5.4)(vue@3.5.0(typescript@5.5.4)) - focus-trap: 7.5.4 + '@vitejs/plugin-vue': 5.1.4(vite@5.4.6(@types/node@22.5.5))(vue@3.5.6(typescript@5.6.2)) + '@vue/devtools-api': 7.4.5 + '@vue/shared': 3.5.6 + '@vueuse/core': 10.11.1(vue@3.5.6(typescript@5.6.2)) + '@vueuse/integrations': 10.11.1(axios@1.7.7)(focus-trap@7.6.0)(vue@3.5.6(typescript@5.6.2)) + focus-trap: 7.6.0 mark.js: 8.11.1 minisearch: 7.1.0 - shiki: 1.12.1 - vite: 5.4.3(@types/node@22.5.2) - vue: 3.5.0(typescript@5.5.4) + shiki: 1.18.0 + vite: 5.4.6(@types/node@22.5.5) + vue: 3.5.6(typescript@5.6.2) optionalDependencies: - postcss: 8.4.44 + postcss: 8.4.47 transitivePeerDependencies: - '@algolia/client-search' - '@types/node' @@ -6887,33 +7052,34 @@ snapshots: - typescript - universal-cookie - vitest@2.0.5(@types/node@22.5.2)(jsdom@20.0.3): + vitest@2.1.1(@types/node@22.5.5)(jsdom@20.0.3)(msw@2.4.1(graphql@16.8.2)(typescript@5.6.2)): dependencies: - '@ampproject/remapping': 2.3.0 - '@vitest/expect': 2.0.5 - '@vitest/pretty-format': 2.0.5 - '@vitest/runner': 2.0.5 - '@vitest/snapshot': 2.0.5 - '@vitest/spy': 2.0.5 - '@vitest/utils': 2.0.5 + '@vitest/expect': 2.1.1 + '@vitest/mocker': 2.1.1(@vitest/spy@2.1.1)(msw@2.4.1(graphql@16.8.2)(typescript@5.6.2))(vite@5.4.6(@types/node@22.5.5)) + '@vitest/pretty-format': 2.1.1 + '@vitest/runner': 2.1.1 + '@vitest/snapshot': 2.1.1 + '@vitest/spy': 2.1.1 + '@vitest/utils': 2.1.1 chai: 5.1.1 - debug: 4.3.6(supports-color@9.4.0) - execa: 8.0.1 + debug: 4.3.7(supports-color@9.4.0) magic-string: 0.30.11 pathe: 1.1.2 std-env: 3.7.0 tinybench: 2.9.0 + tinyexec: 0.3.0 tinypool: 1.0.1 tinyrainbow: 1.2.0 - vite: 5.4.3(@types/node@22.5.2) - vite-node: 2.0.5(@types/node@22.5.2)(supports-color@9.4.0) + vite: 5.4.6(@types/node@22.5.5) + vite-node: 2.1.1(@types/node@22.5.5)(supports-color@9.4.0) why-is-node-running: 2.3.0 optionalDependencies: - '@types/node': 22.5.2 + '@types/node': 22.5.5 jsdom: 20.0.3 transitivePeerDependencies: - less - lightningcss + - msw - sass - sass-embedded - stylus @@ -6923,26 +7089,26 @@ snapshots: vscode-uri@3.0.8: {} - vue-demi@0.14.10(vue@3.5.0(typescript@5.5.4)): + vue-demi@0.14.10(vue@3.5.6(typescript@5.6.2)): dependencies: - vue: 3.5.0(typescript@5.5.4) + vue: 3.5.6(typescript@5.6.2) - vue-tsc@2.1.4(typescript@5.5.4): + vue-tsc@2.1.6(typescript@5.6.2): dependencies: - '@volar/typescript': 2.4.1 - '@vue/language-core': 2.1.4(typescript@5.5.4) + '@volar/typescript': 2.4.5 + '@vue/language-core': 2.1.6(typescript@5.6.2) semver: 7.6.3 - typescript: 5.5.4 + typescript: 5.6.2 - vue@3.5.0(typescript@5.5.4): + vue@3.5.6(typescript@5.6.2): dependencies: - '@vue/compiler-dom': 3.5.0 - '@vue/compiler-sfc': 3.5.0 - '@vue/runtime-dom': 3.5.0 - '@vue/server-renderer': 3.5.0(vue@3.5.0(typescript@5.5.4)) - '@vue/shared': 3.5.0 + '@vue/compiler-dom': 3.5.6 + '@vue/compiler-sfc': 3.5.6 + '@vue/runtime-dom': 3.5.6 + '@vue/server-renderer': 3.5.6(vue@3.5.6(typescript@5.6.2)) + '@vue/shared': 3.5.6 optionalDependencies: - typescript: 5.5.4 + typescript: 5.6.2 w3c-xmlserializer@4.0.0: dependencies: @@ -6973,11 +7139,6 @@ snapshots: tr46: 0.0.3 webidl-conversions: 3.0.1 - which-pm@2.2.0: - dependencies: - load-yaml-file: 0.2.0 - path-exists: 4.0.0 - which@1.3.1: dependencies: isexe: 2.0.0 @@ -7043,3 +7204,5 @@ snapshots: yocto-queue@0.1.0: {} yoctocolors-cjs@2.1.2: {} + + zwitch@2.0.4: {}