From efea32521ffa1557547a0000051cc73157be5a61 Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Sat, 25 Jan 2025 14:39:26 -0700 Subject: [PATCH] Fix CI (#2120) * Fix CI * Update examples --- .changeset/gorgeous-moles-warn.md | 5 + .../test/examples/schemas/github.d.ts | 1396 +++++++++++++++-- .../test/examples/schemas/stripe.d.ts | 442 +++++- packages/openapi-react-query/src/index.ts | 10 +- 4 files changed, 1672 insertions(+), 181 deletions(-) create mode 100644 .changeset/gorgeous-moles-warn.md diff --git a/.changeset/gorgeous-moles-warn.md b/.changeset/gorgeous-moles-warn.md new file mode 100644 index 000000000..c260ec964 --- /dev/null +++ b/.changeset/gorgeous-moles-warn.md @@ -0,0 +1,5 @@ +--- +"openapi-react-query": patch +--- + +Fix minor type error with latest version of TanStack Query diff --git a/packages/openapi-fetch/test/examples/schemas/github.d.ts b/packages/openapi-fetch/test/examples/schemas/github.d.ts index 20a0d85ff..13489f8f8 100644 --- a/packages/openapi-fetch/test/examples/schemas/github.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/github.d.ts @@ -1763,6 +1763,164 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; + }; "/orgs/{org}/actions/oidc/customization/sub": { parameters: { query?: never; @@ -1998,6 +2156,28 @@ export interface paths { patch: operations["actions/update-self-hosted-runner-group-for-org"]; trace?: never; }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { parameters: { query?: never; @@ -5622,6 +5802,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; + }; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/metrics": { parameters: { query?: never; @@ -8205,19 +8469,19 @@ export interface paths { cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-id"]; put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-username"]; put?: never; @@ -18254,6 +18522,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + "security-advisory-epss": { + percentage?: number; + percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export interface components { readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - epss?: { - percentage?: number; - percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: { user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export interface components { errors?: string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** - * Format: int64 - * @example 1 - */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + enterprise: { + /** @description A short description of the enterprise. */ + description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - url: string; + html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - html_url: string; + website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - subscriptions_url: string; + name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - organizations_url: string; + slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - /** @example public */ - user_view_type?: string; - } | null; + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export interface components { payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - enterprise: { - /** @description A short description of the enterprise. */ - description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - updated_at: string | null; - /** Format: uri */ - avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export interface components { */ starring?: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + "nullable-simple-user": { + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export interface components { readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21344,6 +21616,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21381,6 +21654,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export interface components { */ active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + id: string; + /** + * @description The number of cores. + * @example 8 + */ + cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + enabled?: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + prefix?: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + public_ips?: components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + }; + "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export interface components { selected_repositories_url?: string; runners_url: string; hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export interface components { sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ group_id?: string | null; + /** @example Justice League */ + group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + network_settings_ids?: string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export interface components { is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ paused: boolean; @@ -28822,6 +29343,16 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -40840,11 +41374,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export interface components { dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "fixed"; + state: "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: unknown; dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "fixed"; + state: "open" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -87047,12 +87594,20 @@ export interface components { "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export interface components { "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export interface components { "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + "network-settings-id": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -88742,11 +89303,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -90593,6 +91162,306 @@ export interface operations { }; }; }; + "actions/list-hosted-runners-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image: { + /** @description The unique identifier of the runner image. */ + id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + image_version?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; "oidc/get-oidc-custom-sub-template-for-org": { parameters: { query?: never; @@ -90967,6 +91836,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; }; }; }; @@ -91064,6 +91935,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string | null; }; }; }; @@ -91079,6 +91952,40 @@ export interface operations { }; }; }; + "actions/list-github-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { @@ -93660,11 +94567,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -97833,6 +98748,189 @@ export interface operations { }; }; }; + "hosted-compute/list-network-configurations-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; "copilot/copilot-metrics-for-team": { parameters: { query?: { @@ -106913,11 +108011,19 @@ export interface operations { package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -111072,7 +112178,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ sub_issue_id: number; }; }; @@ -111145,7 +112251,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -115892,7 +116998,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; diff --git a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts index a1d3a6337..8ec3e1954 100644 --- a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts @@ -8380,6 +8380,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/treasury/financial_accounts/{financial_account}/close": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Close a FinancialAccount + * @description

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

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