diff --git a/.gitattributes b/.gitattributes
index a60f28aed..d2957a6aa 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -3,5 +3,5 @@
packages/openapi-code-generater/src/core/schemas/openapi-3.0-specification-validator.js binary
packages/openapi-code-generater/src/core/schemas/openapi-3.1-specification-validator.js binary
integration-tests/*/src/generated/** linguist-generated=true
-integration-tests-definitions/** linguist-vendored
+integration-tests-definitions/** linguist-vendored=true
yarn.lock linguist-generated=true
diff --git a/integration-tests-definitions/api.github.com.yaml b/integration-tests-definitions/api.github.com.yaml
index 59ff4d683..ac3be6f60 100644
--- a/integration-tests-definitions/api.github.com.yaml
+++ b/integration-tests-definitions/api.github.com.yaml
@@ -1495,7 +1495,7 @@ paths:
for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,
and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.
- The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.
@@ -1668,12 +1668,91 @@ paths:
enabledForGitHubApps: false
category: secret-scanning
subcategory: secret-scanning
+ "/enterprises/{enterprise}/team/{team_slug}/copilot/usage":
+ get:
+ summary: Get a summary of Copilot usage for an enterprise team
+ description: |-
+ > [!NOTE]
+ > This endpoint is in beta and is subject to change.
+
+ You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ See the response schema tab for detailed metrics definitions.
+
+ The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
+ and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ they must have telemetry enabled in their IDE.
+
+ > [!NOTE]
+ > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.
+
+ Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.
+
+ OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
+ tags:
+ - copilot
+ operationId: copilot/usage-metrics-for-enterprise-team
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team
+ parameters:
+ - "$ref": "#/components/parameters/enterprise"
+ - "$ref": "#/components/parameters/team-slug"
+ - name: since
+ description: Show usage metrics since this date. This is a timestamp in [ISO
+ 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
+ Maximum value is 28 days ago.
+ in: query
+ required: false
+ schema:
+ type: string
+ - name: until
+ description: Show usage metrics until this date. This is a timestamp in [ISO
+ 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`)
+ and should not preceed the `since` date if it is passed.
+ in: query
+ required: false
+ schema:
+ type: string
+ - "$ref": "#/components/parameters/page"
+ - name: per_page
+ description: The number of days of metrics to display per page (max 28). For
+ more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ in: query
+ schema:
+ type: integer
+ default: 28
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/copilot-usage-metrics"
+ examples:
+ default:
+ "$ref": "#/components/examples/copilot-usage-metrics-org"
+ '500':
+ "$ref": "#/components/responses/internal_error"
+ '401':
+ "$ref": "#/components/responses/requires_authentication"
+ '403':
+ "$ref": "#/components/responses/forbidden"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: copilot
+ subcategory: copilot-usage
"/events":
get:
summary: List public events
- description: We delay the public events feed by five minutes, which means the
- most recent event returned by the public events API actually occurred at least
- five minutes ago.
+ description: |-
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events
@@ -3352,7 +3431,9 @@ paths:
"/networks/{owner}/{repo}/events":
get:
summary: List public events for a network of repositories
- description: ''
+ description: |-
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events-for-repo-network
@@ -6205,6 +6286,23 @@ paths:
- disabled
- not_set
default: enabled
+ dependency_graph_autosubmit_action:
+ type: string
+ description: The enablement status of Automatic dependency submission
+ enum:
+ - enabled
+ - disabled
+ - not_set
+ default: disabled
+ dependency_graph_autosubmit_action_options:
+ type: object
+ description: Feature options for Automatic dependency submission
+ properties:
+ labeled_runners:
+ type: boolean
+ description: Whether to use runners labeled with 'dependency-submission'
+ or standard GitHub runners.
+ default: false
dependabot_alerts:
type: string
description: The enablement status of Dependabot alerts
@@ -6474,6 +6572,21 @@ paths:
- enabled
- disabled
- not_set
+ dependency_graph_autosubmit_action:
+ type: string
+ description: The enablement status of Automatic dependency submission
+ enum:
+ - enabled
+ - disabled
+ - not_set
+ dependency_graph_autosubmit_action_options:
+ type: object
+ description: Feature options for Automatic dependency submission
+ properties:
+ labeled_runners:
+ type: boolean
+ description: Whether to use runners labeled with 'dependency-submission'
+ or standard GitHub runners.
dependabot_alerts:
type: string
description: The enablement status of Dependabot alerts
@@ -7872,7 +7985,7 @@ paths:
across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
See the response schema tab for detailed metrics definitions.
- The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,
+ The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.
@@ -8403,7 +8516,9 @@ paths:
"/orgs/{org}/events":
get:
summary: List public organization events
- description: ''
+ description: |-
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-org-events
@@ -11623,10 +11738,10 @@ paths:
schema:
type: array
items:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
examples:
default:
- "$ref": "#/components/examples/org-custom-properties"
+ "$ref": "#/components/examples/custom-properties"
'403':
"$ref": "#/components/responses/forbidden"
'404':
@@ -11663,7 +11778,7 @@ paths:
type: array
description: The array of custom properties to create or update.
items:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
minItems: 1
maxItems: 100
required:
@@ -11694,10 +11809,10 @@ paths:
schema:
type: array
items:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
examples:
default:
- "$ref": "#/components/examples/org-custom-properties"
+ "$ref": "#/components/examples/custom-properties"
'403':
"$ref": "#/components/responses/forbidden"
'404':
@@ -11728,10 +11843,10 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
examples:
default:
- "$ref": "#/components/examples/org-custom-property"
+ "$ref": "#/components/examples/custom-property"
'403':
"$ref": "#/components/responses/forbidden"
'404':
@@ -11817,10 +11932,10 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
examples:
default:
- "$ref": "#/components/examples/org-custom-property"
+ "$ref": "#/components/examples/custom-property"
'403':
"$ref": "#/components/responses/forbidden"
'404':
@@ -12281,6 +12396,8 @@ paths:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
+ Required when using `squash_merge_commit_message`.
+
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
@@ -12303,6 +12420,8 @@ paths:
- PR_TITLE
- MERGE_MESSAGE
description: |-
+ Required when using `merge_commit_message`.
+
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
@@ -12434,6 +12553,7 @@ paths:
- branch
- tag
- push
+ default: branch
enforcement:
"$ref": "#/components/schemas/repository-rule-enforcement"
bypass_actors:
@@ -12571,7 +12691,11 @@ paths:
"/orgs/{org}/rulesets/{ruleset_id}":
get:
summary: Get an organization repository ruleset
- description: Get a repository ruleset for an organization.
+ description: |-
+ Get a repository ruleset for an organization.
+
+ **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
+ making the API request has write access to the ruleset.
tags:
- repos
operationId: repos/get-org-ruleset
@@ -13044,6 +13168,85 @@ paths:
enabledForGitHubApps: false
category: billing
subcategory: billing
+ "/orgs/{org}/team/{team_slug}/copilot/usage":
+ get:
+ summary: Get a summary of Copilot usage for a team
+ description: |-
+ > [!NOTE]
+ > This endpoint is in beta and is subject to change.
+
+ You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
+ for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
+ See the response schema tab for detailed metrics definitions.
+
+ The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
+ and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
+ they must have telemetry enabled in their IDE.
+
+ > [!NOTE]
+ > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.
+
+ Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.
+
+ OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
+ tags:
+ - copilot
+ operationId: copilot/usage-metrics-for-team
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team
+ parameters:
+ - "$ref": "#/components/parameters/org"
+ - "$ref": "#/components/parameters/team-slug"
+ - name: since
+ description: Show usage metrics since this date. This is a timestamp in [ISO
+ 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`).
+ Maximum value is 28 days ago.
+ in: query
+ required: false
+ schema:
+ type: string
+ - name: until
+ description: Show usage metrics until this date. This is a timestamp in [ISO
+ 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`)
+ and should not preceed the `since` date if it is passed.
+ in: query
+ required: false
+ schema:
+ type: string
+ - "$ref": "#/components/parameters/page"
+ - name: per_page
+ description: The number of days of metrics to display per page (max 28). For
+ more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ in: query
+ schema:
+ type: integer
+ default: 28
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/copilot-usage-metrics"
+ examples:
+ default:
+ "$ref": "#/components/examples/copilot-usage-metrics-org"
+ '500':
+ "$ref": "#/components/responses/internal_error"
+ '401':
+ "$ref": "#/components/responses/requires_authentication"
+ '403':
+ "$ref": "#/components/responses/forbidden"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: copilot
+ subcategory: copilot-usage
"/orgs/{org}/teams":
get:
summary: List teams
@@ -16017,6 +16220,8 @@ paths:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
+ Required when using `squash_merge_commit_message`.
+
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
@@ -16039,6 +16244,8 @@ paths:
- PR_TITLE
- MERGE_MESSAGE
description: |-
+ Required when using `merge_commit_message`.
+
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
@@ -23581,6 +23788,47 @@ paths:
githubCloudOnly: false
category: code-scanning
subcategory: code-scanning
+ "/repos/{owner}/{repo}/code-security-configuration":
+ get:
+ summary: Get the code security configuration associated with a repository
+ description: |-
+ Get the code security configuration that manages a repository's code security settings.
+
+ The authenticated user must be an administrator or security manager for the organization to use this endpoint.
+
+ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ tags:
+ - code-security
+ operationId: code-security/get-configuration-for-repository
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
+ parameters:
+ - "$ref": "#/components/parameters/owner"
+ - "$ref": "#/components/parameters/repo"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/code-security-configuration-for-repository"
+ examples:
+ default:
+ "$ref": "#/components/examples/code-security-configuration-for-repository"
+ '204':
+ "$ref": "#/components/responses/no_content"
+ '304':
+ "$ref": "#/components/responses/not_modified"
+ '403':
+ "$ref": "#/components/responses/forbidden"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ githubCloudOnly: false
+ enabledForGitHubApps: true
+ category: code-security
+ subcategory: configurations
"/repos/{owner}/{repo}/codeowners/errors":
get:
summary: List CODEOWNERS errors
@@ -35910,6 +36158,8 @@ paths:
examples:
default:
"$ref": "#/components/examples/content-file"
+ '304':
+ "$ref": "#/components/responses/not_modified"
'404':
"$ref": "#/components/responses/not_found"
'422':
@@ -36901,6 +37151,7 @@ paths:
- branch
- tag
- push
+ default: branch
enforcement:
"$ref": "#/components/schemas/repository-rule-enforcement"
bypass_actors:
@@ -37032,7 +37283,11 @@ paths:
"/repos/{owner}/{repo}/rulesets/{ruleset_id}":
get:
summary: Get a repository ruleset
- description: Get a ruleset for a repository.
+ description: |-
+ Get a ruleset for a repository.
+
+ **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
+ making the API request has write access to the ruleset.
tags:
- repos
operationId: repos/get-repo-ruleset
@@ -37401,6 +37656,67 @@ paths:
enabledForGitHubApps: true
category: secret-scanning
subcategory: secret-scanning
+ "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses":
+ post:
+ summary: Create a push protection bypass
+ description: |-
+ Creates a bypass for a previously push protected secret.
+
+ The authenticated user must be the original author of the committed secret.
+
+ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ operationId: secret-scanning/create-push-protection-bypass
+ tags:
+ - secret-scanning
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
+ parameters:
+ - "$ref": "#/components/parameters/owner"
+ - "$ref": "#/components/parameters/repo"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ reason:
+ "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason"
+ placeholder_id:
+ "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id"
+ required:
+ - reason
+ - placeholder_id
+ examples:
+ default:
+ value:
+ reason: will_fix_later
+ placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/secret-scanning-push-protection-bypass"
+ examples:
+ default:
+ "$ref": "#/components/examples/secret-scanning-push-protection-bypass"
+ '403':
+ description: User does not have enough permissions to perform this action.
+ '404':
+ description: Placeholder ID not found, or push protection is disabled on
+ this repository.
+ '422':
+ description: Bad request, input data missing or incorrect.
+ '503':
+ "$ref": "#/components/responses/service_unavailable"
+ x-github:
+ enabledForGitHubApps: true
+ githubCloudOnly: false
+ category: secret-scanning
+ subcategory: secret-scanning
"/repos/{owner}/{repo}/security-advisories":
get:
summary: List repository security advisories
@@ -44899,6 +45215,8 @@ paths:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: |-
+ Required when using `squash_merge_commit_message`.
+
The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request's title.
@@ -44921,6 +45239,8 @@ paths:
- PR_TITLE
- MERGE_MESSAGE
description: |-
+ Required when using `merge_commit_message`.
+
The default value for a merge commit title.
- `PR_TITLE` - default to the pull request's title.
@@ -45878,8 +46198,11 @@ paths:
"/users/{username}/events":
get:
summary: List events for the authenticated user
- description: If you are authenticated as the given user, you will see your private
- events. Otherwise, you'll only see public events.
+ description: |-
+ If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
+
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-events-for-authenticated-user
@@ -45910,8 +46233,11 @@ paths:
"/users/{username}/events/orgs/{org}":
get:
summary: List organization events for the authenticated user
- description: This is the user's organization dashboard. You must be authenticated
- as the user to view this.
+ description: |-
+ This is the user's organization dashboard. You must be authenticated as the user to view this.
+
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-org-events-for-authenticated-user
@@ -45943,7 +46269,9 @@ paths:
"/users/{username}/events/public":
get:
summary: List public events for a user
- description: ''
+ description: |-
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events-for-user
@@ -46655,9 +46983,12 @@ paths:
"/users/{username}/received_events":
get:
summary: List events received by the authenticated user
- description: These are events that you've received by watching repositories
- and following users. If you are authenticated as the given user, you will
- see private events. Otherwise, you'll only see public events.
+ description: |-
+ These are events that you've received by watching repositories and following users. If you are authenticated as the
+ given user, you will see private events. Otherwise, you'll only see public events.
+
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-received-events-for-user
@@ -46688,7 +47019,9 @@ paths:
"/users/{username}/received_events/public":
get:
summary: List public events received by a user
- description: ''
+ description: |-
+ > [!NOTE]
+ > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-received-public-events-for-user
@@ -66172,6 +66505,64 @@ components:
- html_url
- key
- name
+ organization-simple:
+ title: Organization Simple
+ description: A GitHub organization.
+ type: object
+ properties:
+ login:
+ type: string
+ example: github
+ id:
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDEyOk9yZ2FuaXphdGlvbjE=
+ url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github
+ repos_url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github/repos
+ events_url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github/events
+ hooks_url:
+ type: string
+ example: https://api.github.com/orgs/github/hooks
+ issues_url:
+ type: string
+ example: https://api.github.com/orgs/github/issues
+ members_url:
+ type: string
+ example: https://api.github.com/orgs/github/members{/member}
+ public_members_url:
+ type: string
+ example: https://api.github.com/orgs/github/public_members{/member}
+ avatar_url:
+ type: string
+ example: https://github.com/images/error/octocat_happy.gif
+ description:
+ type: string
+ example: A great organization
+ nullable: true
+ required:
+ - login
+ - url
+ - id
+ - node_id
+ - repos_url
+ - events_url
+ - hooks_url
+ - issues_url
+ - members_url
+ - public_members_url
+ - avatar_url
+ - description
nullable-team-simple:
title: Team Simple
description: Groups of organization members that gives permissions on specified
@@ -66309,187 +66700,6 @@ components:
- repositories_url
- slug
- parent
- organization:
- title: Organization
- description: GitHub account for managing multiple users, teams, and repositories
- type: object
- properties:
- login:
- description: Unique login name of the organization
- example: new-org
- type: string
- url:
- description: URL for the organization
- example: https://api.github.com/orgs/github
- type: string
- format: uri
- id:
- type: integer
- node_id:
- type: string
- repos_url:
- type: string
- format: uri
- events_url:
- type: string
- format: uri
- hooks_url:
- type: string
- issues_url:
- type: string
- members_url:
- type: string
- public_members_url:
- type: string
- avatar_url:
- type: string
- description:
- type: string
- nullable: true
- blog:
- description: Display blog url for the organization
- example: blog.example-org.com
- type: string
- format: uri
- html_url:
- type: string
- format: uri
- name:
- description: Display name for the organization
- example: New Org
- type: string
- company:
- description: Display company name for the organization
- example: Acme corporation
- type: string
- location:
- description: Display location for the organization
- example: Berlin, Germany
- type: string
- email:
- description: Display email for the organization
- example: org@example.com
- type: string
- format: email
- has_organization_projects:
- description: Specifies if organization projects are enabled for this org
- type: boolean
- has_repository_projects:
- description: Specifies if repository projects are enabled for repositories
- that belong to this org
- type: boolean
- is_verified:
- type: boolean
- public_repos:
- type: integer
- public_gists:
- type: integer
- followers:
- type: integer
- following:
- type: integer
- type:
- type: string
- created_at:
- type: string
- format: date-time
- updated_at:
- type: string
- format: date-time
- plan:
- type: object
- properties:
- name:
- type: string
- space:
- type: integer
- private_repos:
- type: integer
- filled_seats:
- type: integer
- seats:
- type: integer
- required:
- - login
- - url
- - id
- - node_id
- - repos_url
- - events_url
- - hooks_url
- - issues_url
- - members_url
- - public_members_url
- - avatar_url
- - description
- - html_url
- - has_organization_projects
- - has_repository_projects
- - public_repos
- - public_gists
- - followers
- - following
- - type
- - created_at
- - updated_at
- organization-simple:
- title: Organization Simple
- description: A GitHub organization.
- type: object
- properties:
- login:
- type: string
- example: github
- id:
- type: integer
- example: 1
- node_id:
- type: string
- example: MDEyOk9yZ2FuaXphdGlvbjE=
- url:
- type: string
- format: uri
- example: https://api.github.com/orgs/github
- repos_url:
- type: string
- format: uri
- example: https://api.github.com/orgs/github/repos
- events_url:
- type: string
- format: uri
- example: https://api.github.com/orgs/github/events
- hooks_url:
- type: string
- example: https://api.github.com/orgs/github/hooks
- issues_url:
- type: string
- example: https://api.github.com/orgs/github/issues
- members_url:
- type: string
- example: https://api.github.com/orgs/github/members{/member}
- public_members_url:
- type: string
- example: https://api.github.com/orgs/github/public_members{/member}
- avatar_url:
- type: string
- example: https://github.com/images/error/octocat_happy.gif
- description:
- type: string
- example: A great organization
- nullable: true
- required:
- - login
- - url
- - id
- - node_id
- - repos_url
- - events_url
- - hooks_url
- - issues_url
- - members_url
- - public_members_url
- - avatar_url
- - description
enterprise-team:
title: Enterprise Team
description: Group of enterprise owners and/or members
@@ -66546,8 +66756,6 @@ components:
additionalProperties: true
oneOf:
- "$ref": "#/components/schemas/simple-user"
- - "$ref": "#/components/schemas/team"
- - "$ref": "#/components/schemas/organization"
organization:
type: object
description: The organization to which this seat belongs.
@@ -68954,6 +69162,12 @@ components:
type: string
example:
- 192.0.2.1
+ copilot:
+ type: array
+ items:
+ type: string
+ example:
+ - 192.0.2.1
domains:
type: object
properties:
@@ -70154,12 +70368,6 @@ components:
name:
type: string
description: The name of the rule used to detect the alert.
- tags:
- nullable: true
- type: array
- description: A set of tags applicable for the rule.
- items:
- type: string
severity:
nullable: true
type: string
@@ -70181,6 +70389,12 @@ components:
description:
type: string
description: A short description of the rule used to detect the alert.
+ tags:
+ nullable: true
+ type: array
+ description: A set of tags applicable for the rule.
+ items:
+ type: string
code-scanning-analysis-tool-version:
nullable: true
type: string
@@ -70350,6 +70564,21 @@ components:
- enabled
- disabled
- not_set
+ dependency_graph_autosubmit_action:
+ type: string
+ description: The enablement status of Automatic dependency submission
+ enum:
+ - enabled
+ - disabled
+ - not_set
+ dependency_graph_autosubmit_action_options:
+ type: object
+ description: Feature options for Automatic dependency submission
+ properties:
+ labeled_runners:
+ type: boolean
+ description: Whether to use runners labeled with 'dependency-submission'
+ or standard GitHub runners.
dependabot_alerts:
type: string
description: The enablement status of Dependabot alerts
@@ -72174,7 +72403,7 @@ components:
- columns_url
- created_at
- updated_at
- org-custom-property:
+ custom-property:
title: Organization Custom Property
description: Custom property defined on an organization
type: object
@@ -72182,6 +72411,11 @@ components:
property_name:
type: string
description: The name of the property
+ url:
+ type: string
+ format: uri
+ description: The URL that can be used to fetch, update, or delete info about
+ this property via the API.
value_type:
type: string
example: single_select
@@ -73263,6 +73497,7 @@ components:
- RepositoryRole
- Team
- DeployKey
+ - EnterpriseTeam
description: 'The type of actor that can bypass a ruleset.
'
@@ -79071,6 +79306,26 @@ components:
description: Any errors that ocurred during processing of the delivery.
readOnly: true
nullable: true
+ code-security-configuration-for-repository:
+ type: object
+ description: Code security configuration associated with a repository and attachment
+ status
+ properties:
+ status:
+ type: string
+ description: The attachment status of the code security configuration on
+ the repository.
+ enum:
+ - attached
+ - attaching
+ - detached
+ - removed
+ - enforced
+ - failed
+ - updating
+ - removed_by_enterprise
+ configuration:
+ "$ref": "#/components/schemas/code-security-configuration"
codeowners-errors:
title: CODEOWNERS errors
description: A list of errors found in a repo's CODEOWNERS file
@@ -85661,6 +85916,7 @@ components:
description: Unique identifier of the review
example: 42
type: integer
+ format: int64
node_id:
type: string
example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
@@ -86450,6 +86706,30 @@ components:
- "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment"
- "$ref": "#/components/schemas/secret-scanning-location-pull-request-review"
- "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment"
+ secret-scanning-push-protection-bypass-reason:
+ description: The reason for bypassing push protection.
+ type: string
+ enum:
+ - false_positive
+ - used_in_tests
+ - will_fix_later
+ secret-scanning-push-protection-bypass-placeholder-id:
+ description: The ID of the push protection bypass placeholder. This value is
+ returned on any push protected routes.
+ type: string
+ secret-scanning-push-protection-bypass:
+ type: object
+ properties:
+ reason:
+ "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason"
+ expire_at:
+ type: string
+ format: date-time
+ description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
+ nullable: true
+ token_type:
+ type: string
+ description: The token type this bypass is for.
repository-advisory-create:
type: object
properties:
@@ -102940,7 +103220,7 @@ components:
enum:
- created
definition:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
enterprise:
"$ref": "#/components/schemas/enterprise-webhooks"
installation:
@@ -102988,7 +103268,7 @@ components:
enum:
- updated
definition:
- "$ref": "#/components/schemas/org-custom-property"
+ "$ref": "#/components/schemas/custom-property"
enterprise:
"$ref": "#/components/schemas/enterprise-webhooks"
installation:
@@ -195811,6 +196091,70 @@ components:
push_protection_bypassed_at:
resolution_comment:
validity: unknown
+ copilot-usage-metrics-org:
+ value:
+ - day: '2023-10-15'
+ total_suggestions_count: 1000
+ total_acceptances_count: 800
+ total_lines_suggested: 1800
+ total_lines_accepted: 1200
+ total_active_users: 10
+ total_chat_acceptances: 32
+ total_chat_turns: 200
+ total_active_chat_users: 4
+ breakdown:
+ - language: python
+ editor: vscode
+ suggestions_count: 300
+ acceptances_count: 250
+ lines_suggested: 900
+ lines_accepted: 700
+ active_users: 5
+ - language: python
+ editor: jetbrains
+ suggestions_count: 300
+ acceptances_count: 200
+ lines_suggested: 400
+ lines_accepted: 300
+ active_users: 2
+ - language: ruby
+ editor: vscode
+ suggestions_count: 400
+ acceptances_count: 350
+ lines_suggested: 500
+ lines_accepted: 200
+ active_users: 3
+ - day: '2023-10-16'
+ total_suggestions_count: 800
+ total_acceptances_count: 600
+ total_lines_suggested: 1100
+ total_lines_accepted: 700
+ total_active_users: 12
+ total_chat_acceptances: 57
+ total_chat_turns: 426
+ total_active_chat_users: 8
+ breakdown:
+ - language: python
+ editor: vscode
+ suggestions_count: 300
+ acceptances_count: 200
+ lines_suggested: 600
+ lines_accepted: 300
+ active_users: 2
+ - language: python
+ editor: jetbrains
+ suggestions_count: 300
+ acceptances_count: 150
+ lines_suggested: 300
+ lines_accepted: 250
+ active_users: 6
+ - language: ruby
+ editor: vscode
+ suggestions_count: 200
+ acceptances_count: 150
+ lines_suggested: 200
+ lines_accepted: 150
+ active_users: 3
public-events-items:
value:
- id: '22249084947'
@@ -196945,6 +197289,8 @@ components:
- 192.0.2.1
dependabot:
- 192.0.2.1
+ copilot:
+ - 192.0.2.1
domains:
website:
- "*.example.com"
@@ -198046,6 +198392,9 @@ components:
scanning.
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: not_set
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: not_set
code_scanning_default_setup: enabled
@@ -198053,6 +198402,7 @@ components:
secret_scanning_push_protection: enabled
secret_scanning_validity_checks: enabled
private_vulnerability_reporting: enabled
+ enforcement: enforced
url: https://api.github.com/orgs/octo-org/code-security/configurations/17
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view
created_at: '2023-12-04T15:58:07Z'
@@ -198064,6 +198414,9 @@ components:
repositories
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: enabled
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: enabled
code_scanning_default_setup: enabled
@@ -198071,6 +198424,7 @@ components:
secret_scanning_push_protection: enabled
secret_scanning_validity_checks: disabled
private_vulnerability_reporting: enabled
+ enforcement: enforced
url: https://api.github.com/orgs/octo-org/code-security/configurations/1326
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326
created_at: '2024-05-10T00:00:00Z'
@@ -198083,6 +198437,9 @@ components:
description: This is a code security configuration for octo-org
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: enabled
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: not_set
code_scanning_default_setup: disabled
@@ -198105,6 +198462,9 @@ components:
description: This is a code security configuration for octo-org
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: not_set
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: not_set
code_scanning_default_setup: enabled
@@ -198112,6 +198472,7 @@ components:
secret_scanning_push_protection: enabled
secret_scanning_validity_checks: enabled
private_vulnerability_reporting: enabled
+ enforcement: enforced
url: https://api.github.com/orgs/octo-org/code-security/configurations/1325
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325
created_at: '2024-05-01T00:00:00Z'
@@ -198125,6 +198486,9 @@ components:
scanning.
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: not_set
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: not_set
code_scanning_default_setup: enabled
@@ -198132,6 +198496,7 @@ components:
secret_scanning_push_protection: enabled
secret_scanning_validity_checks: disabled
private_vulnerability_reporting: enabled
+ enforcement: enforced
url: https://api.github.com/orgs/octo-org/code-security/configurations/17
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view
created_at: '2023-12-04T15:58:07Z'
@@ -198144,6 +198509,9 @@ components:
description: This is a code security configuration for octo-org
advanced_security: enabled
dependency_graph: enabled
+ dependency_graph_autosubmit_action: enabled
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
dependabot_alerts: enabled
dependabot_security_updates: not_set
code_scanning_default_setup: enabled
@@ -198151,6 +198519,7 @@ components:
secret_scanning_push_protection: disabled
secret_scanning_validity_checks: disabled
private_vulnerability_reporting: disabled
+ enforcement: enforced
url: https://api.github.com/orgs/octo-org/code-security/configurations/1325
html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325
created_at: '2024-05-01T00:00:00Z'
@@ -198665,70 +199034,6 @@ components:
inactive_this_cycle: 11
seat_management_setting: assign_selected
public_code_suggestions: block
- copilot-usage-metrics-org:
- value:
- - day: '2023-10-15'
- total_suggestions_count: 1000
- total_acceptances_count: 800
- total_lines_suggested: 1800
- total_lines_accepted: 1200
- total_active_users: 10
- total_chat_acceptances: 32
- total_chat_turns: 200
- total_active_chat_users: 4
- breakdown:
- - language: python
- editor: vscode
- suggestions_count: 300
- acceptances_count: 250
- lines_suggested: 900
- lines_accepted: 700
- active_users: 5
- - language: python
- editor: jetbrains
- suggestions_count: 300
- acceptances_count: 200
- lines_suggested: 400
- lines_accepted: 300
- active_users: 2
- - language: ruby
- editor: vscode
- suggestions_count: 400
- acceptances_count: 350
- lines_suggested: 500
- lines_accepted: 200
- active_users: 3
- - day: '2023-10-16'
- total_suggestions_count: 800
- total_acceptances_count: 600
- total_lines_suggested: 1100
- total_lines_accepted: 700
- total_active_users: 12
- total_chat_acceptances: 57
- total_chat_turns: 426
- total_active_chat_users: 8
- breakdown:
- - language: python
- editor: vscode
- suggestions_count: 300
- acceptances_count: 200
- lines_suggested: 600
- lines_accepted: 300
- active_users: 2
- - language: python
- editor: jetbrains
- suggestions_count: 300
- acceptances_count: 150
- lines_suggested: 300
- lines_accepted: 250
- active_users: 6
- - language: ruby
- editor: vscode
- suggestions_count: 200
- acceptances_count: 150
- lines_suggested: 200
- lines_accepted: 150
- active_users: 3
organization-dependabot-secret-paginated:
value:
total_count: 3
@@ -200154,9 +200459,10 @@ components:
site_admin: false
created_at: '2011-04-11T20:09:31Z'
updated_at: '2014-03-04T18:58:10Z'
- org-custom-properties:
+ custom-properties:
value:
- property_name: environment
+ url: https://api.github.com/orgs/github/properties/schema/environment
value_type: single_select
required: true
default_value: production
@@ -200166,13 +200472,16 @@ components:
- development
values_editable_by: org_actors
- property_name: service
+ url: https://api.github.com/orgs/github/properties/schema/service
value_type: string
- property_name: team
+ url: https://api.github.com/orgs/github/properties/schema/team
value_type: string
description: Team owning the repository
- org-custom-property:
+ custom-property:
value:
property_name: environment
+ url: https://api.github.com/orgs/github/properties/schema/environment
value_type: single_select
required: true
default_value: production
@@ -205633,6 +205942,31 @@ components:
value:
processing_status: complete
analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6
+ code-security-configuration-for-repository:
+ value:
+ state: attached
+ configuration:
+ id: 1325
+ target_type: organization
+ name: octo-org recommended settings
+ description: This is a code security configuration for octo-org
+ advanced_security: enabled
+ dependency_graph: enabled
+ dependency_graph_autosubmit_action: enabled
+ dependency_graph_autosubmit_action_options:
+ labeled_runners: false
+ dependabot_alerts: enabled
+ dependabot_security_updates: not_set
+ code_scanning_default_setup: disabled
+ secret_scanning: enabled
+ secret_scanning_push_protection: disabled
+ secret_scanning_validity_checks: disabled
+ private_vulnerability_reporting: disabled
+ enforcement: enforced
+ url: https://api.github.com/orgs/octo-org/code-security/configurations/1325
+ html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325
+ created_at: '2024-05-01T00:00:00Z'
+ updated_at: '2024-05-01T00:00:00Z'
codeowners-errors:
value:
errors:
@@ -212952,6 +213286,11 @@ components:
- type: pull_request_review_comment
details:
pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
+ secret-scanning-push-protection-bypass:
+ value:
+ reason: will_fix_later
+ expire_at: '2020-11-06T18:18:30Z'
+ token_type: mailchimp_api_key
repository-advisory:
value:
ghsa_id: GHSA-abcd-1234-efgh
@@ -219116,6 +219455,13 @@ components:
required: false
schema:
type: string
+ team-slug:
+ name: team_slug
+ description: The slug of the team name.
+ in: path
+ required: true
+ schema:
+ type: string
gist-id:
name: gist_id
description: The unique identifier of the gist.
@@ -219340,13 +219686,6 @@ components:
required: true
schema:
type: string
- team-slug:
- name: team_slug
- description: The slug of the team name.
- in: path
- required: true
- schema:
- type: string
role-id:
name: role_id
description: The unique identifier of the role.
diff --git a/integration-tests-definitions/stripe.yaml b/integration-tests-definitions/stripe.yaml
index d8f5d4601..3436738fe 100644
--- a/integration-tests-definitions/stripe.yaml
+++ b/integration-tests-definitions/stripe.yaml
@@ -1281,35 +1281,33 @@ components:
type: string
statement_descriptor_kana:
description: >-
- The Kana variation of the default text that appears on credit card
- statements when a charge is made (Japan only)
+ The Kana variation of `statement_descriptor` used for charges in
+ Japan. Japanese statement descriptors have [special
+ requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
maxLength: 5000
nullable: true
type: string
statement_descriptor_kanji:
description: >-
- The Kanji variation of the default text that appears on credit card
- statements when a charge is made (Japan only)
+ The Kanji variation of `statement_descriptor` used for charges in
+ Japan. Japanese statement descriptors have [special
+ requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
maxLength: 5000
nullable: true
type: string
statement_descriptor_prefix_kana:
description: >-
- The Kana variation of the default text that appears on credit card
- statements when a charge is made (Japan only). This field prefixes
- any dynamic `statement_descriptor_suffix_kana` specified on the
- charge. `statement_descriptor_prefix_kana` is useful for maximizing
- descriptor space for the dynamic portion.
+ The Kana variation of `statement_descriptor_prefix` used for card
+ charges in Japan. Japanese statement descriptors have [special
+ requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
maxLength: 5000
nullable: true
type: string
statement_descriptor_prefix_kanji:
description: >-
- The Kanji variation of the default text that appears on credit card
- statements when a charge is made (Japan only). This field prefixes
- any dynamic `statement_descriptor_suffix_kanji` specified on the
- charge. `statement_descriptor_prefix_kanji` is useful for maximizing
- descriptor space for the dynamic portion.
+ The Kanji variation of `statement_descriptor_prefix` used for card
+ charges in Japan. Japanese statement descriptors have [special
+ requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
maxLength: 5000
nullable: true
type: string
@@ -3196,6 +3194,71 @@ components:
title: BankConnectionsResourceTransactionResourceStatusTransitions
type: object
x-expandableFields: []
+ billing.alert:
+ description: >-
+ A billing alert is a resource that notifies you when a certain usage
+ threshold on a meter is crossed. For example, you might create a billing
+ alert to notify you when a certain user made 100 API requests.
+ properties:
+ alert_type:
+ description: Defines the type of the alert.
+ enum:
+ - usage_threshold
+ type: string
+ filter:
+ anyOf:
+ - $ref: '#/components/schemas/thresholds_resource_alert_filter'
+ description: >-
+ Limits the scope of the alert to a specific
+ [customer](https://stripe.com/docs/api/customers).
+ nullable: true
+ id:
+ description: Unique identifier for the object.
+ maxLength: 5000
+ type: string
+ livemode:
+ description: >-
+ Has the value `true` if the object exists in live mode or the value
+ `false` if the object exists in test mode.
+ type: boolean
+ object:
+ description: >-
+ String representing the object's type. Objects of the same type
+ share the same value.
+ enum:
+ - billing.alert
+ type: string
+ status:
+ description: 'Status of the alert. This can be active, inactive or archived.'
+ enum:
+ - active
+ - archived
+ - inactive
+ nullable: true
+ type: string
+ title:
+ description: Title of the alert.
+ maxLength: 5000
+ type: string
+ usage_threshold_config:
+ anyOf:
+ - $ref: '#/components/schemas/thresholds_resource_usage_threshold_config'
+ description: >-
+ Encapsulates configuration of the alert to monitor usage on a
+ specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
+ nullable: true
+ required:
+ - alert_type
+ - id
+ - livemode
+ - object
+ - title
+ title: ThresholdsResourceAlert
+ type: object
+ x-expandableFields:
+ - filter
+ - usage_threshold_config
+ x-resourceId: billing.alert
billing.meter:
description: >-
A billing meter is a resource that allows you to track usage of a
@@ -4024,8 +4087,8 @@ components:
brand:
description: >-
Card brand. Can be `American Express`, `Diners Club`, `Discover`,
- `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or
- `Unknown`.
+ `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`,
+ `Visa`, or `Unknown`.
maxLength: 5000
type: string
country:
@@ -4039,7 +4102,9 @@ components:
currency:
description: >-
Three-letter [ISO code for
- currency](https://stripe.com/docs/payouts). Only applicable on
+ currency](https://www.iso.org/iso-4217-currency-codes.html) in
+ lowercase. Must be a [supported
+ currency](https://docs.stripe.com/currencies). Only applicable on
accounts (not customers or recipients). The card can be used as a
transfer destination for funds in this currency. This property is
only available for accounts where
@@ -4359,8 +4424,8 @@ components:
The full statement descriptor that is passed to card networks, and
that is displayed on your customers' credit card and bank
statements. Allows you to see what the statement descriptor looks
- like after the static and dynamic portions are combined. This only
- works for card payments.
+ like after the static and dynamic portions are combined. This value
+ only exists for card payments.
maxLength: 5000
nullable: true
type: string
@@ -4606,7 +4671,7 @@ components:
description: >-
The transfer ID which created this charge. Only present if the
charge came from another Stripe account. [See the Connect
- documentation](https://stripe.com/docs/connect/destination-charges)
+ documentation](https://docs.stripe.com/connect/destination-charges)
for details.
nullable: true
x-expansionResources:
@@ -4614,20 +4679,24 @@ components:
- $ref: '#/components/schemas/transfer'
statement_descriptor:
description: >-
- For card charges, use `statement_descriptor_suffix` instead.
- Otherwise, you can use this value as the complete description of a
- charge on your customers’ statements. Must contain at least one
- letter, maximum 22 characters.
+ For a non-card charge, text that appears on the customer's statement
+ as the [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors).
+ This value overrides the account's default statement descriptor. For
+ a card charge, this value is ignored unless you don't specify a
+ `statement_descriptor_suffix`, in which case this value is used as
+ the suffix.
maxLength: 5000
nullable: true
type: string
statement_descriptor_suffix:
description: >-
- Provides information about the charge that customers see on their
- statements. Concatenated with the prefix (shortened descriptor) or
- statement descriptor that’s set on the account to form the complete
- statement descriptor. Maximum 22 characters for the concatenated
- descriptor.
+ Provides information about a card charge. Concatenated to the
+ account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on the
+ customer's statement. If the account has no prefix value, the suffix
+ is concatenated to the account's statement descriptor.
maxLength: 5000
nullable: true
type: string
@@ -4946,7 +5015,8 @@ components:
- $ref: >-
#/components/schemas/payment_pages_checkout_session_currency_conversion
description: >-
- Currency conversion details for automatic currency conversion
+ Currency conversion details for [Adaptive
+ Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing)
sessions
nullable: true
custom_fields:
@@ -5478,19 +5548,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -5517,19 +5592,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5545,19 +5625,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5573,19 +5658,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5601,19 +5691,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -5630,19 +5725,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5658,19 +5758,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -5688,19 +5793,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5723,19 +5833,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -5784,19 +5899,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -5838,19 +5958,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5922,19 +6047,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5951,19 +6081,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -5979,19 +6114,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6007,19 +6147,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6035,19 +6180,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6063,19 +6213,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6091,19 +6246,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -6129,19 +6289,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6157,19 +6322,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -6186,19 +6356,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6214,19 +6389,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6249,19 +6429,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6279,19 +6464,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6307,19 +6497,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6358,19 +6553,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -6397,19 +6597,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -6426,19 +6631,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -6560,19 +6770,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -6603,19 +6818,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -9588,7 +9808,7 @@ components:
payment_method_redisplay_limit:
description: >-
Determines the max number of saved payment methods for the Payment
- Element to display. This parameter defaults to `10`.
+ Element to display. This parameter defaults to `3`.
nullable: true
type: integer
payment_method_remove:
@@ -13904,6 +14124,11 @@ components:
Redaction status of this VerificationSession. If the
VerificationSession is not redacted, this field will be null.
nullable: true
+ related_customer:
+ description: Token referencing a Customer resource.
+ maxLength: 5000
+ nullable: true
+ type: string
status:
description: >-
Status of this VerificationSession. [Learn more about the lifecycle
@@ -17009,8 +17234,11 @@ components:
description: The total net amount required to settle with the network.
type: integer
network:
- description: 'The card network for this settlement report. One of ["visa"]'
+ description: >-
+ The card network for this settlement report. One of ["visa",
+ "maestro"]
enum:
+ - maestro
- visa
type: string
network_fees:
@@ -23170,6 +23398,24 @@ components:
title: PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture
type: object
x-expandableFields: []
+ payment_flows_private_payment_methods_card_present_common_wallet:
+ description: ''
+ properties:
+ type:
+ description: >-
+ The type of mobile wallet, one of `apple_pay`, `google_pay`,
+ `samsung_pay`, or `unknown`.
+ enum:
+ - apple_pay
+ - google_pay
+ - samsung_pay
+ - unknown
+ type: string
+ required:
+ - type
+ title: PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet
+ type: object
+ x-expandableFields: []
payment_flows_private_payment_methods_klarna_dob:
description: ''
properties:
@@ -23365,11 +23611,16 @@ components:
PaymentIntent.
- If present in combination with
- [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage),
- this PaymentIntent's payment method will be attached to the Customer
+ If
+ [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage)
+ is set and this PaymentIntent's payment method is not
+ `card_present`, then the payment method attaches to the Customer
after the PaymentIntent has been confirmed and any required actions
- from the user are complete.
+ from the user are complete. If the payment method is `card_present`
+ and isn't a digital wallet, then a
+ [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card is created and attached to the
+ Customer instead.
nullable: true
x-expansionResources:
oneOf:
@@ -23526,19 +23777,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- off_session
- on_session
@@ -23551,21 +23807,23 @@ components:
nullable: true
statement_descriptor:
description: >-
- For card charges, use
- [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic).
- Otherwise, you can use this value as the complete description of a
- charge on your customers' statements. It must contain at least one
- letter and be 1–22 characters long.
+ Text that appears on the customer's statement as the [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors)
+ for a non-card charge. This value overrides the account's default
+ statement descriptor. Setting this value for a card charge returns
+ an error. For card charges, set the
+ [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic)
+ instead.
maxLength: 5000
nullable: true
type: string
statement_descriptor_suffix:
description: >-
- Provides information about a card payment that customers see on
- their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the account to
- form the complete statement descriptor. Maximum 22 characters for
- the concatenated descriptor.
+ Provides information about a card charge. Concatenated to the
+ account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on the
+ customer's statement.
maxLength: 5000
nullable: true
type: string
@@ -24389,7 +24647,8 @@ components:
#/components/schemas/payment_intent_type_specific_payment_method_options_client
bacs_debit:
anyOf:
- - $ref: '#/components/schemas/payment_method_options_bacs_debit'
+ - $ref: >-
+ #/components/schemas/payment_intent_payment_method_options_bacs_debit
- $ref: >-
#/components/schemas/payment_intent_type_specific_payment_method_options_client
bancontact:
@@ -24609,19 +24868,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -24648,19 +24912,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -24669,6 +24938,45 @@ components:
title: payment_intent_payment_method_options_au_becs_debit
type: object
x-expandableFields: []
+ payment_intent_payment_method_options_bacs_debit:
+ description: ''
+ properties:
+ mandate_options:
+ $ref: >-
+ #/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit
+ setup_future_usage:
+ description: >-
+ Indicates that you intend to make future payments with this
+ PaymentIntent's payment method.
+
+
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
+ Customer after the transaction completes.
+
+
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
+ enum:
+ - none
+ - off_session
+ - on_session
+ type: string
+ title: payment_intent_payment_method_options_bacs_debit
+ type: object
+ x-expandableFields:
+ - mandate_options
payment_intent_payment_method_options_blik:
description: ''
properties:
@@ -24678,19 +24986,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -24736,6 +25049,7 @@ components:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -24812,19 +25126,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -24865,19 +25184,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -24900,19 +25224,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -24952,6 +25281,12 @@ components:
title: payment_intent_payment_method_options_mandate_options_acss_debit
type: object
x-expandableFields: []
+ payment_intent_payment_method_options_mandate_options_bacs_debit:
+ description: ''
+ properties: {}
+ title: payment_intent_payment_method_options_mandate_options_bacs_debit
+ type: object
+ x-expandableFields: []
payment_intent_payment_method_options_mandate_options_sepa_debit:
description: ''
properties: {}
@@ -24974,19 +25309,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -25005,19 +25345,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -25043,19 +25388,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -25082,19 +25432,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -25189,19 +25544,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -25976,19 +26336,18 @@ components:
type: string
statement_descriptor:
description: >-
- Extra information about the payment. This will appear on your
- customer's statement when this payment succeeds in creating a
+ For a non-card payment, information about the charge that appears on
+ the customer's statement when this payment succeeds in creating a
charge.
maxLength: 5000
nullable: true
type: string
statement_descriptor_suffix:
description: >-
- Provides information about the charge that customers see on their
- statements. Concatenated with the prefix (shortened descriptor) or
- statement descriptor that's set on the account to form the complete
- statement descriptor. Maximum 22 characters for the concatenated
- descriptor.
+ For a card payment, information about the charge that appears on the
+ customer's statement when this payment succeeds in creating a
+ charge. Concatenated with the account's statement descriptor prefix
+ to form the complete statement descriptor.
maxLength: 5000
nullable: true
type: string
@@ -27047,6 +27406,11 @@ components:
Contains information about card networks that can be used to process
the payment.
nullable: true
+ offline:
+ anyOf:
+ - $ref: '#/components/schemas/payment_method_details_card_present_offline'
+ description: Details about payment methods collected offline.
+ nullable: true
preferred_locales:
description: >-
EMV tag 5F2D. Preferred languages specified by the integrated
@@ -27066,6 +27430,9 @@ components:
- magnetic_stripe_track2
nullable: true
type: string
+ wallet:
+ $ref: >-
+ #/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet
required:
- exp_month
- exp_year
@@ -27073,6 +27440,8 @@ components:
type: object
x-expandableFields:
- networks
+ - offline
+ - wallet
payment_method_card_present_networks:
description: ''
properties:
@@ -28050,6 +28419,11 @@ components:
description: The authorized amount.
nullable: true
type: integer
+ authorization_code:
+ description: Authorization code on the charge.
+ maxLength: 5000
+ nullable: true
+ type: string
brand:
description: >-
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`,
@@ -28245,6 +28619,7 @@ components:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- type
title: payment_method_details_card_installments_plan
@@ -28386,16 +28761,13 @@ components:
network_transaction_id:
description: >-
This is used by the financial networks to identify a transaction.
-
Visa calls this the Transaction ID, Mastercard calls this the Trace
- ID, and American Express calls this the Acquirer Reference Data.
-
- The first three digits of the Trace ID is the Financial Network
- Code, the next 6 digits is the Banknet Reference Number, and the
- last 4 digits represent the date (MM/DD).
-
- This field will be available for successful Visa, Mastercard, or
- American Express transactions and always null for other card brands.
+ ID, and American Express calls this the Acquirer Reference Data. The
+ first three digits of the Trace ID is the Financial Network Code,
+ the next 6 digits is the Banknet Reference Number, and the last 4
+ digits represent the date (MM/DD). This field will be available for
+ successful Visa, Mastercard, or American Express transactions and
+ always null for other card brands.
maxLength: 5000
nullable: true
type: string
@@ -28433,6 +28805,9 @@ components:
A collection of fields required to be displayed on receipts. Only
required for EMV transactions.
nullable: true
+ wallet:
+ $ref: >-
+ #/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet
required:
- exp_month
- exp_year
@@ -28443,6 +28818,7 @@ components:
x-expandableFields:
- offline
- receipt
+ - wallet
payment_method_details_card_present_offline:
description: ''
properties:
@@ -28451,6 +28827,14 @@ components:
format: unix-time
nullable: true
type: integer
+ type:
+ description: >-
+ The method used to process this payment method offline. Only
+ deferred is allowed.
+ enum:
+ - deferred
+ nullable: true
+ type: string
title: payment_method_details_card_present_offline
type: object
x-expandableFields: []
@@ -29056,16 +29440,13 @@ components:
network_transaction_id:
description: >-
This is used by the financial networks to identify a transaction.
-
Visa calls this the Transaction ID, Mastercard calls this the Trace
- ID, and American Express calls this the Acquirer Reference Data.
-
- The first three digits of the Trace ID is the Financial Network
- Code, the next 6 digits is the Banknet Reference Number, and the
- last 4 digits represent the date (MM/DD).
-
- This field will be available for successful Visa, Mastercard, or
- American Express transactions and always null for other card brands.
+ ID, and American Express calls this the Acquirer Reference Data. The
+ first three digits of the Trace ID is the Financial Network Code,
+ the next 6 digits is the Banknet Reference Number, and the last 4
+ digits represent the date (MM/DD). This field will be available for
+ successful Visa, Mastercard, or American Express transactions and
+ always null for other card brands.
maxLength: 5000
nullable: true
type: string
@@ -30120,19 +30501,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30165,19 +30551,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30194,19 +30585,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -30230,54 +30626,29 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
- enum:
- - none
- - off_session
- type: string
- title: payment_method_options_amazon_pay
- type: object
- x-expandableFields: []
- payment_method_options_bacs_debit:
- description: ''
- properties:
- setup_future_usage:
- description: >-
- Indicates that you intend to make future payments with this
- PaymentIntent's payment method.
-
-
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
- Customer after the transaction completes.
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
- - on_session
type: string
- title: payment_method_options_bacs_debit
+ title: payment_method_options_amazon_pay
type: object
x-expandableFields: []
payment_method_options_bancontact:
@@ -30299,19 +30670,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -30337,19 +30713,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -30522,19 +30903,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -30563,19 +30949,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30657,19 +31048,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30685,19 +31081,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30713,19 +31114,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30741,19 +31147,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -30790,19 +31201,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30848,19 +31264,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30876,19 +31297,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30911,19 +31337,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30941,19 +31372,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -30969,19 +31405,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -31020,19 +31461,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -31059,19 +31505,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -31087,19 +31538,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -31122,19 +31578,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -31165,19 +31626,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
- off_session
@@ -31194,19 +31660,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -31250,19 +31721,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -31278,19 +31754,24 @@ components:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment) to the
- PaymentIntent's Customer, if present, after the PaymentIntent is
- confirmed and any required actions from the user are complete. If no
- Customer was provided, the payment method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach) to a
+ If you provide a Customer with the PaymentIntent, you can use this
+ parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after the
+ PaymentIntent is confirmed and the customer completes any required
+ actions. If you don't provide a Customer, you can still
+ [attach](/api/payment_methods/attach) the payment method to a
Customer after the transaction completes.
- When processing card payments, Stripe also uses `setup_future_usage`
- to dynamically optimize your payment flow and comply with regional
- legislation and network rules, such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital wallet,
+ Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer instead.
+
+
+ When processing card payments, Stripe uses `setup_future_usage` to
+ help you comply with regional legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- none
type: string
@@ -33181,9 +33662,12 @@ components:
description: ''
properties:
account:
- $ref: '#/components/schemas/person_additional_tos_acceptance'
- required:
- - account
+ anyOf:
+ - $ref: '#/components/schemas/person_additional_tos_acceptance'
+ description: >-
+ Details on the legal guardian's acceptance of the main Stripe
+ service agreement.
+ nullable: true
title: PersonAdditionalTOSAcceptances
type: object
x-expandableFields:
@@ -37626,7 +38110,12 @@ components:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/payment_method'
- description: ID of the payment method used with this SetupIntent.
+ description: >-
+ ID of the payment method used with this SetupIntent. If the payment
+ method is `card_present` and isn't a digital wallet, then the
+ [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card)
+ associated with the `latest_attempt` is attached to the Customer
+ instead.
nullable: true
x-expansionResources:
oneOf:
@@ -37806,6 +38295,12 @@ components:
#/components/schemas/setup_intent_payment_method_options_amazon_pay
- $ref: >-
#/components/schemas/setup_intent_type_specific_payment_method_options_client
+ bacs_debit:
+ anyOf:
+ - $ref: >-
+ #/components/schemas/setup_intent_payment_method_options_bacs_debit
+ - $ref: >-
+ #/components/schemas/setup_intent_type_specific_payment_method_options_client
card:
anyOf:
- $ref: '#/components/schemas/setup_intent_payment_method_options_card'
@@ -37844,6 +38339,7 @@ components:
x-expandableFields:
- acss_debit
- amazon_pay
+ - bacs_debit
- card
- card_present
- link
@@ -37881,6 +38377,16 @@ components:
title: setup_intent_payment_method_options_amazon_pay
type: object
x-expandableFields: []
+ setup_intent_payment_method_options_bacs_debit:
+ description: ''
+ properties:
+ mandate_options:
+ $ref: >-
+ #/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit
+ title: setup_intent_payment_method_options_bacs_debit
+ type: object
+ x-expandableFields:
+ - mandate_options
setup_intent_payment_method_options_card:
description: ''
properties:
@@ -37903,6 +38409,7 @@ components:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -38076,6 +38583,12 @@ components:
title: setup_intent_payment_method_options_mandate_options_acss_debit
type: object
x-expandableFields: []
+ setup_intent_payment_method_options_mandate_options_bacs_debit:
+ description: ''
+ properties: {}
+ title: setup_intent_payment_method_options_mandate_options_bacs_debit
+ type: object
+ x-expandableFields: []
setup_intent_payment_method_options_mandate_options_sepa_debit:
description: ''
properties: {}
@@ -39728,11 +40241,8 @@ components:
type: integer
cancel_at_period_end:
description: >-
- If the subscription has been canceled with the `at_period_end` flag
- set to `true`, `cancel_at_period_end` on the subscription will be
- true. You can use this attribute to determine whether a subscription
- that has a status of active is scheduled to be canceled at the end
- of the current period.
+ Whether this subscription will (if `status=active`) or did (if
+ `status=canceled`) cancel at the end of the current billing period.
type: boolean
canceled_at:
description: >-
@@ -40358,6 +40868,7 @@ components:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -43695,7 +44206,9 @@ components:
maxLength: 5000
type: string
status:
- description: The networking status of the reader.
+ description: >-
+ The networking status of the reader. We do not recommend using this
+ field in flows that may block taking payments.
enum:
- offline
- online
@@ -44387,6 +44900,54 @@ components:
title: three_d_secure_usage
type: object
x-expandableFields: []
+ thresholds_resource_alert_filter:
+ description: ''
+ properties:
+ customer:
+ anyOf:
+ - maxLength: 5000
+ type: string
+ - $ref: '#/components/schemas/customer'
+ description: Limit the scope of the alert to this customer ID
+ nullable: true
+ x-expansionResources:
+ oneOf:
+ - $ref: '#/components/schemas/customer'
+ title: ThresholdsResourceAlertFilter
+ type: object
+ x-expandableFields:
+ - customer
+ thresholds_resource_usage_threshold_config:
+ description: >-
+ The usage threshold alert configuration enables setting up alerts for
+ when a certain usage threshold on a specific meter is crossed.
+ properties:
+ gte:
+ description: The value at which this alert will trigger.
+ type: integer
+ meter:
+ anyOf:
+ - maxLength: 5000
+ type: string
+ - $ref: '#/components/schemas/billing.meter'
+ description: 'The [Billing Meter](/api/billing/meter) ID whose usage is monitored.'
+ x-expansionResources:
+ oneOf:
+ - $ref: '#/components/schemas/billing.meter'
+ recurrence:
+ description: Defines how the alert will behave.
+ enum:
+ - one_time
+ type: string
+ x-stripeBypassValidation: true
+ required:
+ - gte
+ - meter
+ - recurrence
+ title: ThresholdsResourceUsageThresholdConfig
+ type: object
+ x-expandableFields:
+ - meter
token:
description: >-
Tokenization is the process Stripe uses to collect sensitive card or
@@ -45308,6 +45869,7 @@ components:
- card_issuing
- deposit_insurance
- financial_addresses.aba
+ - financial_addresses.aba.forwarding
- inbound_transfers.ach
- intra_stripe_flows
- outbound_payments.ach
@@ -45373,6 +45935,7 @@ components:
- card_issuing
- deposit_insurance
- financial_addresses.aba
+ - financial_addresses.aba.forwarding
- inbound_transfers.ach
- intra_stripe_flows
- outbound_payments.ach
@@ -45398,6 +45961,7 @@ components:
- card_issuing
- deposit_insurance
- financial_addresses.aba
+ - financial_addresses.aba.forwarding
- inbound_transfers.ach
- intra_stripe_flows
- outbound_payments.ach
@@ -47033,11 +47597,19 @@ components:
treasury_outbound_payments_resource_us_domestic_wire_tracking_details:
description: ''
properties:
+ chips:
+ description: >-
+ CHIPS System Sequence Number (SSN) of the OutboundPayment for
+ payments sent over the `us_domestic_wire` network.
+ maxLength: 5000
+ nullable: true
+ type: string
imad:
description: >-
IMAD of the OutboundPayment for payments sent over the
`us_domestic_wire` network.
maxLength: 5000
+ nullable: true
type: string
omad:
description: >-
@@ -47046,8 +47618,6 @@ components:
maxLength: 5000
nullable: true
type: string
- required:
- - imad
title: TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails
type: object
x-expandableFields: []
@@ -47157,11 +47727,19 @@ components:
treasury_outbound_transfers_resource_us_domestic_wire_tracking_details:
description: ''
properties:
+ chips:
+ description: >-
+ CHIPS System Sequence Number (SSN) of the OutboundTransfer for
+ transfers sent over the `us_domestic_wire` network.
+ maxLength: 5000
+ nullable: true
+ type: string
imad:
description: >-
IMAD of the OutboundTransfer for transfers sent over the
`us_domestic_wire` network.
maxLength: 5000
+ nullable: true
type: string
omad:
description: >-
@@ -47170,8 +47748,6 @@ components:
maxLength: 5000
nullable: true
type: string
- required:
- - imad
title: TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails
type: object
x-expandableFields: []
@@ -49631,7 +50207,7 @@ paths:
balances cannot be deleted, which includes Standard accounts. Live-mode
accounts where your platform is liable for negative account balances,
which includes Custom and Express accounts, can be deleted when all balances are zero.
+ href="/api/balance/balance_object">balances are zero.
If you want to delete your own account, use the -
- Details on the legal guardian's acceptance of the required
- Stripe agreements.
+ Details on the legal guardian's or authorizer's acceptance
+ of the required Stripe agreements.
properties:
account:
properties:
@@ -52816,8 +53392,8 @@ paths:
properties:
additional_tos_acceptances:
description: >-
- Details on the legal guardian's acceptance of the required
- Stripe agreements.
+ Details on the legal guardian's or authorizer's acceptance
+ of the required Stripe agreements.
properties:
account:
properties:
@@ -53377,8 +53953,8 @@ paths:
properties:
additional_tos_acceptances:
description: >-
- Details on the legal guardian's acceptance of the required
- Stripe agreements.
+ Details on the legal guardian's or authorizer's acceptance
+ of the required Stripe agreements.
properties:
account:
properties:
@@ -53908,8 +54484,8 @@ paths:
properties:
additional_tos_acceptances:
description: >-
- Details on the legal guardian's acceptance of the required
- Stripe agreements.
+ Details on the legal guardian's or authorizer's acceptance
+ of the required Stripe agreements.
properties:
account:
properties:
@@ -55965,7 +56541,382 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/balance_transaction'
+ $ref: '#/components/schemas/balance_transaction'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ /v1/billing/alerts:
+ get:
+ description: Lists billing active and inactive alerts
+ operationId: GetBillingAlerts
+ parameters:
+ - description: Filter results to only include this type of alert.
+ in: query
+ name: alert_type
+ required: false
+ schema:
+ enum:
+ - usage_threshold
+ type: string
+ style: form
+ - description: >-
+ A cursor for use in pagination. `ending_before` is an object ID that
+ defines your place in the list. For instance, if you make a list
+ request and receive 100 objects, starting with `obj_bar`, your
+ subsequent call can include `ending_before=obj_bar` in order to
+ fetch the previous page of the list.
+ in: query
+ name: ending_before
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ - description: Specifies which fields in the response should be expanded.
+ explode: true
+ in: query
+ name: expand
+ required: false
+ schema:
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ style: deepObject
+ - description: >-
+ A limit on the number of objects to be returned. Limit can range
+ between 1 and 100, and the default is 10.
+ in: query
+ name: limit
+ required: false
+ schema:
+ type: integer
+ style: form
+ - description: Filter results to only include alerts with the given meter.
+ in: query
+ name: meter
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ - description: >-
+ A cursor for use in pagination. `starting_after` is an object ID
+ that defines your place in the list. For instance, if you make a
+ list request and receive 100 objects, ending with `obj_foo`, your
+ subsequent call can include `starting_after=obj_foo` in order to
+ fetch the next page of the list.
+ in: query
+ name: starting_after
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding: {}
+ schema:
+ additionalProperties: false
+ properties: {}
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ description: ''
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/billing.alert'
+ type: array
+ has_more:
+ description: >-
+ True if this list has another page of items after this one
+ that can be fetched.
+ type: boolean
+ object:
+ description: >-
+ String representing the object's type. Objects of the same
+ type share the same value. Always has the value `list`.
+ enum:
+ - list
+ type: string
+ url:
+ description: The URL where this list can be accessed.
+ maxLength: 5000
+ pattern: ^/v1/billing/alerts
+ type: string
+ required:
+ - data
+ - has_more
+ - object
+ - url
+ title: ThresholdsResourceAlertList
+ type: object
+ x-expandableFields:
+ - data
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ post:
+ description: Creates a billing alert
+ operationId: PostBillingAlerts
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ filter:
+ explode: true
+ style: deepObject
+ usage_threshold_config:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ alert_type:
+ description: The type of alert to create.
+ enum:
+ - usage_threshold
+ type: string
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ filter:
+ description: Filters to limit the scope of an alert.
+ properties:
+ customer:
+ maxLength: 5000
+ type: string
+ title: alert_filter
+ type: object
+ title:
+ description: The title of the alert.
+ maxLength: 256
+ type: string
+ usage_threshold_config:
+ description: The configuration of the usage threshold.
+ properties:
+ gte:
+ type: integer
+ meter:
+ maxLength: 5000
+ type: string
+ recurrence:
+ enum:
+ - one_time
+ type: string
+ x-stripeBypassValidation: true
+ required:
+ - gte
+ - recurrence
+ title: usage_threshold_config
+ type: object
+ required:
+ - alert_type
+ - title
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/billing.alert'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/billing/alerts/{id}':
+ get:
+ description: Retrieves a billing alert given an ID
+ operationId: GetBillingAlertsId
+ parameters:
+ - description: Specifies which fields in the response should be expanded.
+ explode: true
+ in: query
+ name: expand
+ required: false
+ schema:
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ style: deepObject
+ - in: path
+ name: id
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding: {}
+ schema:
+ additionalProperties: false
+ properties: {}
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/billing.alert'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/billing/alerts/{id}/activate':
+ post:
+ description: 'Reactivates this alert, allowing it to trigger again.
'
+ operationId: PostBillingAlertsIdActivate
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/billing.alert'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/billing/alerts/{id}/archive':
+ post:
+ description: >-
+ Archives this alert, removing it from the list view and APIs. This is
+ non-reversible.
+ operationId: PostBillingAlertsIdArchive
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/billing.alert'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/billing/alerts/{id}/deactivate':
+ post:
+ description: 'Deactivates this alert, preventing it from triggering.
'
+ operationId: PostBillingAlertsIdDeactivate
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/billing.alert'
description: Successful response.
default:
content:
@@ -57669,7 +58620,7 @@ paths:
schema:
type: string
style: form
- - description: Only return charges for this transfer group.
+ - description: 'Only return charges for this transfer group, limited to 100.'
in: query
name: transfer_group
required: false
@@ -58014,19 +58965,24 @@ paths:
x-stripeBypassValidation: true
statement_descriptor:
description: >-
- For card charges, use `statement_descriptor_suffix` instead.
- Otherwise, you can use this value as the complete
- description of a charge on your customers’ statements. Must
- contain at least one letter, maximum 22 characters.
+ For a non-card charge, text that appears on the customer's
+ statement as the [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors).
+ This value overrides the account's default statement
+ descriptor. For a card charge, this value is ignored unless
+ you don't specify a `statement_descriptor_suffix`, in which
+ case this value is used as the suffix.
maxLength: 22
type: string
statement_descriptor_suffix:
description: >-
- Provides information about the charge that customers see on
- their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the
- account to form the complete statement descriptor. Maximum
- 22 characters for the concatenated descriptor.
+ Provides information about a card charge. Concatenated to
+ the account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on
+ the customer's statement. If the account has no prefix
+ value, the suffix is concatenated to the account's statement
+ descriptor.
maxLength: 22
type: string
transfer_data:
@@ -58464,19 +59420,24 @@ paths:
type: string
statement_descriptor:
description: >-
- For card charges, use `statement_descriptor_suffix` instead.
- Otherwise, you can use this value as the complete
- description of a charge on your customers’ statements. Must
- contain at least one letter, maximum 22 characters.
+ For a non-card charge, text that appears on the customer's
+ statement as the [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors).
+ This value overrides the account's default statement
+ descriptor. For a card charge, this value is ignored unless
+ you don't specify a `statement_descriptor_suffix`, in which
+ case this value is used as the suffix.
maxLength: 22
type: string
statement_descriptor_suffix:
description: >-
- Provides information about the charge that customers see on
- their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the
- account to form the complete statement descriptor. Maximum
- 22 characters for the concatenated descriptor.
+ Provides information about a card charge. Concatenated to
+ the account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on
+ the customer's statement. If the account has no prefix
+ value, the suffix is concatenated to the account's statement
+ descriptor.
maxLength: 22
type: string
transfer_data:
@@ -59571,7 +60532,8 @@ paths:
description: >-
If set, Checkout displays a back button and customers will
be directed to this URL if they decide to cancel payment and
- return to your website.
+ return to your website. This parameter is not allowed if
+ ui_mode is `embedded`.
maxLength: 5000
type: string
client_reference_id:
@@ -68646,8 +69608,9 @@ paths:
type: integer
cancel_at_period_end:
description: >-
- Boolean indicating whether this subscription should cancel
- at the end of the current period.
+ Indicate whether this subscription should cancel at the end
+ of the current period (`current_period_end`). Defaults to
+ `false`.
type: boolean
collection_method:
description: >-
@@ -68892,7 +69855,8 @@ paths:
off_session:
description: >-
Indicates if a customer is on or off-session while an
- invoice payment is attempted.
+ invoice payment is attempted. Defaults to `false`
+ (on-session).
type: boolean
payment_behavior:
description: >-
@@ -69020,6 +69984,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -69206,7 +70171,7 @@ paths:
given subscription at the specified interval.
promotion_code:
description: >-
- The ID of a promotion code to apply to this subscription. A
+ The promotion code to apply to this subscription. A
promotion code applied to a subscription will only affect
invoices created for that particular subscription. This
field has been deprecated and will be removed in a future
@@ -69680,8 +70645,9 @@ paths:
will always cause a proration for that period.
cancel_at_period_end:
description: >-
- Boolean indicating whether this subscription should cancel
- at the end of the current period.
+ Indicate whether this subscription should cancel at the end
+ of the current period (`current_period_end`). Defaults to
+ `false`.
type: boolean
cancellation_details:
description: Details about why this subscription was cancelled
@@ -69959,7 +70925,8 @@ paths:
off_session:
description: >-
Indicates if a customer is on or off-session while an
- invoice payment is attempted.
+ invoice payment is attempted. Defaults to `false`
+ (on-session).
type: boolean
pause_collection:
anyOf:
@@ -70101,6 +71068,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -70289,7 +71257,9 @@ paths:
description: >-
The promotion code to apply to this subscription. A
promotion code applied to a subscription will only affect
- invoices created for that particular subscription.
+ invoices created for that particular subscription. This
+ field has been deprecated and will be removed in a future
+ API version. Use `discounts` instead.
maxLength: 5000
type: string
proration_behavior:
@@ -74229,6 +75199,13 @@ paths:
schema:
type: integer
style: form
+ - in: query
+ name: related_customer
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
- description: >-
A cursor for use in pagination. `starting_after` is an object ID
that defines your place in the list. For instance, if you make a
@@ -74410,6 +75387,10 @@ paths:
type: string
title: provided_details_param
type: object
+ related_customer:
+ description: Token referencing a Customer resource.
+ maxLength: 5000
+ type: string
return_url:
description: >-
The URL that the user will be redirected to upon completing
@@ -76065,9 +77046,8 @@ paths:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- - count
- - interval
- type
title: installment_plan
type: object
@@ -78481,10 +79461,10 @@ paths:
type: string
style: deepObject
- description: >-
- Boolean indicating whether this subscription should cancel at the
- end of the current period. This field has been deprecated and will
- be removed in a future API version. Use
- `subscription_details.cancel_at_period_end` instead.
+ Indicate whether this subscription should cancel at the end of the
+ current period (`current_period_end`). Defaults to `false`. This
+ field has been deprecated and will be removed in a future API
+ version. Use `subscription_details.cancel_at_period_end` instead.
in: query
name: subscription_cancel_at_period_end
required: false
@@ -79824,10 +80804,10 @@ paths:
type: string
style: deepObject
- description: >-
- Boolean indicating whether this subscription should cancel at the
- end of the current period. This field has been deprecated and will
- be removed in a future API version. Use
- `subscription_details.cancel_at_period_end` instead.
+ Indicate whether this subscription should cancel at the end of the
+ current period (`current_period_end`). Defaults to `false`. This
+ field has been deprecated and will be removed in a future API
+ version. Use `subscription_details.cancel_at_period_end` instead.
in: query
name: subscription_cancel_at_period_end
required: false
@@ -80766,9 +81746,8 @@ paths:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- - count
- - interval
- type
title: installment_plan
type: object
@@ -91337,11 +92316,16 @@ paths:
with this PaymentIntent.
- If present in combination with
- [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage),
- this PaymentIntent's payment method will be attached to the
+ If
+ [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage)
+ is set and this PaymentIntent's payment method is not
+ `card_present`, then the payment method attaches to the
Customer after the PaymentIntent has been confirmed and any
- required actions from the user are complete.
+ required actions from the user are complete. If the payment
+ method is `card_present` and isn't a digital wallet, then a
+ [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card is created and attached
+ to the Customer instead.
maxLength: 5000
type: string
description:
@@ -92079,6 +93063,10 @@ paths:
bacs_debit:
anyOf:
- properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
setup_future_usage:
enum:
- ''
@@ -92086,7 +93074,7 @@ paths:
- off_session
- on_session
type: string
- title: payment_method_options_param
+ title: payment_intent_payment_method_options_param
type: object
- enum:
- ''
@@ -92174,9 +93162,8 @@ paths:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- - count
- - interval
- type
title: installment_plan
type: object
@@ -92237,6 +93224,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -93074,21 +94062,26 @@ paths:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment)
- to the PaymentIntent's Customer, if present, after the
- PaymentIntent is confirmed and any required actions from the
- user are complete. If no Customer was provided, the payment
- method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach)
- to a Customer after the transaction completes.
+ If you provide a Customer with the PaymentIntent, you can
+ use this parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after
+ the PaymentIntent is confirmed and the customer completes
+ any required actions. If you don't provide a Customer, you
+ can still [attach](/api/payment_methods/attach) the payment
+ method to a Customer after the transaction completes.
- When processing card payments, Stripe also uses
- `setup_future_usage` to dynamically optimize your payment
- flow and comply with regional legislation and network rules,
- such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital
+ wallet, Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer
+ instead.
+
+
+ When processing card payments, Stripe uses
+ `setup_future_usage` to help you comply with regional
+ legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
enum:
- off_session
- on_session
@@ -93137,21 +94130,23 @@ paths:
type: object
statement_descriptor:
description: >-
- For card charges, use
- [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic).
- Otherwise, you can use this value as the complete
- description of a charge on your customers' statements. It
- must contain at least one letter and be 1–22 characters
- long.
+ Text that appears on the customer's statement as the
+ [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors)
+ for a non-card charge. This value overrides the account's
+ default statement descriptor. Setting this value for a card
+ charge returns an error. For card charges, set the
+ [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic)
+ instead.
maxLength: 22
type: string
statement_descriptor_suffix:
description: >-
- Provides information about a card payment that customers see
- on their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the
- account to form the complete statement descriptor. The
- concatenated descriptor must contain 1-22 characters.
+ Provides information about a card charge. Concatenated to
+ the account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on
+ the customer's statement.
maxLength: 22
type: string
transfer_data:
@@ -93497,11 +94492,16 @@ paths:
with this PaymentIntent.
- If present in combination with
- [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage),
- this PaymentIntent's payment method will be attached to the
+ If
+ [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage)
+ is set and this PaymentIntent's payment method is not
+ `card_present`, then the payment method attaches to the
Customer after the PaymentIntent has been confirmed and any
- required actions from the user are complete.
+ required actions from the user are complete. If the payment
+ method is `card_present` and isn't a digital wallet, then a
+ [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card is created and attached
+ to the Customer instead.
maxLength: 5000
type: string
description:
@@ -93537,7 +94537,8 @@ paths:
ID of the payment method (a PaymentMethod, Card, or
[compatible
Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility)
- object) to attach to this PaymentIntent.
+ object) to attach to this PaymentIntent. To unset this field
+ to null, pass in an empty string.
maxLength: 5000
type: string
payment_method_configuration:
@@ -94152,6 +95153,10 @@ paths:
bacs_debit:
anyOf:
- properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
setup_future_usage:
enum:
- ''
@@ -94159,7 +95164,7 @@ paths:
- off_session
- on_session
type: string
- title: payment_method_options_param
+ title: payment_intent_payment_method_options_param
type: object
- enum:
- ''
@@ -94247,9 +95252,8 @@ paths:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- - count
- - interval
- type
title: installment_plan
type: object
@@ -94310,6 +95314,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -95132,25 +96137,30 @@ paths:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment)
- to the PaymentIntent's Customer, if present, after the
- PaymentIntent is confirmed and any required actions from the
- user are complete. If no Customer was provided, the payment
- method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach)
- to a Customer after the transaction completes.
+ If you provide a Customer with the PaymentIntent, you can
+ use this parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after
+ the PaymentIntent is confirmed and the customer completes
+ any required actions. If you don't provide a Customer, you
+ can still [attach](/api/payment_methods/attach) the payment
+ method to a Customer after the transaction completes.
+
+
+ If the payment method is `card_present` and isn't a digital
+ wallet, Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer
+ instead.
- When processing card payments, Stripe also uses
- `setup_future_usage` to dynamically optimize your payment
- flow and comply with regional legislation and network rules,
- such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ When processing card payments, Stripe uses
+ `setup_future_usage` to help you comply with regional
+ legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
- If `setup_future_usage` is already set and you are
- performing a request using a publishable key, you may only
+ If you've already set `setup_future_usage` and you're
+ performing a request using a publishable key, you can only
update the value from `on_session` to `off_session`.
enum:
- ''
@@ -95205,21 +96215,23 @@ paths:
description: Shipping information for this PaymentIntent.
statement_descriptor:
description: >-
- For card charges, use
- [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic).
- Otherwise, you can use this value as the complete
- description of a charge on your customers' statements. It
- must contain at least one letter and be 1–22 characters
- long.
+ Text that appears on the customer's statement as the
+ [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors)
+ for a non-card charge. This value overrides the account's
+ default statement descriptor. Setting this value for a card
+ charge returns an error. For card charges, set the
+ [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic)
+ instead.
maxLength: 22
type: string
statement_descriptor_suffix:
description: >-
- Provides information about a card payment that customers see
- on their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the
- account to form the complete statement descriptor. Maximum
- 22 characters for the concatenated descriptor.
+ Provides information about a card charge. Concatenated to
+ the account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on
+ the customer's statement.
maxLength: 22
type: string
transfer_data:
@@ -95488,21 +96500,23 @@ paths:
value to `metadata`.
statement_descriptor:
description: >-
- For card charges, use
- [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic).
- Otherwise, you can use this value as the complete
- description of a charge on your customers' statements. It
- must contain at least one letter and be 1–22 characters
- long.
+ Text that appears on the customer's statement as the
+ [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors)
+ for a non-card charge. This value overrides the account's
+ default statement descriptor. Setting this value for a card
+ charge returns an error. For card charges, set the
+ [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic)
+ instead.
maxLength: 22
type: string
statement_descriptor_suffix:
description: >-
- Provides information about a card payment that customers see
- on their statements. Concatenated with the prefix (shortened
- descriptor) or statement descriptor that’s set on the
- account to form the complete statement descriptor. The
- concatenated descriptor must be 1-22 characters long.
+ Provides information about a card charge. Concatenated to
+ the account's [statement descriptor
+ prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+ to form the complete statement descriptor that appears on
+ the customer's statement.
maxLength: 22
type: string
transfer_data:
@@ -96372,6 +97386,10 @@ paths:
bacs_debit:
anyOf:
- properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
setup_future_usage:
enum:
- ''
@@ -96379,7 +97397,7 @@ paths:
- off_session
- on_session
type: string
- title: payment_method_options_param
+ title: payment_intent_payment_method_options_param
type: object
- enum:
- ''
@@ -96467,9 +97485,8 @@ paths:
enum:
- fixed_count
type: string
+ x-stripeBypassValidation: true
required:
- - count
- - interval
- type
title: installment_plan
type: object
@@ -96530,6 +97547,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -97374,25 +98392,30 @@ paths:
PaymentIntent's payment method.
- Providing this parameter will [attach the payment
- method](https://stripe.com/docs/payments/save-during-payment)
- to the PaymentIntent's Customer, if present, after the
- PaymentIntent is confirmed and any required actions from the
- user are complete. If no Customer was provided, the payment
- method can still be
- [attached](https://stripe.com/docs/api/payment_methods/attach)
- to a Customer after the transaction completes.
+ If you provide a Customer with the PaymentIntent, you can
+ use this parameter to [attach the payment
+ method](/payments/save-during-payment) to the Customer after
+ the PaymentIntent is confirmed and the customer completes
+ any required actions. If you don't provide a Customer, you
+ can still [attach](/api/payment_methods/attach) the payment
+ method to a Customer after the transaction completes.
- When processing card payments, Stripe also uses
- `setup_future_usage` to dynamically optimize your payment
- flow and comply with regional legislation and network rules,
- such as
- [SCA](https://stripe.com/docs/strong-customer-authentication).
+ If the payment method is `card_present` and isn't a digital
+ wallet, Stripe creates and attaches a
+ [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card)
+ payment method representing the card to the Customer
+ instead.
- If `setup_future_usage` is already set and you are
- performing a request using a publishable key, you may only
+ When processing card payments, Stripe uses
+ `setup_future_usage` to help you comply with regional
+ legislation and network rules, such as
+ [SCA](/strong-customer-authentication).
+
+
+ If you've already set `setup_future_usage` and you're
+ performing a request using a publishable key, you can only
update the value from `on_session` to `off_session`.
enum:
- ''
@@ -97588,12 +98611,14 @@ paths:
type: object
statement_descriptor:
description: >-
- For card charges, use
- [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic).
- Otherwise, you can use this value as the complete
- description of a charge on your customers' statements. It
- must contain at least one letter and be 1–22 characters
- long.
+ Text that appears on the customer's statement as the
+ [statement
+ descriptor](https://docs.stripe.com/get-started/account/statement-descriptors)
+ for a non-card charge. This value overrides the account's
+ default statement descriptor. Setting this value for a card
+ charge returns an error. For card charges, set the
+ [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic)
+ instead.
maxLength: 22
type: string
transfer_data:
@@ -108548,7 +109573,7 @@ paths:
description: >-
Download the PDF for a finalized quote. Explanation for special
handling can be found here
+ href="https://docs.stripe.com/quotes/overview#quote_pdf">here
operationId: GetQuotesQuotePdf
parameters:
- description: Specifies which fields in the response should be expanded.
@@ -112135,6 +113160,14 @@ paths:
properties: {}
title: setup_intent_payment_method_options_param
type: object
+ bacs_debit:
+ properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
+ title: setup_intent_payment_method_options_param
+ type: object
card:
properties:
mandate_options:
@@ -112192,6 +113225,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -112606,7 +113640,8 @@ paths:
payment_method:
description: >-
ID of the payment method (a PaymentMethod, Card, or saved
- Source object) to attach to this SetupIntent.
+ Source object) to attach to this SetupIntent. To unset this
+ field to null, pass in an empty string.
maxLength: 5000
type: string
payment_method_configuration:
@@ -113130,6 +114165,14 @@ paths:
properties: {}
title: setup_intent_payment_method_options_param
type: object
+ bacs_debit:
+ properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
+ title: setup_intent_payment_method_options_param
+ type: object
card:
properties:
mandate_options:
@@ -113187,6 +114230,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -114120,6 +115164,14 @@ paths:
properties: {}
title: setup_intent_payment_method_options_param
type: object
+ bacs_debit:
+ properties:
+ mandate_options:
+ properties: {}
+ title: payment_method_options_mandate_options_param
+ type: object
+ title: setup_intent_payment_method_options_param
+ type: object
card:
properties:
mandate_options:
@@ -114177,6 +115229,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -116553,7 +117606,8 @@ paths:
off_session:
description: >-
Indicates if a customer is on or off-session while an
- invoice payment is attempted.
+ invoice payment is attempted. Defaults to `false`
+ (on-session).
type: boolean
payment_behavior:
description: >-
@@ -118867,8 +119921,9 @@ paths:
type: integer
cancel_at_period_end:
description: >-
- Boolean indicating whether this subscription should cancel
- at the end of the current period.
+ Indicate whether this subscription should cancel at the end
+ of the current period (`current_period_end`). Defaults to
+ `false`.
type: boolean
collection_method:
description: >-
@@ -119125,7 +120180,8 @@ paths:
off_session:
description: >-
Indicates if a customer is on or off-session while an
- invoice payment is attempted.
+ invoice payment is attempted. Defaults to `false`
+ (on-session).
type: boolean
on_behalf_of:
anyOf:
@@ -119262,6 +120318,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -119448,7 +120505,7 @@ paths:
given subscription at the specified interval.
promotion_code:
description: >-
- The ID of a promotion code to apply to this subscription. A
+ The promotion code to apply to this subscription. A
promotion code applied to a subscription will only affect
invoices created for that particular subscription. This
field has been deprecated and will be removed in a future
@@ -120111,8 +121168,9 @@ paths:
will always cause a proration for that period.
cancel_at_period_end:
description: >-
- Boolean indicating whether this subscription should cancel
- at the end of the current period.
+ Indicate whether this subscription should cancel at the end
+ of the current period (`current_period_end`). Defaults to
+ `false`.
type: boolean
cancellation_details:
description: Details about why this subscription was cancelled
@@ -120402,7 +121460,8 @@ paths:
off_session:
description: >-
Indicates if a customer is on or off-session while an
- invoice payment is attempted.
+ invoice payment is attempted. Defaults to `false`
+ (on-session).
type: boolean
on_behalf_of:
anyOf:
@@ -120553,6 +121612,7 @@ paths:
- diners
- discover
- eftpos_au
+ - girocard
- interac
- jcb
- mastercard
@@ -120741,7 +121801,9 @@ paths:
description: >-
The promotion code to apply to this subscription. A
promotion code applied to a subscription will only affect
- invoices created for that particular subscription.
+ invoices created for that particular subscription. This
+ field has been deprecated and will be removed in a future
+ API version. Use `discounts` instead.
maxLength: 5000
type: string
proration_behavior:
@@ -121291,6 +122353,53 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
+ '/v1/tax/calculations/{calculation}':
+ get:
+ description: >-
+ Retrieves a Tax Calculation object, if the calculation
+ hasn’t expired.
+ operationId: GetTaxCalculationsCalculation
+ parameters:
+ - in: path
+ name: calculation
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ - description: Specifies which fields in the response should be expanded.
+ explode: true
+ in: query
+ name: expand
+ required: false
+ schema:
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ style: deepObject
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding: {}
+ schema:
+ additionalProperties: false
+ properties: {}
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/tax.calculation'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
'/v1/tax/calculations/{calculation}/line_items':
get:
description: >-
@@ -128346,6 +129455,86 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
+ /v1/test_helpers/issuing/settlements:
+ post:
+ description: Allows the user to create an Issuing settlement.
+ operationId: PostTestHelpersIssuingSettlements
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ bin:
+ description: >-
+ The Bank Identification Number reflecting this settlement
+ record.
+ maxLength: 5000
+ type: string
+ clearing_date:
+ description: >-
+ The date that the transactions are cleared and posted to
+ user's accounts.
+ type: integer
+ currency:
+ description: >-
+ Three-letter [ISO currency
+ code](https://www.iso.org/iso-4217-currency-codes.html), in
+ lowercase. Must be a [supported
+ currency](https://stripe.com/docs/currencies).
+ type: string
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ interchange_fees:
+ description: >-
+ The total interchange received as reimbursement for the
+ transactions.
+ type: integer
+ net_total:
+ description: The total net amount required to settle with the network.
+ type: integer
+ network_settlement_identifier:
+ description: >-
+ The Settlement Identification Number assigned by the
+ network.
+ maxLength: 5000
+ type: string
+ transaction_count:
+ description: >-
+ The total number of transactions reflected in this
+ settlement.
+ type: integer
+ transaction_volume:
+ description: The total transaction amount reflected in this settlement.
+ type: integer
+ required:
+ - bin
+ - clearing_date
+ - currency
+ - net_total
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.settlement'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
/v1/test_helpers/issuing/transactions/create_force_capture:
post:
description: >-
@@ -130160,6 +131349,9 @@ paths:
type: string
us_domestic_wire:
properties:
+ chips:
+ maxLength: 5000
+ type: string
imad:
maxLength: 5000
type: string
@@ -130401,6 +131593,9 @@ paths:
type: string
us_domestic_wire:
properties:
+ chips:
+ maxLength: 5000
+ type: string
imad:
maxLength: 5000
type: string
@@ -132301,8 +133496,10 @@ paths:
type: integer
currency:
description: >-
- 3-letter [ISO code for
- currency](https://stripe.com/docs/payouts).
+ Three-letter [ISO code for
+ currency](https://www.iso.org/iso-4217-currency-codes.html)
+ in lowercase. Must be a [supported
+ currency](https://docs.stripe.com/currencies).
type: string
description:
description: >-
@@ -136254,6 +137451,7 @@ paths:
- application_fee.refund.updated
- application_fee.refunded
- balance.available
+ - billing.alert.triggered
- billing_portal.configuration.created
- billing_portal.configuration.updated
- billing_portal.session.created
@@ -136669,6 +137867,7 @@ paths:
- application_fee.refund.updated
- application_fee.refunded
- balance.available
+ - billing.alert.triggered
- billing_portal.configuration.created
- billing_portal.configuration.updated
- billing_portal.session.created
diff --git a/integration-tests/typescript-angular/package.json b/integration-tests/typescript-angular/package.json
index 58e68371b..3cbbf0cc7 100644
--- a/integration-tests/typescript-angular/package.json
+++ b/integration-tests/typescript-angular/package.json
@@ -12,25 +12,25 @@
},
"private": true,
"dependencies": {
- "@angular/animations": "^18.1.2",
- "@angular/common": "^18.1.2",
- "@angular/compiler": "^18.1.2",
- "@angular/core": "^18.1.2",
- "@angular/forms": "^18.1.2",
- "@angular/platform-browser": "^18.1.2",
- "@angular/platform-browser-dynamic": "^18.1.2",
- "@angular/router": "^18.1.2",
+ "@angular/animations": "^18.2.0",
+ "@angular/common": "^18.2.0",
+ "@angular/compiler": "^18.2.0",
+ "@angular/core": "^18.2.0",
+ "@angular/forms": "^18.2.0",
+ "@angular/platform-browser": "^18.2.0",
+ "@angular/platform-browser-dynamic": "^18.2.0",
+ "@angular/router": "^18.2.0",
"rxjs": "~7.8.1",
"tslib": "^2.6.3",
- "zone.js": "~0.14.8"
+ "zone.js": "~0.14.10"
},
"devDependencies": {
- "@angular-devkit/build-angular": "^18.1.2",
- "@angular/cli": "^18.1.2",
- "@angular/compiler-cli": "^18.1.2",
+ "@angular-devkit/build-angular": "^18.2.0",
+ "@angular/cli": "^18.2.0",
+ "@angular/compiler-cli": "^18.2.0",
"@types/jasmine": "~5.1.4",
"jasmine-core": "~5.2.0",
- "karma": "~6.4.3",
+ "karma": "~6.4.4",
"karma-chrome-launcher": "~3.2.0",
"karma-coverage": "~2.2.1",
"karma-jasmine": "~5.1.0",
diff --git a/integration-tests/typescript-angular/src/generated/api.github.com.yaml/client.service.ts b/integration-tests/typescript-angular/src/generated/api.github.com.yaml/client.service.ts
index 53cdda1b6..a7808a3f0 100644
--- a/integration-tests/typescript-angular/src/generated/api.github.com.yaml/client.service.ts
+++ b/integration-tests/typescript-angular/src/generated/api.github.com.yaml/client.service.ts
@@ -73,6 +73,7 @@ import {
t_code_scanning_variant_analysis_repo_task,
t_code_search_result_item,
t_code_security_configuration,
+ t_code_security_configuration_for_repository,
t_code_security_configuration_repositories,
t_code_security_default_configurations,
t_codeowners_errors,
@@ -105,6 +106,7 @@ import {
t_copilot_seat_details,
t_copilot_usage_metrics,
t_custom_deployment_rule_app,
+ t_custom_property,
t_custom_property_value,
t_dependabot_alert,
t_dependabot_alert_with_repository,
@@ -174,7 +176,6 @@ import {
t_minimal_repository,
t_oidc_custom_sub,
t_oidc_custom_sub_repo,
- t_org_custom_property,
t_org_hook,
t_org_membership,
t_org_repo_custom_property_values,
@@ -255,6 +256,9 @@ import {
t_secret_scanning_alert_resolution_comment,
t_secret_scanning_alert_state,
t_secret_scanning_location,
+ t_secret_scanning_push_protection_bypass,
+ t_secret_scanning_push_protection_bypass_placeholder_id,
+ t_secret_scanning_push_protection_bypass_reason,
t_security_advisory_ecosystems,
t_selected_actions,
t_short_blob,
@@ -1248,6 +1252,40 @@ export class ApiClient {
)
}
+ copilotUsageMetricsForEnterpriseTeam(p: {
+ enterprise: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 401 })
+ | (HttpResponse & { status: 403 })
+ | (HttpResponse & { status: 404 })
+ | (HttpResponse & { status: 500 })
+ | HttpResponse
+ > {
+ const params = this._queryParams({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath +
+ `/enterprises/${p["enterprise"]}/team/${p["teamSlug"]}/copilot/usage`,
+ {
+ params,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
activityListPublicEvents(
p: {
perPage?: number
@@ -3699,6 +3737,10 @@ export class ApiClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description: string
enforcement?: "enforced" | "unenforced"
name: string
@@ -3805,6 +3847,10 @@ export class ApiClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
name?: string
@@ -6550,7 +6596,7 @@ export class ApiClient {
orgsGetAllCustomProperties(p: {
org: string
}): Observable<
- | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 200 })
| (HttpResponse & { status: 403 })
| (HttpResponse & { status: 404 })
| HttpResponse
@@ -6568,10 +6614,10 @@ export class ApiClient {
orgsCreateOrUpdateCustomProperties(p: {
org: string
requestBody: {
- properties: t_org_custom_property[]
+ properties: t_custom_property[]
}
}): Observable<
- | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 200 })
| (HttpResponse & { status: 403 })
| (HttpResponse & { status: 404 })
| HttpResponse
@@ -6595,7 +6641,7 @@ export class ApiClient {
org: string
customPropertyName: string
}): Observable<
- | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 200 })
| (HttpResponse & { status: 403 })
| (HttpResponse & { status: 404 })
| HttpResponse
@@ -6622,7 +6668,7 @@ export class ApiClient {
value_type: "string" | "single_select" | "multi_select" | "true_false"
}
}): Observable<
- | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 200 })
| (HttpResponse & { status: 403 })
| (HttpResponse & { status: 404 })
| HttpResponse
@@ -7240,6 +7286,40 @@ export class ApiClient {
)
}
+ copilotUsageMetricsForTeam(p: {
+ org: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 401 })
+ | (HttpResponse & { status: 403 })
+ | (HttpResponse & { status: 404 })
+ | (HttpResponse & { status: 500 })
+ | HttpResponse
+ > {
+ const params = this._queryParams({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath +
+ `/orgs/${p["org"]}/team/${p["teamSlug"]}/copilot/usage`,
+ {
+ params,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
teamsList(p: {
org: string
perPage?: number
@@ -12607,6 +12687,30 @@ export class ApiClient {
)
}
+ codeSecurityGetConfigurationForRepository(p: {
+ owner: string
+ repo: string
+ }): Observable<
+ | (HttpResponse & {
+ status: 200
+ })
+ | (HttpResponse & { status: 204 })
+ | (HttpResponse & { status: 304 })
+ | (HttpResponse & { status: 403 })
+ | (HttpResponse & { status: 404 })
+ | HttpResponse
+ > {
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath +
+ `/repos/${p["owner"]}/${p["repo"]}/code-security-configuration`,
+ {
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
reposCodeownersErrors(p: {
owner: string
repo: string
@@ -18811,6 +18915,7 @@ export class ApiClient {
ref?: string
}): Observable<
| (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 304 })
| (HttpResponse & { status: 404 })
| (HttpResponse & { status: 422 })
| HttpResponse
@@ -19626,6 +19731,41 @@ export class ApiClient {
)
}
+ secretScanningCreatePushProtectionBypass(p: {
+ owner: string
+ repo: string
+ requestBody: {
+ placeholder_id: t_secret_scanning_push_protection_bypass_placeholder_id
+ reason: t_secret_scanning_push_protection_bypass_reason
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: 403 })
+ | (HttpResponse & { status: 404 })
+ | (HttpResponse & { status: 422 })
+ | (HttpResponse<{
+ code?: string
+ documentation_url?: string
+ message?: string
+ }> & { status: 503 })
+ | HttpResponse
+ > {
+ const headers = this._headers({ "Content-Type": "application/json" })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath +
+ `/repos/${p["owner"]}/${p["repo"]}/secret-scanning/push-protection-bypasses`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
securityAdvisoriesListRepositoryAdvisories(p: {
owner: string
repo: string
diff --git a/integration-tests/typescript-angular/src/generated/api.github.com.yaml/models.ts b/integration-tests/typescript-angular/src/generated/api.github.com.yaml/models.ts
index 315b6b967..1583cda45 100644
--- a/integration-tests/typescript-angular/src/generated/api.github.com.yaml/models.ts
+++ b/integration-tests/typescript-angular/src/generated/api.github.com.yaml/models.ts
@@ -176,6 +176,7 @@ export type t_api_overview = {
actions?: string[]
actions_macos?: string[]
api?: string[]
+ copilot?: string[]
dependabot?: string[]
domains?: {
actions?: string[]
@@ -1074,6 +1075,10 @@ export type t_code_security_configuration = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
html_url?: string
@@ -1088,6 +1093,19 @@ export type t_code_security_configuration = {
url?: string
}
+export type t_code_security_configuration_for_repository = {
+ configuration?: t_code_security_configuration
+ status?:
+ | "attached"
+ | "attaching"
+ | "detached"
+ | "removed"
+ | "enforced"
+ | "failed"
+ | "updating"
+ | "removed_by_enterprise"
+}
+
export type t_code_security_configuration_repositories = {
repository?: t_simple_repository
status?:
@@ -1622,7 +1640,7 @@ export type t_copilot_seat_breakdown = {
}
export type t_copilot_seat_details = {
- assignee: t_simple_user | t_team | t_organization
+ assignee: t_simple_user
assigning_team?: t_team | t_enterprise_team | null
created_at: string
last_activity_at?: string | null
@@ -1663,6 +1681,17 @@ export type t_custom_deployment_rule_app = {
slug: string
}
+export type t_custom_property = {
+ allowed_values?: string[] | null
+ default_value?: string | string[] | null
+ description?: string | null
+ property_name: string
+ required?: boolean
+ url?: string
+ value_type: "string" | "single_select" | "multi_select" | "true_false"
+ values_editable_by?: "org_actors" | "org_and_repo_actors" | null
+}
+
export type t_custom_property_value = {
property_name: string
value: string | string[] | null
@@ -3833,16 +3862,6 @@ export type t_oidc_custom_sub_repo = {
use_default: boolean
}
-export type t_org_custom_property = {
- allowed_values?: string[] | null
- default_value?: string | string[] | null
- description?: string | null
- property_name: string
- required?: boolean
- value_type: "string" | "single_select" | "multi_select" | "true_false"
- values_editable_by?: "org_actors" | "org_and_repo_actors" | null
-}
-
export type t_org_hook = {
active: boolean
config: {
@@ -3889,44 +3908,6 @@ export type t_org_ruleset_conditions =
| (t_repository_ruleset_conditions &
t_repository_ruleset_conditions_repository_property_target)
-export type t_organization = {
- avatar_url: string
- blog?: string
- company?: string
- created_at: string
- description: string | null
- email?: string
- events_url: string
- followers: number
- following: number
- has_organization_projects: boolean
- has_repository_projects: boolean
- hooks_url: string
- html_url: string
- id: number
- is_verified?: boolean
- issues_url: string
- location?: string
- login: string
- members_url: string
- name?: string
- node_id: string
- plan?: {
- filled_seats?: number
- name?: string
- private_repos?: number
- seats?: number
- space?: number
- }
- public_gists: number
- public_members_url: string
- public_repos: number
- repos_url: string
- type: string
- updated_at: string
- url: string
-}
-
export type t_organization_actions_secret = {
created_at: string
name: string
@@ -5879,6 +5860,7 @@ export type t_repository_ruleset_bypass_actor = {
| "RepositoryRole"
| "Team"
| "DeployKey"
+ | "EnterpriseTeam"
bypass_mode: "always" | "pull_request"
}
@@ -6270,6 +6252,19 @@ export type t_secret_scanning_location_wiki_commit = {
start_line: number
}
+export type t_secret_scanning_push_protection_bypass = {
+ expire_at?: string | null
+ reason?: t_secret_scanning_push_protection_bypass_reason
+ token_type?: string
+}
+
+export type t_secret_scanning_push_protection_bypass_placeholder_id = string
+
+export type t_secret_scanning_push_protection_bypass_reason =
+ | "false_positive"
+ | "used_in_tests"
+ | "will_fix_later"
+
export type t_security_advisory_credit_types =
| "analyst"
| "finder"
diff --git a/integration-tests/typescript-angular/src/generated/stripe.yaml/client.service.ts b/integration-tests/typescript-angular/src/generated/stripe.yaml/client.service.ts
index 02c1bcafc..e447018a8 100644
--- a/integration-tests/typescript-angular/src/generated/stripe.yaml/client.service.ts
+++ b/integration-tests/typescript-angular/src/generated/stripe.yaml/client.service.ts
@@ -13,6 +13,7 @@ import {
t_balance,
t_balance_transaction,
t_bank_account,
+ t_billing_alert,
t_billing_meter,
t_billing_meter_event,
t_billing_meter_event_adjustment,
@@ -3397,6 +3398,197 @@ export class ApiClient {
)
}
+ getBillingAlerts(
+ p: {
+ alertType?: "usage_threshold"
+ endingBefore?: string
+ expand?: string[]
+ limit?: number
+ meter?: string
+ startingAfter?: string
+ requestBody?: EmptyObject
+ } = {},
+ ): Observable<
+ | (HttpResponse<{
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }> & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const params = this._queryParams({
+ alert_type: p["alertType"],
+ ending_before: p["endingBefore"],
+ expand: p["expand"],
+ limit: p["limit"],
+ meter: p["meter"],
+ starting_after: p["startingAfter"],
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath + `/v1/billing/alerts`,
+ {
+ params,
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
+ postBillingAlerts(p: {
+ requestBody: {
+ alert_type: "usage_threshold"
+ expand?: string[]
+ filter?: {
+ customer?: string
+ }
+ title: string
+ usage_threshold_config?: {
+ gte: number
+ meter?: string
+ recurrence: "one_time"
+ }
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath + `/v1/billing/alerts`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
+ getBillingAlertsId(p: {
+ expand?: string[]
+ id: string
+ requestBody?: EmptyObject
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const params = this._queryParams({ expand: p["expand"] })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath + `/v1/billing/alerts/${p["id"]}`,
+ {
+ params,
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
+ postBillingAlertsIdActivate(p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath + `/v1/billing/alerts/${p["id"]}/activate`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
+ postBillingAlertsIdArchive(p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath + `/v1/billing/alerts/${p["id"]}/archive`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
+ postBillingAlertsIdDeactivate(p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath + `/v1/billing/alerts/${p["id"]}/deactivate`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
postBillingMeterEventAdjustments(p: {
requestBody: {
cancel?: {
@@ -8566,6 +8758,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -8898,6 +9091,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10777,6 +10971,7 @@ export class ApiClient {
endingBefore?: string
expand?: string[]
limit?: number
+ relatedCustomer?: string
startingAfter?: string
status?: "canceled" | "processing" | "requires_input" | "verified"
requestBody?: EmptyObject
@@ -10800,6 +10995,7 @@ export class ApiClient {
ending_before: p["endingBefore"],
expand: p["expand"],
limit: p["limit"],
+ related_customer: p["relatedCustomer"],
starting_after: p["startingAfter"],
status: p["status"],
})
@@ -10840,6 +11036,7 @@ export class ApiClient {
email?: string
phone?: string
}
+ related_customer?: string
return_url?: string
type?: "document" | "id_number"
verification_flow?: string
@@ -11377,8 +11574,8 @@ export class ApiClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -12910,8 +13107,8 @@ export class ApiClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19359,6 +19556,7 @@ export class ApiClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -19388,8 +19586,8 @@ export class ApiClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19411,6 +19609,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -20139,6 +20338,7 @@ export class ApiClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -20168,8 +20368,8 @@ export class ApiClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -20191,6 +20391,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -20959,6 +21160,7 @@ export class ApiClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -20988,8 +21190,8 @@ export class ApiClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -21011,6 +21213,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27353,6 +27556,9 @@ export class ApiClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27372,6 +27578,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27744,6 +27951,9 @@ export class ApiClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27763,6 +27973,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -28137,6 +28348,9 @@ export class ApiClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -28156,6 +28370,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29926,6 +30141,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -30310,6 +30526,7 @@ export class ApiClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -30629,6 +30846,34 @@ export class ApiClient {
)
}
+ getTaxCalculationsCalculation(p: {
+ calculation: string
+ expand?: string[]
+ requestBody?: EmptyObject
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const params = this._queryParams({ expand: p["expand"] })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "GET",
+ this.config.basePath + `/v1/tax/calculations/${p["calculation"]}`,
+ {
+ params,
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
getTaxCalculationsCalculationLineItems(p: {
calculation: string
endingBefore?: string
@@ -33868,6 +34113,40 @@ export class ApiClient {
)
}
+ postTestHelpersIssuingSettlements(p: {
+ requestBody: {
+ bin: string
+ clearing_date: number
+ currency: string
+ expand?: string[]
+ interchange_fees?: number
+ net_total: number
+ network_settlement_identifier?: string
+ transaction_count?: number
+ transaction_volume?: number
+ }
+ }): Observable<
+ | (HttpResponse & { status: 200 })
+ | (HttpResponse & { status: StatusCode })
+ | HttpResponse
+ > {
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = p["requestBody"]
+
+ return this.httpClient.request(
+ "POST",
+ this.config.basePath + `/v1/test_helpers/issuing/settlements`,
+ {
+ headers,
+ body,
+ observe: "response",
+ reportProgress: false,
+ },
+ )
+ }
+
postTestHelpersIssuingTransactionsCreateForceCapture(p: {
requestBody: {
amount: number
@@ -35044,6 +35323,7 @@ export class ApiClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -35179,6 +35459,7 @@ export class ApiClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -37710,6 +37991,7 @@ export class ApiClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
@@ -38037,6 +38319,7 @@ export class ApiClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
diff --git a/integration-tests/typescript-angular/src/generated/stripe.yaml/models.ts b/integration-tests/typescript-angular/src/generated/stripe.yaml/models.ts
index b96011951..d07b8abc1 100644
--- a/integration-tests/typescript-angular/src/generated/stripe.yaml/models.ts
+++ b/integration-tests/typescript-angular/src/generated/stripe.yaml/models.ts
@@ -690,6 +690,17 @@ export type t_bank_connections_resource_transaction_resource_status_transitions
void_at?: number | null
}
+export type t_billing_alert = {
+ alert_type: "usage_threshold"
+ filter?: t_thresholds_resource_alert_filter | null
+ id: string
+ livemode: boolean
+ object: "billing.alert"
+ status?: "active" | "archived" | "inactive" | null
+ title: string
+ usage_threshold_config?: t_thresholds_resource_usage_threshold_config | null
+}
+
export type t_billing_meter = {
created: number
customer_mapping: t_billing_meter_resource_customer_mapping_settings
@@ -2864,6 +2875,7 @@ export type t_identity_verification_session = {
options?: t_gelato_verification_session_options | null
provided_details?: t_gelato_provided_details | null
redaction?: t_verification_session_redaction | null
+ related_customer?: string | null
status: "canceled" | "processing" | "requires_input" | "verified"
type: "document" | "id_number" | "verification_flow"
url?: string | null
@@ -3500,7 +3512,7 @@ export type t_issuing_settlement = {
[key: string]: string | undefined
}
net_total: number
- network: "visa"
+ network: "maestro" | "visa"
network_fees: number
network_settlement_identifier: string
object: "issuing.settlement"
@@ -6347,6 +6359,11 @@ export type t_payment_flows_private_payment_methods_card_details_api_resource_mu
status: "available" | "unavailable"
}
+export type t_payment_flows_private_payment_methods_card_present_common_wallet =
+ {
+ type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"
+ }
+
export type t_payment_flows_private_payment_methods_klarna_dob = {
day?: number | null
month?: number | null
@@ -6622,7 +6639,7 @@ export type t_payment_intent_payment_method_options = {
| t_payment_intent_payment_method_options_au_becs_debit
| t_payment_intent_type_specific_payment_method_options_client
bacs_debit?:
- | t_payment_method_options_bacs_debit
+ | t_payment_intent_payment_method_options_bacs_debit
| t_payment_intent_type_specific_payment_method_options_client
bancontact?:
| t_payment_method_options_bancontact
@@ -6732,6 +6749,11 @@ export type t_payment_intent_payment_method_options_au_becs_debit = {
setup_future_usage?: "none" | "off_session" | "on_session"
}
+export type t_payment_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_payment_intent_payment_method_options_mandate_options_bacs_debit
+ setup_future_usage?: "none" | "off_session" | "on_session"
+}
+
export type t_payment_intent_payment_method_options_blik = {
setup_future_usage?: "none"
}
@@ -6746,6 +6768,7 @@ export type t_payment_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -6781,6 +6804,9 @@ export type t_payment_intent_payment_method_options_mandate_options_acss_debit =
transaction_type?: "business" | "personal" | null
}
+export type t_payment_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_payment_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -7460,6 +7486,7 @@ export type t_payment_method_card_present = {
issuer?: string | null
last4?: string | null
networks?: t_payment_method_card_present_networks | null
+ offline?: t_payment_method_details_card_present_offline | null
preferred_locales?: string[] | null
read_method?:
| "contact_emv"
@@ -7468,6 +7495,7 @@ export type t_payment_method_card_present = {
| "magnetic_stripe_fallback"
| "magnetic_stripe_track2"
| null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_card_present_networks = {
@@ -7710,6 +7738,7 @@ export type t_payment_method_details_boleto = {
export type t_payment_method_details_card = {
amount_authorized?: number | null
+ authorization_code?: string | null
brand?: string | null
capture_before?: number
checks?: t_payment_method_details_card_checks | null
@@ -7781,10 +7810,12 @@ export type t_payment_method_details_card_present = {
| "magnetic_stripe_track2"
| null
receipt?: t_payment_method_details_card_present_receipt | null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_details_card_present_offline = {
stored_at?: number | null
+ type?: "deferred" | null
}
export type t_payment_method_details_card_present_receipt = {
@@ -8322,10 +8353,6 @@ export type t_payment_method_options_amazon_pay = {
setup_future_usage?: "none" | "off_session"
}
-export type t_payment_method_options_bacs_debit = {
- setup_future_usage?: "none" | "off_session" | "on_session"
-}
-
export type t_payment_method_options_bancontact = {
preferred_language: "de" | "en" | "fr" | "nl"
setup_future_usage?: "none" | "off_session"
@@ -9169,7 +9196,7 @@ export type t_person_additional_tos_acceptance = {
}
export type t_person_additional_tos_acceptances = {
- account: t_person_additional_tos_acceptance
+ account?: t_person_additional_tos_acceptance | null
}
export type t_person_future_requirements = {
@@ -10074,6 +10101,9 @@ export type t_setup_intent_payment_method_options = {
amazon_pay?:
| t_setup_intent_payment_method_options_amazon_pay
| t_setup_intent_type_specific_payment_method_options_client
+ bacs_debit?:
+ | t_setup_intent_payment_method_options_bacs_debit
+ | t_setup_intent_type_specific_payment_method_options_client
card?:
| t_setup_intent_payment_method_options_card
| t_setup_intent_type_specific_payment_method_options_client
@@ -10102,6 +10132,10 @@ export type t_setup_intent_payment_method_options_acss_debit = {
export type t_setup_intent_payment_method_options_amazon_pay = EmptyObject
+export type t_setup_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_setup_intent_payment_method_options_mandate_options_bacs_debit
+}
+
export type t_setup_intent_payment_method_options_card = {
mandate_options?: t_setup_intent_payment_method_options_card_mandate_options | null
network?:
@@ -10110,6 +10144,7 @@ export type t_setup_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10145,6 +10180,9 @@ export type t_setup_intent_payment_method_options_mandate_options_acss_debit = {
transaction_type?: "business" | "personal" | null
}
+export type t_setup_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_setup_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -10740,6 +10778,7 @@ export type t_subscription_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -11774,6 +11813,16 @@ export type t_three_d_secure_usage = {
supported: boolean
}
+export type t_thresholds_resource_alert_filter = {
+ customer?: string | t_customer | null
+}
+
+export type t_thresholds_resource_usage_threshold_config = {
+ gte: number
+ meter: string | t_billing_meter
+ recurrence: "one_time"
+}
+
export type t_token = {
bank_account?: t_bank_account
card?: t_card
@@ -11919,6 +11968,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11942,6 +11992,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11955,6 +12006,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -12343,7 +12395,8 @@ export type t_treasury_outbound_payments_resource_returned_status = {
export type t_treasury_outbound_payments_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
@@ -12382,7 +12435,8 @@ export type t_treasury_outbound_transfers_resource_status_transitions = {
export type t_treasury_outbound_transfers_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
diff --git a/integration-tests/typescript-axios/package.json b/integration-tests/typescript-axios/package.json
index 922dd2477..9e45d2b63 100644
--- a/integration-tests/typescript-axios/package.json
+++ b/integration-tests/typescript-axios/package.json
@@ -11,11 +11,11 @@
},
"dependencies": {
"@nahkies/typescript-axios-runtime": "*",
- "axios": "^1.7.2",
+ "axios": "^1.7.4",
"dotenv": "^16.4.5"
},
"devDependencies": {
- "@types/node": "^22.0.0",
+ "@types/node": "^22.4.0",
"typescript": "~5.5.4"
}
}
diff --git a/integration-tests/typescript-axios/src/generated/api.github.com.yaml/client.ts b/integration-tests/typescript-axios/src/generated/api.github.com.yaml/client.ts
index ca73a482e..a6463a4db 100644
--- a/integration-tests/typescript-axios/src/generated/api.github.com.yaml/client.ts
+++ b/integration-tests/typescript-axios/src/generated/api.github.com.yaml/client.ts
@@ -72,6 +72,7 @@ import {
t_code_scanning_variant_analysis_repo_task,
t_code_search_result_item,
t_code_security_configuration,
+ t_code_security_configuration_for_repository,
t_code_security_configuration_repositories,
t_code_security_default_configurations,
t_codeowners_errors,
@@ -104,6 +105,7 @@ import {
t_copilot_seat_details,
t_copilot_usage_metrics,
t_custom_deployment_rule_app,
+ t_custom_property,
t_custom_property_value,
t_dependabot_alert,
t_dependabot_alert_with_repository,
@@ -173,7 +175,6 @@ import {
t_minimal_repository,
t_oidc_custom_sub,
t_oidc_custom_sub_repo,
- t_org_custom_property,
t_org_hook,
t_org_membership,
t_org_repo_custom_property_values,
@@ -253,6 +254,9 @@ import {
t_secret_scanning_alert_resolution_comment,
t_secret_scanning_alert_state,
t_secret_scanning_location,
+ t_secret_scanning_push_protection_bypass,
+ t_secret_scanning_push_protection_bypass_placeholder_id,
+ t_secret_scanning_push_protection_bypass_reason,
t_security_advisory_ecosystems,
t_selected_actions,
t_short_blob,
@@ -1106,6 +1110,34 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async copilotUsageMetricsForEnterpriseTeam(
+ p: {
+ enterprise: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/enterprises/${p["enterprise"]}/team/${p["teamSlug"]}/copilot/usage`
+ const query = this._query({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this._request({
+ url: url + query,
+ method: "GET",
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async activityListPublicEvents(
p: {
perPage?: number
@@ -3355,6 +3387,10 @@ export class ApiClient extends AbstractAxiosClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description: string
enforcement?: "enforced" | "unenforced"
name: string
@@ -3450,6 +3486,10 @@ export class ApiClient extends AbstractAxiosClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
name?: string
@@ -5983,7 +6023,7 @@ export class ApiClient extends AbstractAxiosClient {
},
timeout?: number,
opts?: AxiosRequestConfig,
- ): Promise> {
+ ): Promise> {
const url = `/orgs/${p["org"]}/properties/schema`
return this._request({
@@ -5998,12 +6038,12 @@ export class ApiClient extends AbstractAxiosClient {
p: {
org: string
requestBody: {
- properties: t_org_custom_property[]
+ properties: t_custom_property[]
}
},
timeout?: number,
opts?: AxiosRequestConfig,
- ): Promise> {
+ ): Promise> {
const url = `/orgs/${p["org"]}/properties/schema`
const headers = this._headers({ "Content-Type": "application/json" })
const body = JSON.stringify(p.requestBody)
@@ -6025,7 +6065,7 @@ export class ApiClient extends AbstractAxiosClient {
},
timeout?: number,
opts?: AxiosRequestConfig,
- ): Promise> {
+ ): Promise> {
const url = `/orgs/${p["org"]}/properties/schema/${p["customPropertyName"]}`
return this._request({
@@ -6050,7 +6090,7 @@ export class ApiClient extends AbstractAxiosClient {
},
timeout?: number,
opts?: AxiosRequestConfig,
- ): Promise> {
+ ): Promise> {
const url = `/orgs/${p["org"]}/properties/schema/${p["customPropertyName"]}`
const headers = this._headers({ "Content-Type": "application/json" })
const body = JSON.stringify(p.requestBody)
@@ -6626,6 +6666,34 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async copilotUsageMetricsForTeam(
+ p: {
+ org: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/orgs/${p["org"]}/team/${p["teamSlug"]}/copilot/usage`
+ const query = this._query({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this._request({
+ url: url + query,
+ method: "GET",
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async teamsList(
p: {
org: string
@@ -11594,6 +11662,27 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async codeSecurityGetConfigurationForRepository(
+ p: {
+ owner: string
+ repo: string
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise<
+ | AxiosResponse
+ | AxiosResponse
+ > {
+ const url = `/repos/${p["owner"]}/${p["repo"]}/code-security-configuration`
+
+ return this._request({
+ url: url,
+ method: "GET",
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async reposCodeownersErrors(
p: {
owner: string
@@ -17954,6 +18043,32 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async secretScanningCreatePushProtectionBypass(
+ p: {
+ owner: string
+ repo: string
+ requestBody: {
+ placeholder_id: t_secret_scanning_push_protection_bypass_placeholder_id
+ reason: t_secret_scanning_push_protection_bypass_reason
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/repos/${p["owner"]}/${p["repo"]}/secret-scanning/push-protection-bypasses`
+ const headers = this._headers({ "Content-Type": "application/json" })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async securityAdvisoriesListRepositoryAdvisories(
p: {
owner: string
diff --git a/integration-tests/typescript-axios/src/generated/api.github.com.yaml/models.ts b/integration-tests/typescript-axios/src/generated/api.github.com.yaml/models.ts
index 315b6b967..1583cda45 100644
--- a/integration-tests/typescript-axios/src/generated/api.github.com.yaml/models.ts
+++ b/integration-tests/typescript-axios/src/generated/api.github.com.yaml/models.ts
@@ -176,6 +176,7 @@ export type t_api_overview = {
actions?: string[]
actions_macos?: string[]
api?: string[]
+ copilot?: string[]
dependabot?: string[]
domains?: {
actions?: string[]
@@ -1074,6 +1075,10 @@ export type t_code_security_configuration = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
html_url?: string
@@ -1088,6 +1093,19 @@ export type t_code_security_configuration = {
url?: string
}
+export type t_code_security_configuration_for_repository = {
+ configuration?: t_code_security_configuration
+ status?:
+ | "attached"
+ | "attaching"
+ | "detached"
+ | "removed"
+ | "enforced"
+ | "failed"
+ | "updating"
+ | "removed_by_enterprise"
+}
+
export type t_code_security_configuration_repositories = {
repository?: t_simple_repository
status?:
@@ -1622,7 +1640,7 @@ export type t_copilot_seat_breakdown = {
}
export type t_copilot_seat_details = {
- assignee: t_simple_user | t_team | t_organization
+ assignee: t_simple_user
assigning_team?: t_team | t_enterprise_team | null
created_at: string
last_activity_at?: string | null
@@ -1663,6 +1681,17 @@ export type t_custom_deployment_rule_app = {
slug: string
}
+export type t_custom_property = {
+ allowed_values?: string[] | null
+ default_value?: string | string[] | null
+ description?: string | null
+ property_name: string
+ required?: boolean
+ url?: string
+ value_type: "string" | "single_select" | "multi_select" | "true_false"
+ values_editable_by?: "org_actors" | "org_and_repo_actors" | null
+}
+
export type t_custom_property_value = {
property_name: string
value: string | string[] | null
@@ -3833,16 +3862,6 @@ export type t_oidc_custom_sub_repo = {
use_default: boolean
}
-export type t_org_custom_property = {
- allowed_values?: string[] | null
- default_value?: string | string[] | null
- description?: string | null
- property_name: string
- required?: boolean
- value_type: "string" | "single_select" | "multi_select" | "true_false"
- values_editable_by?: "org_actors" | "org_and_repo_actors" | null
-}
-
export type t_org_hook = {
active: boolean
config: {
@@ -3889,44 +3908,6 @@ export type t_org_ruleset_conditions =
| (t_repository_ruleset_conditions &
t_repository_ruleset_conditions_repository_property_target)
-export type t_organization = {
- avatar_url: string
- blog?: string
- company?: string
- created_at: string
- description: string | null
- email?: string
- events_url: string
- followers: number
- following: number
- has_organization_projects: boolean
- has_repository_projects: boolean
- hooks_url: string
- html_url: string
- id: number
- is_verified?: boolean
- issues_url: string
- location?: string
- login: string
- members_url: string
- name?: string
- node_id: string
- plan?: {
- filled_seats?: number
- name?: string
- private_repos?: number
- seats?: number
- space?: number
- }
- public_gists: number
- public_members_url: string
- public_repos: number
- repos_url: string
- type: string
- updated_at: string
- url: string
-}
-
export type t_organization_actions_secret = {
created_at: string
name: string
@@ -5879,6 +5860,7 @@ export type t_repository_ruleset_bypass_actor = {
| "RepositoryRole"
| "Team"
| "DeployKey"
+ | "EnterpriseTeam"
bypass_mode: "always" | "pull_request"
}
@@ -6270,6 +6252,19 @@ export type t_secret_scanning_location_wiki_commit = {
start_line: number
}
+export type t_secret_scanning_push_protection_bypass = {
+ expire_at?: string | null
+ reason?: t_secret_scanning_push_protection_bypass_reason
+ token_type?: string
+}
+
+export type t_secret_scanning_push_protection_bypass_placeholder_id = string
+
+export type t_secret_scanning_push_protection_bypass_reason =
+ | "false_positive"
+ | "used_in_tests"
+ | "will_fix_later"
+
export type t_security_advisory_credit_types =
| "analyst"
| "finder"
diff --git a/integration-tests/typescript-axios/src/generated/stripe.yaml/client.ts b/integration-tests/typescript-axios/src/generated/stripe.yaml/client.ts
index 85ad052a8..8b5778654 100644
--- a/integration-tests/typescript-axios/src/generated/stripe.yaml/client.ts
+++ b/integration-tests/typescript-axios/src/generated/stripe.yaml/client.ts
@@ -13,6 +13,7 @@ import {
t_balance,
t_balance_transaction,
t_bank_account,
+ t_billing_alert,
t_billing_meter,
t_billing_meter_event,
t_billing_meter_event_adjustment,
@@ -3237,6 +3238,189 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async getBillingAlerts(
+ p: {
+ alertType?: "usage_threshold"
+ endingBefore?: string
+ expand?: string[]
+ limit?: number
+ meter?: string
+ startingAfter?: string
+ requestBody?: EmptyObject
+ } = {},
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise<
+ AxiosResponse<{
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }>
+ > {
+ const url = `/v1/billing/alerts`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({
+ alert_type: p["alertType"],
+ ending_before: p["endingBefore"],
+ expand: p["expand"],
+ limit: p["limit"],
+ meter: p["meter"],
+ starting_after: p["startingAfter"],
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url + query,
+ method: "GET",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
+ async postBillingAlerts(
+ p: {
+ requestBody: {
+ alert_type: "usage_threshold"
+ expand?: string[]
+ filter?: {
+ customer?: string
+ }
+ title: string
+ usage_threshold_config?: {
+ gte: number
+ meter?: string
+ recurrence: "one_time"
+ }
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/billing/alerts`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
+ async getBillingAlertsId(
+ p: {
+ expand?: string[]
+ id: string
+ requestBody?: EmptyObject
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/billing/alerts/${p["id"]}`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({ expand: p["expand"] })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url + query,
+ method: "GET",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
+ async postBillingAlertsIdActivate(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/billing/alerts/${p["id"]}/activate`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
+ async postBillingAlertsIdArchive(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/billing/alerts/${p["id"]}/archive`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
+ async postBillingAlertsIdDeactivate(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/billing/alerts/${p["id"]}/deactivate`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async postBillingMeterEventAdjustments(
p: {
requestBody: {
@@ -8275,6 +8459,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -8607,6 +8792,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10408,6 +10594,7 @@ export class ApiClient extends AbstractAxiosClient {
endingBefore?: string
expand?: string[]
limit?: number
+ relatedCustomer?: string
startingAfter?: string
status?: "canceled" | "processing" | "requires_input" | "verified"
requestBody?: EmptyObject
@@ -10432,6 +10619,7 @@ export class ApiClient extends AbstractAxiosClient {
ending_before: p["endingBefore"],
expand: p["expand"],
limit: p["limit"],
+ related_customer: p["relatedCustomer"],
starting_after: p["startingAfter"],
status: p["status"],
})
@@ -10469,6 +10657,7 @@ export class ApiClient extends AbstractAxiosClient {
email?: string
phone?: string
}
+ related_customer?: string
return_url?: string
type?: "document" | "id_number"
verification_flow?: string
@@ -10985,8 +11174,8 @@ export class ApiClient extends AbstractAxiosClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -12507,8 +12696,8 @@ export class ApiClient extends AbstractAxiosClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -18884,6 +19073,7 @@ export class ApiClient extends AbstractAxiosClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -18913,8 +19103,8 @@ export class ApiClient extends AbstractAxiosClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -18936,6 +19126,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -19666,6 +19857,7 @@ export class ApiClient extends AbstractAxiosClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -19695,8 +19887,8 @@ export class ApiClient extends AbstractAxiosClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19718,6 +19910,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -20486,6 +20679,7 @@ export class ApiClient extends AbstractAxiosClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -20515,8 +20709,8 @@ export class ApiClient extends AbstractAxiosClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -20538,6 +20732,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -26750,6 +26945,9 @@ export class ApiClient extends AbstractAxiosClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -26769,6 +26967,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27137,6 +27336,9 @@ export class ApiClient extends AbstractAxiosClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27156,6 +27358,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27531,6 +27734,9 @@ export class ApiClient extends AbstractAxiosClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27550,6 +27756,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29274,6 +29481,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29660,6 +29868,7 @@ export class ApiClient extends AbstractAxiosClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29976,6 +30185,32 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async getTaxCalculationsCalculation(
+ p: {
+ calculation: string
+ expand?: string[]
+ requestBody?: EmptyObject
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/tax/calculations/${p["calculation"]}`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({ expand: p["expand"] })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url + query,
+ method: "GET",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async getTaxCalculationsCalculationLineItems(
p: {
calculation: string
@@ -33109,6 +33344,39 @@ export class ApiClient extends AbstractAxiosClient {
})
}
+ async postTestHelpersIssuingSettlements(
+ p: {
+ requestBody: {
+ bin: string
+ clearing_date: number
+ currency: string
+ expand?: string[]
+ interchange_fees?: number
+ net_total: number
+ network_settlement_identifier?: string
+ transaction_count?: number
+ transaction_volume?: number
+ }
+ },
+ timeout?: number,
+ opts?: AxiosRequestConfig,
+ ): Promise> {
+ const url = `/v1/test_helpers/issuing/settlements`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._request({
+ url: url,
+ method: "POST",
+ headers,
+ data: body,
+ ...(timeout ? { timeout } : {}),
+ ...(opts ?? {}),
+ })
+ }
+
async postTestHelpersIssuingTransactionsCreateForceCapture(
p: {
requestBody: {
@@ -34263,6 +34531,7 @@ export class ApiClient extends AbstractAxiosClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -34390,6 +34659,7 @@ export class ApiClient extends AbstractAxiosClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -36841,6 +37111,7 @@ export class ApiClient extends AbstractAxiosClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
@@ -37164,6 +37435,7 @@ export class ApiClient extends AbstractAxiosClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
diff --git a/integration-tests/typescript-axios/src/generated/stripe.yaml/models.ts b/integration-tests/typescript-axios/src/generated/stripe.yaml/models.ts
index b96011951..d07b8abc1 100644
--- a/integration-tests/typescript-axios/src/generated/stripe.yaml/models.ts
+++ b/integration-tests/typescript-axios/src/generated/stripe.yaml/models.ts
@@ -690,6 +690,17 @@ export type t_bank_connections_resource_transaction_resource_status_transitions
void_at?: number | null
}
+export type t_billing_alert = {
+ alert_type: "usage_threshold"
+ filter?: t_thresholds_resource_alert_filter | null
+ id: string
+ livemode: boolean
+ object: "billing.alert"
+ status?: "active" | "archived" | "inactive" | null
+ title: string
+ usage_threshold_config?: t_thresholds_resource_usage_threshold_config | null
+}
+
export type t_billing_meter = {
created: number
customer_mapping: t_billing_meter_resource_customer_mapping_settings
@@ -2864,6 +2875,7 @@ export type t_identity_verification_session = {
options?: t_gelato_verification_session_options | null
provided_details?: t_gelato_provided_details | null
redaction?: t_verification_session_redaction | null
+ related_customer?: string | null
status: "canceled" | "processing" | "requires_input" | "verified"
type: "document" | "id_number" | "verification_flow"
url?: string | null
@@ -3500,7 +3512,7 @@ export type t_issuing_settlement = {
[key: string]: string | undefined
}
net_total: number
- network: "visa"
+ network: "maestro" | "visa"
network_fees: number
network_settlement_identifier: string
object: "issuing.settlement"
@@ -6347,6 +6359,11 @@ export type t_payment_flows_private_payment_methods_card_details_api_resource_mu
status: "available" | "unavailable"
}
+export type t_payment_flows_private_payment_methods_card_present_common_wallet =
+ {
+ type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"
+ }
+
export type t_payment_flows_private_payment_methods_klarna_dob = {
day?: number | null
month?: number | null
@@ -6622,7 +6639,7 @@ export type t_payment_intent_payment_method_options = {
| t_payment_intent_payment_method_options_au_becs_debit
| t_payment_intent_type_specific_payment_method_options_client
bacs_debit?:
- | t_payment_method_options_bacs_debit
+ | t_payment_intent_payment_method_options_bacs_debit
| t_payment_intent_type_specific_payment_method_options_client
bancontact?:
| t_payment_method_options_bancontact
@@ -6732,6 +6749,11 @@ export type t_payment_intent_payment_method_options_au_becs_debit = {
setup_future_usage?: "none" | "off_session" | "on_session"
}
+export type t_payment_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_payment_intent_payment_method_options_mandate_options_bacs_debit
+ setup_future_usage?: "none" | "off_session" | "on_session"
+}
+
export type t_payment_intent_payment_method_options_blik = {
setup_future_usage?: "none"
}
@@ -6746,6 +6768,7 @@ export type t_payment_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -6781,6 +6804,9 @@ export type t_payment_intent_payment_method_options_mandate_options_acss_debit =
transaction_type?: "business" | "personal" | null
}
+export type t_payment_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_payment_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -7460,6 +7486,7 @@ export type t_payment_method_card_present = {
issuer?: string | null
last4?: string | null
networks?: t_payment_method_card_present_networks | null
+ offline?: t_payment_method_details_card_present_offline | null
preferred_locales?: string[] | null
read_method?:
| "contact_emv"
@@ -7468,6 +7495,7 @@ export type t_payment_method_card_present = {
| "magnetic_stripe_fallback"
| "magnetic_stripe_track2"
| null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_card_present_networks = {
@@ -7710,6 +7738,7 @@ export type t_payment_method_details_boleto = {
export type t_payment_method_details_card = {
amount_authorized?: number | null
+ authorization_code?: string | null
brand?: string | null
capture_before?: number
checks?: t_payment_method_details_card_checks | null
@@ -7781,10 +7810,12 @@ export type t_payment_method_details_card_present = {
| "magnetic_stripe_track2"
| null
receipt?: t_payment_method_details_card_present_receipt | null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_details_card_present_offline = {
stored_at?: number | null
+ type?: "deferred" | null
}
export type t_payment_method_details_card_present_receipt = {
@@ -8322,10 +8353,6 @@ export type t_payment_method_options_amazon_pay = {
setup_future_usage?: "none" | "off_session"
}
-export type t_payment_method_options_bacs_debit = {
- setup_future_usage?: "none" | "off_session" | "on_session"
-}
-
export type t_payment_method_options_bancontact = {
preferred_language: "de" | "en" | "fr" | "nl"
setup_future_usage?: "none" | "off_session"
@@ -9169,7 +9196,7 @@ export type t_person_additional_tos_acceptance = {
}
export type t_person_additional_tos_acceptances = {
- account: t_person_additional_tos_acceptance
+ account?: t_person_additional_tos_acceptance | null
}
export type t_person_future_requirements = {
@@ -10074,6 +10101,9 @@ export type t_setup_intent_payment_method_options = {
amazon_pay?:
| t_setup_intent_payment_method_options_amazon_pay
| t_setup_intent_type_specific_payment_method_options_client
+ bacs_debit?:
+ | t_setup_intent_payment_method_options_bacs_debit
+ | t_setup_intent_type_specific_payment_method_options_client
card?:
| t_setup_intent_payment_method_options_card
| t_setup_intent_type_specific_payment_method_options_client
@@ -10102,6 +10132,10 @@ export type t_setup_intent_payment_method_options_acss_debit = {
export type t_setup_intent_payment_method_options_amazon_pay = EmptyObject
+export type t_setup_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_setup_intent_payment_method_options_mandate_options_bacs_debit
+}
+
export type t_setup_intent_payment_method_options_card = {
mandate_options?: t_setup_intent_payment_method_options_card_mandate_options | null
network?:
@@ -10110,6 +10144,7 @@ export type t_setup_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10145,6 +10180,9 @@ export type t_setup_intent_payment_method_options_mandate_options_acss_debit = {
transaction_type?: "business" | "personal" | null
}
+export type t_setup_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_setup_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -10740,6 +10778,7 @@ export type t_subscription_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -11774,6 +11813,16 @@ export type t_three_d_secure_usage = {
supported: boolean
}
+export type t_thresholds_resource_alert_filter = {
+ customer?: string | t_customer | null
+}
+
+export type t_thresholds_resource_usage_threshold_config = {
+ gte: number
+ meter: string | t_billing_meter
+ recurrence: "one_time"
+}
+
export type t_token = {
bank_account?: t_bank_account
card?: t_card
@@ -11919,6 +11968,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11942,6 +11992,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11955,6 +12006,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -12343,7 +12395,8 @@ export type t_treasury_outbound_payments_resource_returned_status = {
export type t_treasury_outbound_payments_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
@@ -12382,7 +12435,8 @@ export type t_treasury_outbound_transfers_resource_status_transitions = {
export type t_treasury_outbound_transfers_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
diff --git a/integration-tests/typescript-fetch/package.json b/integration-tests/typescript-fetch/package.json
index 76e84dd49..85f1b58fb 100644
--- a/integration-tests/typescript-fetch/package.json
+++ b/integration-tests/typescript-fetch/package.json
@@ -14,7 +14,7 @@
"dotenv": "^16.4.5"
},
"devDependencies": {
- "@types/node": "^22.0.0",
+ "@types/node": "^22.4.0",
"typescript": "~5.5.4"
}
}
diff --git a/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/client.ts b/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/client.ts
index dda54934a..94771f269 100644
--- a/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/client.ts
+++ b/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/client.ts
@@ -73,6 +73,7 @@ import {
t_code_scanning_variant_analysis_repo_task,
t_code_search_result_item,
t_code_security_configuration,
+ t_code_security_configuration_for_repository,
t_code_security_configuration_repositories,
t_code_security_default_configurations,
t_codeowners_errors,
@@ -105,6 +106,7 @@ import {
t_copilot_seat_details,
t_copilot_usage_metrics,
t_custom_deployment_rule_app,
+ t_custom_property,
t_custom_property_value,
t_dependabot_alert,
t_dependabot_alert_with_repository,
@@ -174,7 +176,6 @@ import {
t_minimal_repository,
t_oidc_custom_sub,
t_oidc_custom_sub_repo,
- t_org_custom_property,
t_org_hook,
t_org_membership,
t_org_repo_custom_property_values,
@@ -255,6 +256,9 @@ import {
t_secret_scanning_alert_resolution_comment,
t_secret_scanning_alert_state,
t_secret_scanning_location,
+ t_secret_scanning_push_protection_bypass,
+ t_secret_scanning_push_protection_bypass_placeholder_id,
+ t_secret_scanning_push_protection_bypass_reason,
t_security_advisory_ecosystems,
t_selected_actions,
t_short_blob,
@@ -1089,6 +1093,39 @@ export class ApiClient extends AbstractFetchClient {
return this._fetch(url + query, { method: "GET", ...(opts ?? {}) }, timeout)
}
+ async copilotUsageMetricsForEnterpriseTeam(
+ p: {
+ enterprise: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ | Res<200, t_copilot_usage_metrics[]>
+ | Res<401, t_basic_error>
+ | Res<403, t_basic_error>
+ | Res<404, t_basic_error>
+ | Res<500, t_basic_error>
+ >
+ > {
+ const url =
+ this.basePath +
+ `/enterprises/${p["enterprise"]}/team/${p["teamSlug"]}/copilot/usage`
+ const query = this._query({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this._fetch(url + query, { method: "GET", ...(opts ?? {}) }, timeout)
+ }
+
async activityListPublicEvents(
p: {
perPage?: number
@@ -3337,6 +3374,10 @@ export class ApiClient extends AbstractFetchClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description: string
enforcement?: "enforced" | "unenforced"
name: string
@@ -3442,6 +3483,10 @@ export class ApiClient extends AbstractFetchClient {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
name?: string
@@ -6090,7 +6135,7 @@ export class ApiClient extends AbstractFetchClient {
opts?: RequestInit,
): Promise<
TypedFetchResponse<
- | Res<200, t_org_custom_property[]>
+ | Res<200, t_custom_property[]>
| Res<403, t_basic_error>
| Res<404, t_basic_error>
>
@@ -6104,14 +6149,14 @@ export class ApiClient extends AbstractFetchClient {
p: {
org: string
requestBody: {
- properties: t_org_custom_property[]
+ properties: t_custom_property[]
}
},
timeout?: number,
opts?: RequestInit,
): Promise<
TypedFetchResponse<
- | Res<200, t_org_custom_property[]>
+ | Res<200, t_custom_property[]>
| Res<403, t_basic_error>
| Res<404, t_basic_error>
>
@@ -6136,7 +6181,7 @@ export class ApiClient extends AbstractFetchClient {
opts?: RequestInit,
): Promise<
TypedFetchResponse<
- | Res<200, t_org_custom_property>
+ | Res<200, t_custom_property>
| Res<403, t_basic_error>
| Res<404, t_basic_error>
>
@@ -6164,7 +6209,7 @@ export class ApiClient extends AbstractFetchClient {
opts?: RequestInit,
): Promise<
TypedFetchResponse<
- | Res<200, t_org_custom_property>
+ | Res<200, t_custom_property>
| Res<403, t_basic_error>
| Res<404, t_basic_error>
>
@@ -6723,6 +6768,38 @@ export class ApiClient extends AbstractFetchClient {
return this._fetch(url, { method: "GET", ...(opts ?? {}) }, timeout)
}
+ async copilotUsageMetricsForTeam(
+ p: {
+ org: string
+ teamSlug: string
+ since?: string
+ until?: string
+ page?: number
+ perPage?: number
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ | Res<200, t_copilot_usage_metrics[]>
+ | Res<401, t_basic_error>
+ | Res<403, t_basic_error>
+ | Res<404, t_basic_error>
+ | Res<500, t_basic_error>
+ >
+ > {
+ const url =
+ this.basePath + `/orgs/${p["org"]}/team/${p["teamSlug"]}/copilot/usage`
+ const query = this._query({
+ since: p["since"],
+ until: p["until"],
+ page: p["page"],
+ per_page: p["perPage"],
+ })
+
+ return this._fetch(url + query, { method: "GET", ...(opts ?? {}) }, timeout)
+ }
+
async teamsList(
p: {
org: string
@@ -11898,6 +11975,29 @@ export class ApiClient extends AbstractFetchClient {
return this._fetch(url, { method: "GET", ...(opts ?? {}) }, timeout)
}
+ async codeSecurityGetConfigurationForRepository(
+ p: {
+ owner: string
+ repo: string
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ | Res<200, t_code_security_configuration_for_repository>
+ | Res<204, void>
+ | Res<304, void>
+ | Res<403, t_basic_error>
+ | Res<404, t_basic_error>
+ >
+ > {
+ const url =
+ this.basePath +
+ `/repos/${p["owner"]}/${p["repo"]}/code-security-configuration`
+
+ return this._fetch(url, { method: "GET", ...(opts ?? {}) }, timeout)
+ }
+
async reposCodeownersErrors(
p: {
owner: string
@@ -17780,6 +17880,7 @@ export class ApiClient extends AbstractFetchClient {
): Promise<
TypedFetchResponse<
| Res<200, t_content_file>
+ | Res<304, void>
| Res<404, t_basic_error>
| Res<422, t_validation_error>
>
@@ -18544,6 +18645,46 @@ export class ApiClient extends AbstractFetchClient {
return this._fetch(url + query, { method: "GET", ...(opts ?? {}) }, timeout)
}
+ async secretScanningCreatePushProtectionBypass(
+ p: {
+ owner: string
+ repo: string
+ requestBody: {
+ placeholder_id: t_secret_scanning_push_protection_bypass_placeholder_id
+ reason: t_secret_scanning_push_protection_bypass_reason
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ | Res<200, t_secret_scanning_push_protection_bypass>
+ | Res<403, void>
+ | Res<404, void>
+ | Res<422, void>
+ | Res<
+ 503,
+ {
+ code?: string
+ documentation_url?: string
+ message?: string
+ }
+ >
+ >
+ > {
+ const url =
+ this.basePath +
+ `/repos/${p["owner"]}/${p["repo"]}/secret-scanning/push-protection-bypasses`
+ const headers = this._headers({ "Content-Type": "application/json" })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
async securityAdvisoriesListRepositoryAdvisories(
p: {
owner: string
diff --git a/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/models.ts b/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/models.ts
index 315b6b967..1583cda45 100644
--- a/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/models.ts
+++ b/integration-tests/typescript-fetch/src/generated/api.github.com.yaml/models.ts
@@ -176,6 +176,7 @@ export type t_api_overview = {
actions?: string[]
actions_macos?: string[]
api?: string[]
+ copilot?: string[]
dependabot?: string[]
domains?: {
actions?: string[]
@@ -1074,6 +1075,10 @@ export type t_code_security_configuration = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
html_url?: string
@@ -1088,6 +1093,19 @@ export type t_code_security_configuration = {
url?: string
}
+export type t_code_security_configuration_for_repository = {
+ configuration?: t_code_security_configuration
+ status?:
+ | "attached"
+ | "attaching"
+ | "detached"
+ | "removed"
+ | "enforced"
+ | "failed"
+ | "updating"
+ | "removed_by_enterprise"
+}
+
export type t_code_security_configuration_repositories = {
repository?: t_simple_repository
status?:
@@ -1622,7 +1640,7 @@ export type t_copilot_seat_breakdown = {
}
export type t_copilot_seat_details = {
- assignee: t_simple_user | t_team | t_organization
+ assignee: t_simple_user
assigning_team?: t_team | t_enterprise_team | null
created_at: string
last_activity_at?: string | null
@@ -1663,6 +1681,17 @@ export type t_custom_deployment_rule_app = {
slug: string
}
+export type t_custom_property = {
+ allowed_values?: string[] | null
+ default_value?: string | string[] | null
+ description?: string | null
+ property_name: string
+ required?: boolean
+ url?: string
+ value_type: "string" | "single_select" | "multi_select" | "true_false"
+ values_editable_by?: "org_actors" | "org_and_repo_actors" | null
+}
+
export type t_custom_property_value = {
property_name: string
value: string | string[] | null
@@ -3833,16 +3862,6 @@ export type t_oidc_custom_sub_repo = {
use_default: boolean
}
-export type t_org_custom_property = {
- allowed_values?: string[] | null
- default_value?: string | string[] | null
- description?: string | null
- property_name: string
- required?: boolean
- value_type: "string" | "single_select" | "multi_select" | "true_false"
- values_editable_by?: "org_actors" | "org_and_repo_actors" | null
-}
-
export type t_org_hook = {
active: boolean
config: {
@@ -3889,44 +3908,6 @@ export type t_org_ruleset_conditions =
| (t_repository_ruleset_conditions &
t_repository_ruleset_conditions_repository_property_target)
-export type t_organization = {
- avatar_url: string
- blog?: string
- company?: string
- created_at: string
- description: string | null
- email?: string
- events_url: string
- followers: number
- following: number
- has_organization_projects: boolean
- has_repository_projects: boolean
- hooks_url: string
- html_url: string
- id: number
- is_verified?: boolean
- issues_url: string
- location?: string
- login: string
- members_url: string
- name?: string
- node_id: string
- plan?: {
- filled_seats?: number
- name?: string
- private_repos?: number
- seats?: number
- space?: number
- }
- public_gists: number
- public_members_url: string
- public_repos: number
- repos_url: string
- type: string
- updated_at: string
- url: string
-}
-
export type t_organization_actions_secret = {
created_at: string
name: string
@@ -5879,6 +5860,7 @@ export type t_repository_ruleset_bypass_actor = {
| "RepositoryRole"
| "Team"
| "DeployKey"
+ | "EnterpriseTeam"
bypass_mode: "always" | "pull_request"
}
@@ -6270,6 +6252,19 @@ export type t_secret_scanning_location_wiki_commit = {
start_line: number
}
+export type t_secret_scanning_push_protection_bypass = {
+ expire_at?: string | null
+ reason?: t_secret_scanning_push_protection_bypass_reason
+ token_type?: string
+}
+
+export type t_secret_scanning_push_protection_bypass_placeholder_id = string
+
+export type t_secret_scanning_push_protection_bypass_reason =
+ | "false_positive"
+ | "used_in_tests"
+ | "will_fix_later"
+
export type t_security_advisory_credit_types =
| "analyst"
| "finder"
diff --git a/integration-tests/typescript-fetch/src/generated/stripe.yaml/client.ts b/integration-tests/typescript-fetch/src/generated/stripe.yaml/client.ts
index 841844b68..b6a454b4f 100644
--- a/integration-tests/typescript-fetch/src/generated/stripe.yaml/client.ts
+++ b/integration-tests/typescript-fetch/src/generated/stripe.yaml/client.ts
@@ -13,6 +13,7 @@ import {
t_balance,
t_balance_transaction,
t_bank_account,
+ t_billing_alert,
t_billing_meter,
t_billing_meter_event,
t_billing_meter_event_adjustment,
@@ -3265,6 +3266,187 @@ export class ApiClient extends AbstractFetchClient {
)
}
+ async getBillingAlerts(
+ p: {
+ alertType?: "usage_threshold"
+ endingBefore?: string
+ expand?: string[]
+ limit?: number
+ meter?: string
+ startingAfter?: string
+ requestBody?: EmptyObject
+ } = {},
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ | Res<
+ 200,
+ {
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }
+ >
+ | Res
+ >
+ > {
+ const url = this.basePath + `/v1/billing/alerts`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({
+ alert_type: p["alertType"],
+ ending_before: p["endingBefore"],
+ expand: p["expand"],
+ limit: p["limit"],
+ meter: p["meter"],
+ starting_after: p["startingAfter"],
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url + query,
+ { method: "GET", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
+ async postBillingAlerts(
+ p: {
+ requestBody: {
+ alert_type: "usage_threshold"
+ expand?: string[]
+ filter?: {
+ customer?: string
+ }
+ title: string
+ usage_threshold_config?: {
+ gte: number
+ meter?: string
+ recurrence: "one_time"
+ }
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/billing/alerts`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
+ async getBillingAlertsId(
+ p: {
+ expand?: string[]
+ id: string
+ requestBody?: EmptyObject
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/billing/alerts/${p["id"]}`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({ expand: p["expand"] })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url + query,
+ { method: "GET", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
+ async postBillingAlertsIdActivate(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/billing/alerts/${p["id"]}/activate`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
+ async postBillingAlertsIdArchive(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/billing/alerts/${p["id"]}/archive`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
+ async postBillingAlertsIdDeactivate(
+ p: {
+ id: string
+ requestBody?: {
+ expand?: string[]
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/billing/alerts/${p["id"]}/deactivate`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
async postBillingMeterEventAdjustments(
p: {
requestBody: {
@@ -8375,6 +8557,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -8708,6 +8891,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10563,6 +10747,7 @@ export class ApiClient extends AbstractFetchClient {
endingBefore?: string
expand?: string[]
limit?: number
+ relatedCustomer?: string
startingAfter?: string
status?: "canceled" | "processing" | "requires_input" | "verified"
requestBody?: EmptyObject
@@ -10593,6 +10778,7 @@ export class ApiClient extends AbstractFetchClient {
ending_before: p["endingBefore"],
expand: p["expand"],
limit: p["limit"],
+ related_customer: p["relatedCustomer"],
starting_after: p["startingAfter"],
status: p["status"],
})
@@ -10627,6 +10813,7 @@ export class ApiClient extends AbstractFetchClient {
email?: string
phone?: string
}
+ related_customer?: string
return_url?: string
type?: "document" | "id_number"
verification_flow?: string
@@ -11158,8 +11345,8 @@ export class ApiClient extends AbstractFetchClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -12681,8 +12868,8 @@ export class ApiClient extends AbstractFetchClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19105,6 +19292,7 @@ export class ApiClient extends AbstractFetchClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -19134,8 +19322,8 @@ export class ApiClient extends AbstractFetchClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19157,6 +19345,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -19888,6 +20077,7 @@ export class ApiClient extends AbstractFetchClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -19917,8 +20107,8 @@ export class ApiClient extends AbstractFetchClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -19940,6 +20130,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -20706,6 +20897,7 @@ export class ApiClient extends AbstractFetchClient {
| ""
bacs_debit?:
| {
+ mandate_options?: EmptyObject
setup_future_usage?: "" | "none" | "off_session" | "on_session"
}
| ""
@@ -20735,8 +20927,8 @@ export class ApiClient extends AbstractFetchClient {
enabled?: boolean
plan?:
| {
- count: number
- interval: "month"
+ count?: number
+ interval?: "month"
type: "fixed_count"
}
| ""
@@ -20758,6 +20950,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27003,6 +27196,9 @@ export class ApiClient extends AbstractFetchClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27022,6 +27218,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27388,6 +27585,9 @@ export class ApiClient extends AbstractFetchClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27407,6 +27607,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -27780,6 +27981,9 @@ export class ApiClient extends AbstractFetchClient {
verification_method?: "automatic" | "instant" | "microdeposits"
}
amazon_pay?: EmptyObject
+ bacs_debit?: {
+ mandate_options?: EmptyObject
+ }
card?: {
mandate_options?: {
amount: number
@@ -27799,6 +28003,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29552,6 +29757,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -29940,6 +30146,7 @@ export class ApiClient extends AbstractFetchClient {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -30254,6 +30461,31 @@ export class ApiClient extends AbstractFetchClient {
)
}
+ async getTaxCalculationsCalculation(
+ p: {
+ calculation: string
+ expand?: string[]
+ requestBody?: EmptyObject
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse | Res>
+ > {
+ const url = this.basePath + `/v1/tax/calculations/${p["calculation"]}`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const query = this._query({ expand: p["expand"] })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url + query,
+ { method: "GET", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
async getTaxCalculationsCalculationLineItems(
p: {
calculation: string
@@ -33449,6 +33681,40 @@ export class ApiClient extends AbstractFetchClient {
)
}
+ async postTestHelpersIssuingSettlements(
+ p: {
+ requestBody: {
+ bin: string
+ clearing_date: number
+ currency: string
+ expand?: string[]
+ interchange_fees?: number
+ net_total: number
+ network_settlement_identifier?: string
+ transaction_count?: number
+ transaction_volume?: number
+ }
+ },
+ timeout?: number,
+ opts?: RequestInit,
+ ): Promise<
+ TypedFetchResponse<
+ Res<200, t_issuing_settlement> | Res
+ >
+ > {
+ const url = this.basePath + `/v1/test_helpers/issuing/settlements`
+ const headers = this._headers({
+ "Content-Type": "application/x-www-form-urlencoded",
+ })
+ const body = JSON.stringify(p.requestBody)
+
+ return this._fetch(
+ url,
+ { method: "POST", headers, body, ...(opts ?? {}) },
+ timeout,
+ )
+ }
+
async postTestHelpersIssuingTransactionsCreateForceCapture(
p: {
requestBody: {
@@ -34629,6 +34895,7 @@ export class ApiClient extends AbstractFetchClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -34767,6 +35034,7 @@ export class ApiClient extends AbstractFetchClient {
}
type: "ach" | "us_domestic_wire"
us_domestic_wire?: {
+ chips?: string
imad?: string
omad?: string
}
@@ -37288,6 +37556,7 @@ export class ApiClient extends AbstractFetchClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
@@ -37610,6 +37879,7 @@ export class ApiClient extends AbstractFetchClient {
| "application_fee.refund.updated"
| "application_fee.refunded"
| "balance.available"
+ | "billing.alert.triggered"
| "billing_portal.configuration.created"
| "billing_portal.configuration.updated"
| "billing_portal.session.created"
diff --git a/integration-tests/typescript-fetch/src/generated/stripe.yaml/models.ts b/integration-tests/typescript-fetch/src/generated/stripe.yaml/models.ts
index b96011951..d07b8abc1 100644
--- a/integration-tests/typescript-fetch/src/generated/stripe.yaml/models.ts
+++ b/integration-tests/typescript-fetch/src/generated/stripe.yaml/models.ts
@@ -690,6 +690,17 @@ export type t_bank_connections_resource_transaction_resource_status_transitions
void_at?: number | null
}
+export type t_billing_alert = {
+ alert_type: "usage_threshold"
+ filter?: t_thresholds_resource_alert_filter | null
+ id: string
+ livemode: boolean
+ object: "billing.alert"
+ status?: "active" | "archived" | "inactive" | null
+ title: string
+ usage_threshold_config?: t_thresholds_resource_usage_threshold_config | null
+}
+
export type t_billing_meter = {
created: number
customer_mapping: t_billing_meter_resource_customer_mapping_settings
@@ -2864,6 +2875,7 @@ export type t_identity_verification_session = {
options?: t_gelato_verification_session_options | null
provided_details?: t_gelato_provided_details | null
redaction?: t_verification_session_redaction | null
+ related_customer?: string | null
status: "canceled" | "processing" | "requires_input" | "verified"
type: "document" | "id_number" | "verification_flow"
url?: string | null
@@ -3500,7 +3512,7 @@ export type t_issuing_settlement = {
[key: string]: string | undefined
}
net_total: number
- network: "visa"
+ network: "maestro" | "visa"
network_fees: number
network_settlement_identifier: string
object: "issuing.settlement"
@@ -6347,6 +6359,11 @@ export type t_payment_flows_private_payment_methods_card_details_api_resource_mu
status: "available" | "unavailable"
}
+export type t_payment_flows_private_payment_methods_card_present_common_wallet =
+ {
+ type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"
+ }
+
export type t_payment_flows_private_payment_methods_klarna_dob = {
day?: number | null
month?: number | null
@@ -6622,7 +6639,7 @@ export type t_payment_intent_payment_method_options = {
| t_payment_intent_payment_method_options_au_becs_debit
| t_payment_intent_type_specific_payment_method_options_client
bacs_debit?:
- | t_payment_method_options_bacs_debit
+ | t_payment_intent_payment_method_options_bacs_debit
| t_payment_intent_type_specific_payment_method_options_client
bancontact?:
| t_payment_method_options_bancontact
@@ -6732,6 +6749,11 @@ export type t_payment_intent_payment_method_options_au_becs_debit = {
setup_future_usage?: "none" | "off_session" | "on_session"
}
+export type t_payment_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_payment_intent_payment_method_options_mandate_options_bacs_debit
+ setup_future_usage?: "none" | "off_session" | "on_session"
+}
+
export type t_payment_intent_payment_method_options_blik = {
setup_future_usage?: "none"
}
@@ -6746,6 +6768,7 @@ export type t_payment_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -6781,6 +6804,9 @@ export type t_payment_intent_payment_method_options_mandate_options_acss_debit =
transaction_type?: "business" | "personal" | null
}
+export type t_payment_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_payment_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -7460,6 +7486,7 @@ export type t_payment_method_card_present = {
issuer?: string | null
last4?: string | null
networks?: t_payment_method_card_present_networks | null
+ offline?: t_payment_method_details_card_present_offline | null
preferred_locales?: string[] | null
read_method?:
| "contact_emv"
@@ -7468,6 +7495,7 @@ export type t_payment_method_card_present = {
| "magnetic_stripe_fallback"
| "magnetic_stripe_track2"
| null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_card_present_networks = {
@@ -7710,6 +7738,7 @@ export type t_payment_method_details_boleto = {
export type t_payment_method_details_card = {
amount_authorized?: number | null
+ authorization_code?: string | null
brand?: string | null
capture_before?: number
checks?: t_payment_method_details_card_checks | null
@@ -7781,10 +7810,12 @@ export type t_payment_method_details_card_present = {
| "magnetic_stripe_track2"
| null
receipt?: t_payment_method_details_card_present_receipt | null
+ wallet?: t_payment_flows_private_payment_methods_card_present_common_wallet
}
export type t_payment_method_details_card_present_offline = {
stored_at?: number | null
+ type?: "deferred" | null
}
export type t_payment_method_details_card_present_receipt = {
@@ -8322,10 +8353,6 @@ export type t_payment_method_options_amazon_pay = {
setup_future_usage?: "none" | "off_session"
}
-export type t_payment_method_options_bacs_debit = {
- setup_future_usage?: "none" | "off_session" | "on_session"
-}
-
export type t_payment_method_options_bancontact = {
preferred_language: "de" | "en" | "fr" | "nl"
setup_future_usage?: "none" | "off_session"
@@ -9169,7 +9196,7 @@ export type t_person_additional_tos_acceptance = {
}
export type t_person_additional_tos_acceptances = {
- account: t_person_additional_tos_acceptance
+ account?: t_person_additional_tos_acceptance | null
}
export type t_person_future_requirements = {
@@ -10074,6 +10101,9 @@ export type t_setup_intent_payment_method_options = {
amazon_pay?:
| t_setup_intent_payment_method_options_amazon_pay
| t_setup_intent_type_specific_payment_method_options_client
+ bacs_debit?:
+ | t_setup_intent_payment_method_options_bacs_debit
+ | t_setup_intent_type_specific_payment_method_options_client
card?:
| t_setup_intent_payment_method_options_card
| t_setup_intent_type_specific_payment_method_options_client
@@ -10102,6 +10132,10 @@ export type t_setup_intent_payment_method_options_acss_debit = {
export type t_setup_intent_payment_method_options_amazon_pay = EmptyObject
+export type t_setup_intent_payment_method_options_bacs_debit = {
+ mandate_options?: t_setup_intent_payment_method_options_mandate_options_bacs_debit
+}
+
export type t_setup_intent_payment_method_options_card = {
mandate_options?: t_setup_intent_payment_method_options_card_mandate_options | null
network?:
@@ -10110,6 +10144,7 @@ export type t_setup_intent_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -10145,6 +10180,9 @@ export type t_setup_intent_payment_method_options_mandate_options_acss_debit = {
transaction_type?: "business" | "personal" | null
}
+export type t_setup_intent_payment_method_options_mandate_options_bacs_debit =
+ EmptyObject
+
export type t_setup_intent_payment_method_options_mandate_options_sepa_debit =
EmptyObject
@@ -10740,6 +10778,7 @@ export type t_subscription_payment_method_options_card = {
| "diners"
| "discover"
| "eftpos_au"
+ | "girocard"
| "interac"
| "jcb"
| "mastercard"
@@ -11774,6 +11813,16 @@ export type t_three_d_secure_usage = {
supported: boolean
}
+export type t_thresholds_resource_alert_filter = {
+ customer?: string | t_customer | null
+}
+
+export type t_thresholds_resource_usage_threshold_config = {
+ gte: number
+ meter: string | t_billing_meter
+ recurrence: "one_time"
+}
+
export type t_token = {
bank_account?: t_bank_account
card?: t_card
@@ -11919,6 +11968,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11942,6 +11992,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -11955,6 +12006,7 @@ export type t_treasury_financial_account = {
| "card_issuing"
| "deposit_insurance"
| "financial_addresses.aba"
+ | "financial_addresses.aba.forwarding"
| "inbound_transfers.ach"
| "intra_stripe_flows"
| "outbound_payments.ach"
@@ -12343,7 +12395,8 @@ export type t_treasury_outbound_payments_resource_returned_status = {
export type t_treasury_outbound_payments_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
@@ -12382,7 +12435,8 @@ export type t_treasury_outbound_transfers_resource_status_transitions = {
export type t_treasury_outbound_transfers_resource_us_domestic_wire_tracking_details =
{
- imad: string
+ chips?: string | null
+ imad?: string | null
omad?: string | null
}
diff --git a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/generated.ts b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/generated.ts
index eb02dda87..638401bd4 100644
--- a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/generated.ts
+++ b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/generated.ts
@@ -342,6 +342,7 @@ import {
t_CodeSecurityDeleteConfigurationParamSchema,
t_CodeSecurityDetachConfigurationBodySchema,
t_CodeSecurityDetachConfigurationParamSchema,
+ t_CodeSecurityGetConfigurationForRepositoryParamSchema,
t_CodeSecurityGetConfigurationParamSchema,
t_CodeSecurityGetConfigurationsForOrgParamSchema,
t_CodeSecurityGetConfigurationsForOrgQuerySchema,
@@ -438,8 +439,12 @@ import {
t_CopilotListCopilotSeatsQuerySchema,
t_CopilotUsageMetricsForEnterpriseParamSchema,
t_CopilotUsageMetricsForEnterpriseQuerySchema,
+ t_CopilotUsageMetricsForEnterpriseTeamParamSchema,
+ t_CopilotUsageMetricsForEnterpriseTeamQuerySchema,
t_CopilotUsageMetricsForOrgParamSchema,
t_CopilotUsageMetricsForOrgQuerySchema,
+ t_CopilotUsageMetricsForTeamParamSchema,
+ t_CopilotUsageMetricsForTeamQuerySchema,
t_DependabotAddSelectedRepoToOrgSecretParamSchema,
t_DependabotCreateOrUpdateOrgSecretBodySchema,
t_DependabotCreateOrUpdateOrgSecretParamSchema,
@@ -1219,6 +1224,8 @@ import {
t_SearchReposQuerySchema,
t_SearchTopicsQuerySchema,
t_SearchUsersQuerySchema,
+ t_SecretScanningCreatePushProtectionBypassBodySchema,
+ t_SecretScanningCreatePushProtectionBypassParamSchema,
t_SecretScanningGetAlertParamSchema,
t_SecretScanningListAlertsForEnterpriseParamSchema,
t_SecretScanningListAlertsForEnterpriseQuerySchema,
@@ -1438,6 +1445,7 @@ import {
t_code_scanning_variant_analysis_repo_task,
t_code_search_result_item,
t_code_security_configuration,
+ t_code_security_configuration_for_repository,
t_code_security_configuration_repositories,
t_code_security_default_configurations,
t_codeowners_errors,
@@ -1470,6 +1478,7 @@ import {
t_copilot_seat_details,
t_copilot_usage_metrics,
t_custom_deployment_rule_app,
+ t_custom_property,
t_custom_property_value,
t_dependabot_alert,
t_dependabot_alert_with_repository,
@@ -1533,7 +1542,6 @@ import {
t_minimal_repository,
t_oidc_custom_sub,
t_oidc_custom_sub_repo,
- t_org_custom_property,
t_org_hook,
t_org_membership,
t_org_repo_custom_property_values,
@@ -1600,6 +1608,7 @@ import {
t_scim_error,
t_secret_scanning_alert,
t_secret_scanning_location,
+ t_secret_scanning_push_protection_bypass,
t_selected_actions,
t_short_blob,
t_short_branch,
@@ -1712,6 +1721,7 @@ import {
s_code_scanning_variant_analysis_repo_task,
s_code_search_result_item,
s_code_security_configuration,
+ s_code_security_configuration_for_repository,
s_code_security_configuration_repositories,
s_code_security_default_configurations,
s_codeowners_errors,
@@ -1744,6 +1754,7 @@ import {
s_copilot_seat_details,
s_copilot_usage_metrics,
s_custom_deployment_rule_app,
+ s_custom_property,
s_custom_property_value,
s_dependabot_alert,
s_dependabot_alert_with_repository,
@@ -1813,7 +1824,6 @@ import {
s_minimal_repository,
s_oidc_custom_sub,
s_oidc_custom_sub_repo,
- s_org_custom_property,
s_org_hook,
s_org_membership,
s_org_repo_custom_property_values,
@@ -1894,6 +1904,9 @@ import {
s_secret_scanning_alert_resolution_comment,
s_secret_scanning_alert_state,
s_secret_scanning_location,
+ s_secret_scanning_push_protection_bypass,
+ s_secret_scanning_push_protection_bypass_placeholder_id,
+ s_secret_scanning_push_protection_bypass_reason,
s_security_advisory_ecosystems,
s_selected_actions,
s_short_blob,
@@ -2611,6 +2624,31 @@ export type SecretScanningListAlertsForEnterprise = (
>
>
+export type CopilotUsageMetricsForEnterpriseTeamResponder = {
+ with200(): KoaRuntimeResponse
+ with401(): KoaRuntimeResponse
+ with403(): KoaRuntimeResponse
+ with404(): KoaRuntimeResponse
+ with500(): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type CopilotUsageMetricsForEnterpriseTeam = (
+ params: Params<
+ t_CopilotUsageMetricsForEnterpriseTeamParamSchema,
+ t_CopilotUsageMetricsForEnterpriseTeamQuerySchema,
+ void
+ >,
+ respond: CopilotUsageMetricsForEnterpriseTeamResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_copilot_usage_metrics[]>
+ | Response<401, t_basic_error>
+ | Response<403, t_basic_error>
+ | Response<404, t_basic_error>
+ | Response<500, t_basic_error>
+>
+
export type ActivityListPublicEventsResponder = {
with200(): KoaRuntimeResponse
with304(): KoaRuntimeResponse
@@ -6835,7 +6873,7 @@ export type ProjectsCreateForOrg = (
>
export type OrgsGetAllCustomPropertiesResponder = {
- with200(): KoaRuntimeResponse
+ with200(): KoaRuntimeResponse
with403(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
} & KoaRuntimeResponder
@@ -6846,13 +6884,13 @@ export type OrgsGetAllCustomProperties = (
ctx: RouterContext,
) => Promise<
| KoaRuntimeResponse
- | Response<200, t_org_custom_property[]>
+ | Response<200, t_custom_property[]>
| Response<403, t_basic_error>
| Response<404, t_basic_error>
>
export type OrgsCreateOrUpdateCustomPropertiesResponder = {
- with200(): KoaRuntimeResponse
+ with200(): KoaRuntimeResponse
with403(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
} & KoaRuntimeResponder
@@ -6867,13 +6905,13 @@ export type OrgsCreateOrUpdateCustomProperties = (
ctx: RouterContext,
) => Promise<
| KoaRuntimeResponse
- | Response<200, t_org_custom_property[]>
+ | Response<200, t_custom_property[]>
| Response<403, t_basic_error>
| Response<404, t_basic_error>
>
export type OrgsGetCustomPropertyResponder = {
- with200(): KoaRuntimeResponse
+ with200(): KoaRuntimeResponse
with403(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
} & KoaRuntimeResponder
@@ -6884,13 +6922,13 @@ export type OrgsGetCustomProperty = (
ctx: RouterContext,
) => Promise<
| KoaRuntimeResponse
- | Response<200, t_org_custom_property>
+ | Response<200, t_custom_property>
| Response<403, t_basic_error>
| Response<404, t_basic_error>
>
export type OrgsCreateOrUpdateCustomPropertyResponder = {
- with200(): KoaRuntimeResponse
+ with200(): KoaRuntimeResponse
with403(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
} & KoaRuntimeResponder
@@ -6905,7 +6943,7 @@ export type OrgsCreateOrUpdateCustomProperty = (
ctx: RouterContext,
) => Promise<
| KoaRuntimeResponse
- | Response<200, t_org_custom_property>
+ | Response<200, t_custom_property>
| Response<403, t_basic_error>
| Response<404, t_basic_error>
>
@@ -7322,6 +7360,31 @@ export type BillingGetSharedStorageBillingOrg = (
KoaRuntimeResponse | Response<200, t_combined_billing_usage>
>
+export type CopilotUsageMetricsForTeamResponder = {
+ with200(): KoaRuntimeResponse
+ with401(): KoaRuntimeResponse
+ with403(): KoaRuntimeResponse
+ with404(): KoaRuntimeResponse
+ with500(): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type CopilotUsageMetricsForTeam = (
+ params: Params<
+ t_CopilotUsageMetricsForTeamParamSchema,
+ t_CopilotUsageMetricsForTeamQuerySchema,
+ void
+ >,
+ respond: CopilotUsageMetricsForTeamResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_copilot_usage_metrics[]>
+ | Response<401, t_basic_error>
+ | Response<403, t_basic_error>
+ | Response<404, t_basic_error>
+ | Response<500, t_basic_error>
+>
+
export type TeamsListResponder = {
with200(): KoaRuntimeResponse
with403(): KoaRuntimeResponse
@@ -11223,6 +11286,31 @@ export type CodeScanningGetSarif = (
>
>
+export type CodeSecurityGetConfigurationForRepositoryResponder = {
+ with200(): KoaRuntimeResponse
+ with204(): KoaRuntimeResponse
+ with304(): KoaRuntimeResponse
+ with403(): KoaRuntimeResponse
+ with404(): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type CodeSecurityGetConfigurationForRepository = (
+ params: Params<
+ t_CodeSecurityGetConfigurationForRepositoryParamSchema,
+ void,
+ void
+ >,
+ respond: CodeSecurityGetConfigurationForRepositoryResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_code_security_configuration_for_repository>
+ | Response<204, void>
+ | Response<304, void>
+ | Response<403, t_basic_error>
+ | Response<404, t_basic_error>
+>
+
export type ReposCodeownersErrorsResponder = {
with200(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
@@ -15612,6 +15700,7 @@ export type PullsUpdateBranch = (
export type ReposGetReadmeResponder = {
with200(): KoaRuntimeResponse
+ with304(): KoaRuntimeResponse
with404(): KoaRuntimeResponse
with422(): KoaRuntimeResponse
} & KoaRuntimeResponder
@@ -15627,6 +15716,7 @@ export type ReposGetReadme = (
) => Promise<
| KoaRuntimeResponse
| Response<200, t_content_file>
+ | Response<304, void>
| Response<404, t_basic_error>
| Response<422, t_validation_error>
>
@@ -16187,6 +16277,42 @@ export type SecretScanningListLocationsForAlert = (
>
>
+export type SecretScanningCreatePushProtectionBypassResponder = {
+ with200(): KoaRuntimeResponse
+ with403(): KoaRuntimeResponse
+ with404(): KoaRuntimeResponse
+ with422(): KoaRuntimeResponse
+ with503(): KoaRuntimeResponse<{
+ code?: string
+ documentation_url?: string
+ message?: string
+ }>
+} & KoaRuntimeResponder
+
+export type SecretScanningCreatePushProtectionBypass = (
+ params: Params<
+ t_SecretScanningCreatePushProtectionBypassParamSchema,
+ void,
+ t_SecretScanningCreatePushProtectionBypassBodySchema
+ >,
+ respond: SecretScanningCreatePushProtectionBypassResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_secret_scanning_push_protection_bypass>
+ | Response<403, void>
+ | Response<404, void>
+ | Response<422, void>
+ | Response<
+ 503,
+ {
+ code?: string
+ documentation_url?: string
+ message?: string
+ }
+ >
+>
+
export type SecurityAdvisoriesListRepositoryAdvisoriesResponder = {
with200(): KoaRuntimeResponse
with400(): KoaRuntimeResponse
@@ -20422,6 +20548,7 @@ export type Implementation = {
copilotUsageMetricsForEnterprise: CopilotUsageMetricsForEnterprise
dependabotListAlertsForEnterprise: DependabotListAlertsForEnterprise
secretScanningListAlertsForEnterprise: SecretScanningListAlertsForEnterprise
+ copilotUsageMetricsForEnterpriseTeam: CopilotUsageMetricsForEnterpriseTeam
activityListPublicEvents: ActivityListPublicEvents
activityGetFeeds: ActivityGetFeeds
gistsList: GistsList
@@ -20663,6 +20790,7 @@ export type Implementation = {
billingGetGithubActionsBillingOrg: BillingGetGithubActionsBillingOrg
billingGetGithubPackagesBillingOrg: BillingGetGithubPackagesBillingOrg
billingGetSharedStorageBillingOrg: BillingGetSharedStorageBillingOrg
+ copilotUsageMetricsForTeam: CopilotUsageMetricsForTeam
teamsList: TeamsList
teamsCreate: TeamsCreate
teamsGetByName: TeamsGetByName
@@ -20868,6 +20996,7 @@ export type Implementation = {
codeScanningUpdateDefaultSetup: CodeScanningUpdateDefaultSetup
codeScanningUploadSarif: CodeScanningUploadSarif
codeScanningGetSarif: CodeScanningGetSarif
+ codeSecurityGetConfigurationForRepository: CodeSecurityGetConfigurationForRepository
reposCodeownersErrors: ReposCodeownersErrors
codespacesListInRepositoryForAuthenticatedUser: CodespacesListInRepositoryForAuthenticatedUser
codespacesCreateWithRepoForAuthenticatedUser: CodespacesCreateWithRepoForAuthenticatedUser
@@ -21125,6 +21254,7 @@ export type Implementation = {
secretScanningGetAlert: SecretScanningGetAlert
secretScanningUpdateAlert: SecretScanningUpdateAlert
secretScanningListLocationsForAlert: SecretScanningListLocationsForAlert
+ secretScanningCreatePushProtectionBypass: SecretScanningCreatePushProtectionBypass
securityAdvisoriesListRepositoryAdvisories: SecurityAdvisoriesListRepositoryAdvisories
securityAdvisoriesCreateRepositoryAdvisory: SecurityAdvisoriesCreateRepositoryAdvisory
securityAdvisoriesCreatePrivateVulnerabilityReport: SecurityAdvisoriesCreatePrivateVulnerabilityReport
@@ -23470,6 +23600,87 @@ export function createRouter(implementation: Implementation): KoaRouter {
},
)
+ const copilotUsageMetricsForEnterpriseTeamParamSchema = z.object({
+ enterprise: z.string(),
+ team_slug: z.string(),
+ })
+
+ const copilotUsageMetricsForEnterpriseTeamQuerySchema = z.object({
+ since: z.string().optional(),
+ until: z.string().optional(),
+ page: z.coerce.number().optional(),
+ per_page: z.coerce.number().optional(),
+ })
+
+ const copilotUsageMetricsForEnterpriseTeamResponseValidator =
+ responseValidationFactory(
+ [
+ ["200", z.array(s_copilot_usage_metrics)],
+ ["401", s_basic_error],
+ ["403", s_basic_error],
+ ["404", s_basic_error],
+ ["500", s_basic_error],
+ ],
+ undefined,
+ )
+
+ router.get(
+ "copilotUsageMetricsForEnterpriseTeam",
+ "/enterprises/:enterprise/team/:team_slug/copilot/usage",
+ async (ctx, next) => {
+ const input = {
+ params: parseRequestInput(
+ copilotUsageMetricsForEnterpriseTeamParamSchema,
+ ctx.params,
+ RequestInputType.RouteParam,
+ ),
+ query: parseRequestInput(
+ copilotUsageMetricsForEnterpriseTeamQuerySchema,
+ ctx.query,
+ RequestInputType.QueryString,
+ ),
+ body: undefined,
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(200)
+ },
+ with401() {
+ return new KoaRuntimeResponse(401)
+ },
+ with403() {
+ return new KoaRuntimeResponse(403)
+ },
+ with404() {
+ return new KoaRuntimeResponse(404)
+ },
+ with500() {
+ return new KoaRuntimeResponse(500)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .copilotUsageMetricsForEnterpriseTeam(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = copilotUsageMetricsForEnterpriseTeamResponseValidator(
+ status,
+ body,
+ )
+ ctx.status = status
+ return next()
+ },
+ )
+
const activityListPublicEventsQuerySchema = z.object({
per_page: z.coerce.number().optional(),
page: z.coerce.number().optional(),
@@ -29647,6 +29858,12 @@ export function createRouter(implementation: Implementation): KoaRouter {
description: z.string().max(255),
advanced_security: z.enum(["enabled", "disabled"]).optional(),
dependency_graph: z.enum(["enabled", "disabled", "not_set"]).optional(),
+ dependency_graph_autosubmit_action: z
+ .enum(["enabled", "disabled", "not_set"])
+ .optional(),
+ dependency_graph_autosubmit_action_options: z
+ .object({ labeled_runners: PermissiveBoolean.optional() })
+ .optional(),
dependabot_alerts: z.enum(["enabled", "disabled", "not_set"]).optional(),
dependabot_security_updates: z
.enum(["enabled", "disabled", "not_set"])
@@ -29929,6 +30146,12 @@ export function createRouter(implementation: Implementation): KoaRouter {
description: z.string().max(255).optional(),
advanced_security: z.enum(["enabled", "disabled"]).optional(),
dependency_graph: z.enum(["enabled", "disabled", "not_set"]).optional(),
+ dependency_graph_autosubmit_action: z
+ .enum(["enabled", "disabled", "not_set"])
+ .optional(),
+ dependency_graph_autosubmit_action_options: z
+ .object({ labeled_runners: PermissiveBoolean.optional() })
+ .optional(),
dependabot_alerts: z.enum(["enabled", "disabled", "not_set"]).optional(),
dependabot_security_updates: z
.enum(["enabled", "disabled", "not_set"])
@@ -36999,7 +37222,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const orgsGetAllCustomPropertiesResponseValidator = responseValidationFactory(
[
- ["200", z.array(s_org_custom_property)],
+ ["200", z.array(s_custom_property)],
["403", s_basic_error],
["404", s_basic_error],
],
@@ -37022,7 +37245,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const responder = {
with200() {
- return new KoaRuntimeResponse(200)
+ return new KoaRuntimeResponse(200)
},
with403() {
return new KoaRuntimeResponse(403)
@@ -37055,13 +37278,13 @@ export function createRouter(implementation: Implementation): KoaRouter {
})
const orgsCreateOrUpdateCustomPropertiesBodySchema = z.object({
- properties: z.array(s_org_custom_property).min(1).max(100),
+ properties: z.array(s_custom_property).min(1).max(100),
})
const orgsCreateOrUpdateCustomPropertiesResponseValidator =
responseValidationFactory(
[
- ["200", z.array(s_org_custom_property)],
+ ["200", z.array(s_custom_property)],
["403", s_basic_error],
["404", s_basic_error],
],
@@ -37088,7 +37311,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const responder = {
with200() {
- return new KoaRuntimeResponse(200)
+ return new KoaRuntimeResponse(200)
},
with403() {
return new KoaRuntimeResponse(403)
@@ -37126,7 +37349,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const orgsGetCustomPropertyResponseValidator = responseValidationFactory(
[
- ["200", s_org_custom_property],
+ ["200", s_custom_property],
["403", s_basic_error],
["404", s_basic_error],
],
@@ -37149,7 +37372,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const responder = {
with200() {
- return new KoaRuntimeResponse(200)
+ return new KoaRuntimeResponse(200)
},
with403() {
return new KoaRuntimeResponse(403)
@@ -37201,7 +37424,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const orgsCreateOrUpdateCustomPropertyResponseValidator =
responseValidationFactory(
[
- ["200", s_org_custom_property],
+ ["200", s_custom_property],
["403", s_basic_error],
["404", s_basic_error],
],
@@ -37228,7 +37451,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const responder = {
with200() {
- return new KoaRuntimeResponse(200)
+ return new KoaRuntimeResponse(200)
},
with403() {
return new KoaRuntimeResponse(403)
@@ -38712,6 +38935,83 @@ export function createRouter(implementation: Implementation): KoaRouter {
},
)
+ const copilotUsageMetricsForTeamParamSchema = z.object({
+ org: z.string(),
+ team_slug: z.string(),
+ })
+
+ const copilotUsageMetricsForTeamQuerySchema = z.object({
+ since: z.string().optional(),
+ until: z.string().optional(),
+ page: z.coerce.number().optional(),
+ per_page: z.coerce.number().optional(),
+ })
+
+ const copilotUsageMetricsForTeamResponseValidator = responseValidationFactory(
+ [
+ ["200", z.array(s_copilot_usage_metrics)],
+ ["401", s_basic_error],
+ ["403", s_basic_error],
+ ["404", s_basic_error],
+ ["500", s_basic_error],
+ ],
+ undefined,
+ )
+
+ router.get(
+ "copilotUsageMetricsForTeam",
+ "/orgs/:org/team/:team_slug/copilot/usage",
+ async (ctx, next) => {
+ const input = {
+ params: parseRequestInput(
+ copilotUsageMetricsForTeamParamSchema,
+ ctx.params,
+ RequestInputType.RouteParam,
+ ),
+ query: parseRequestInput(
+ copilotUsageMetricsForTeamQuerySchema,
+ ctx.query,
+ RequestInputType.QueryString,
+ ),
+ body: undefined,
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(200)
+ },
+ with401() {
+ return new KoaRuntimeResponse(401)
+ },
+ with403() {
+ return new KoaRuntimeResponse(403)
+ },
+ with404() {
+ return new KoaRuntimeResponse(404)
+ },
+ with500() {
+ return new KoaRuntimeResponse(500)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .copilotUsageMetricsForTeam(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = copilotUsageMetricsForTeamResponseValidator(status, body)
+ ctx.status = status
+ return next()
+ },
+ )
+
const teamsListParamSchema = z.object({ org: z.string() })
const teamsListQuerySchema = z.object({
@@ -51840,6 +52140,78 @@ export function createRouter(implementation: Implementation): KoaRouter {
},
)
+ const codeSecurityGetConfigurationForRepositoryParamSchema = z.object({
+ owner: z.string(),
+ repo: z.string(),
+ })
+
+ const codeSecurityGetConfigurationForRepositoryResponseValidator =
+ responseValidationFactory(
+ [
+ ["200", s_code_security_configuration_for_repository],
+ ["204", z.undefined()],
+ ["304", z.undefined()],
+ ["403", s_basic_error],
+ ["404", s_basic_error],
+ ],
+ undefined,
+ )
+
+ router.get(
+ "codeSecurityGetConfigurationForRepository",
+ "/repos/:owner/:repo/code-security-configuration",
+ async (ctx, next) => {
+ const input = {
+ params: parseRequestInput(
+ codeSecurityGetConfigurationForRepositoryParamSchema,
+ ctx.params,
+ RequestInputType.RouteParam,
+ ),
+ query: undefined,
+ body: undefined,
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(
+ 200,
+ )
+ },
+ with204() {
+ return new KoaRuntimeResponse(204)
+ },
+ with304() {
+ return new KoaRuntimeResponse(304)
+ },
+ with403() {
+ return new KoaRuntimeResponse(403)
+ },
+ with404() {
+ return new KoaRuntimeResponse(404)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .codeSecurityGetConfigurationForRepository(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = codeSecurityGetConfigurationForRepositoryResponseValidator(
+ status,
+ body,
+ )
+ ctx.status = status
+ return next()
+ },
+ )
+
const reposCodeownersErrorsParamSchema = z.object({
owner: z.string(),
repo: z.string(),
@@ -66800,6 +67172,7 @@ export function createRouter(implementation: Implementation): KoaRouter {
const reposGetReadmeResponseValidator = responseValidationFactory(
[
["200", s_content_file],
+ ["304", z.undefined()],
["404", s_basic_error],
["422", s_validation_error],
],
@@ -66828,6 +67201,9 @@ export function createRouter(implementation: Implementation): KoaRouter {
with200() {
return new KoaRuntimeResponse(200)
},
+ with304() {
+ return new KoaRuntimeResponse(304)
+ },
with404() {
return new KoaRuntimeResponse(404)
},
@@ -68742,6 +69118,98 @@ export function createRouter(implementation: Implementation): KoaRouter {
},
)
+ const secretScanningCreatePushProtectionBypassParamSchema = z.object({
+ owner: z.string(),
+ repo: z.string(),
+ })
+
+ const secretScanningCreatePushProtectionBypassBodySchema = z.object({
+ reason: s_secret_scanning_push_protection_bypass_reason,
+ placeholder_id: s_secret_scanning_push_protection_bypass_placeholder_id,
+ })
+
+ const secretScanningCreatePushProtectionBypassResponseValidator =
+ responseValidationFactory(
+ [
+ ["200", s_secret_scanning_push_protection_bypass],
+ ["403", z.undefined()],
+ ["404", z.undefined()],
+ ["422", z.undefined()],
+ [
+ "503",
+ z.object({
+ code: z.string().optional(),
+ message: z.string().optional(),
+ documentation_url: z.string().optional(),
+ }),
+ ],
+ ],
+ undefined,
+ )
+
+ router.post(
+ "secretScanningCreatePushProtectionBypass",
+ "/repos/:owner/:repo/secret-scanning/push-protection-bypasses",
+ async (ctx, next) => {
+ const input = {
+ params: parseRequestInput(
+ secretScanningCreatePushProtectionBypassParamSchema,
+ ctx.params,
+ RequestInputType.RouteParam,
+ ),
+ query: undefined,
+ body: parseRequestInput(
+ secretScanningCreatePushProtectionBypassBodySchema,
+ Reflect.get(ctx.request, "body"),
+ RequestInputType.RequestBody,
+ ),
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(
+ 200,
+ )
+ },
+ with403() {
+ return new KoaRuntimeResponse(403)
+ },
+ with404() {
+ return new KoaRuntimeResponse(404)
+ },
+ with422() {
+ return new KoaRuntimeResponse(422)
+ },
+ with503() {
+ return new KoaRuntimeResponse<{
+ code?: string
+ documentation_url?: string
+ message?: string
+ }>(503)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .secretScanningCreatePushProtectionBypass(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = secretScanningCreatePushProtectionBypassResponseValidator(
+ status,
+ body,
+ )
+ ctx.status = status
+ return next()
+ },
+ )
+
const securityAdvisoriesListRepositoryAdvisoriesParamSchema = z.object({
owner: z.string(),
repo: z.string(),
diff --git a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/models.ts b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/models.ts
index ffaccf30c..895b23b75 100644
--- a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/models.ts
+++ b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/models.ts
@@ -171,6 +171,7 @@ export type t_api_overview = {
actions?: string[]
actions_macos?: string[]
api?: string[]
+ copilot?: string[]
dependabot?: string[]
domains?: {
actions?: string[]
@@ -1054,6 +1055,10 @@ export type t_code_security_configuration = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
html_url?: string
@@ -1068,6 +1073,19 @@ export type t_code_security_configuration = {
url?: string
}
+export type t_code_security_configuration_for_repository = {
+ configuration?: t_code_security_configuration
+ status?:
+ | "attached"
+ | "attaching"
+ | "detached"
+ | "removed"
+ | "enforced"
+ | "failed"
+ | "updating"
+ | "removed_by_enterprise"
+}
+
export type t_code_security_configuration_repositories = {
repository?: t_simple_repository
status?:
@@ -1602,7 +1620,7 @@ export type t_copilot_seat_breakdown = {
}
export type t_copilot_seat_details = {
- assignee: t_simple_user | t_team | t_organization
+ assignee: t_simple_user
assigning_team?: t_team | t_enterprise_team | null
created_at: string
last_activity_at?: string | null
@@ -1643,6 +1661,17 @@ export type t_custom_deployment_rule_app = {
slug: string
}
+export type t_custom_property = {
+ allowed_values?: string[] | null
+ default_value?: string | string[] | null
+ description?: string | null
+ property_name: string
+ required?: boolean
+ url?: string
+ value_type: "string" | "single_select" | "multi_select" | "true_false"
+ values_editable_by?: "org_actors" | "org_and_repo_actors" | null
+}
+
export type t_custom_property_value = {
property_name: string
value: string | string[] | null
@@ -3799,16 +3828,6 @@ export type t_oidc_custom_sub_repo = {
use_default: boolean
}
-export type t_org_custom_property = {
- allowed_values?: string[] | null
- default_value?: string | string[] | null
- description?: string | null
- property_name: string
- required?: boolean
- value_type: "string" | "single_select" | "multi_select" | "true_false"
- values_editable_by?: "org_actors" | "org_and_repo_actors" | null
-}
-
export type t_org_hook = {
active: boolean
config: {
@@ -3855,44 +3874,6 @@ export type t_org_ruleset_conditions =
| (t_repository_ruleset_conditions &
t_repository_ruleset_conditions_repository_property_target)
-export type t_organization = {
- avatar_url: string
- blog?: string
- company?: string
- created_at: string
- description: string | null
- email?: string
- events_url: string
- followers: number
- following: number
- has_organization_projects: boolean
- has_repository_projects: boolean
- hooks_url: string
- html_url: string
- id: number
- is_verified?: boolean
- issues_url: string
- location?: string
- login: string
- members_url: string
- name?: string
- node_id: string
- plan?: {
- filled_seats?: number
- name?: string
- private_repos?: number
- seats?: number
- space?: number
- }
- public_gists: number
- public_members_url: string
- public_repos: number
- repos_url: string
- type: string
- updated_at: string
- url: string
-}
-
export type t_organization_actions_secret = {
created_at: string
name: string
@@ -5773,6 +5754,7 @@ export type t_repository_ruleset_bypass_actor = {
| "RepositoryRole"
| "Team"
| "DeployKey"
+ | "EnterpriseTeam"
bypass_mode: "always" | "pull_request"
}
@@ -6164,6 +6146,19 @@ export type t_secret_scanning_location_wiki_commit = {
start_line: number
}
+export type t_secret_scanning_push_protection_bypass = {
+ expire_at?: string | null
+ reason?: t_secret_scanning_push_protection_bypass_reason
+ token_type?: string
+}
+
+export type t_secret_scanning_push_protection_bypass_placeholder_id = string
+
+export type t_secret_scanning_push_protection_bypass_reason =
+ | "false_positive"
+ | "used_in_tests"
+ | "will_fix_later"
+
export type t_security_advisory_credit_types =
| "analyst"
| "finder"
@@ -9176,6 +9171,10 @@ export type t_CodeSecurityCreateConfigurationBodySchema = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description: string
enforcement?: "enforced" | "unenforced"
name: string
@@ -9207,6 +9206,11 @@ export type t_CodeSecurityGetConfigurationParamSchema = {
org: string
}
+export type t_CodeSecurityGetConfigurationForRepositoryParamSchema = {
+ owner: string
+ repo: string
+}
+
export type t_CodeSecurityGetConfigurationsForOrgParamSchema = {
org: string
}
@@ -9249,6 +9253,10 @@ export type t_CodeSecurityUpdateConfigurationBodySchema = {
dependabot_alerts?: "enabled" | "disabled" | "not_set"
dependabot_security_updates?: "enabled" | "disabled" | "not_set"
dependency_graph?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"
+ dependency_graph_autosubmit_action_options?: {
+ labeled_runners?: boolean
+ }
description?: string
enforcement?: "enforced" | "unenforced"
name?: string
@@ -9724,6 +9732,18 @@ export type t_CopilotUsageMetricsForEnterpriseQuerySchema = {
until?: string
}
+export type t_CopilotUsageMetricsForEnterpriseTeamParamSchema = {
+ enterprise: string
+ team_slug: string
+}
+
+export type t_CopilotUsageMetricsForEnterpriseTeamQuerySchema = {
+ page?: number
+ per_page?: number
+ since?: string
+ until?: string
+}
+
export type t_CopilotUsageMetricsForOrgParamSchema = {
org: string
}
@@ -9735,6 +9755,18 @@ export type t_CopilotUsageMetricsForOrgQuerySchema = {
until?: string
}
+export type t_CopilotUsageMetricsForTeamParamSchema = {
+ org: string
+ team_slug: string
+}
+
+export type t_CopilotUsageMetricsForTeamQuerySchema = {
+ page?: number
+ per_page?: number
+ since?: string
+ until?: string
+}
+
export type t_DependabotAddSelectedRepoToOrgSecretParamSchema = {
org: string
repository_id: number
@@ -11002,7 +11034,7 @@ export type t_OrgsCreateInvitationParamSchema = {
}
export type t_OrgsCreateOrUpdateCustomPropertiesBodySchema = {
- properties: t_org_custom_property[]
+ properties: t_custom_property[]
}
export type t_OrgsCreateOrUpdateCustomPropertiesParamSchema = {
@@ -14599,6 +14631,16 @@ export type t_SearchUsersQuerySchema = {
sort?: "followers" | "repositories" | "joined"
}
+export type t_SecretScanningCreatePushProtectionBypassBodySchema = {
+ placeholder_id: t_secret_scanning_push_protection_bypass_placeholder_id
+ reason: t_secret_scanning_push_protection_bypass_reason
+}
+
+export type t_SecretScanningCreatePushProtectionBypassParamSchema = {
+ owner: string
+ repo: string
+}
+
export type t_SecretScanningGetAlertParamSchema = {
alert_number: t_alert_number
owner: string
diff --git a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/schemas.ts b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/schemas.ts
index ec793c30a..75a214e77 100644
--- a/integration-tests/typescript-koa/src/generated/api.github.com.yaml/schemas.ts
+++ b/integration-tests/typescript-koa/src/generated/api.github.com.yaml/schemas.ts
@@ -151,6 +151,7 @@ export const s_api_overview = z.object({
actions: z.array(z.string()).optional(),
actions_macos: z.array(z.string()).optional(),
dependabot: z.array(z.string()).optional(),
+ copilot: z.array(z.string()).optional(),
domains: z
.object({
website: z.array(z.string()).optional(),
@@ -464,13 +465,13 @@ export const s_code_scanning_alert_rule = z.object({
export const s_code_scanning_alert_rule_summary = z.object({
id: z.string().nullable().optional(),
name: z.string().optional(),
- tags: z.array(z.string()).nullable().optional(),
severity: z.enum(["none", "note", "warning", "error"]).nullable().optional(),
security_severity_level: z
.enum(["low", "medium", "high", "critical"])
.nullable()
.optional(),
description: z.string().optional(),
+ tags: z.array(z.string()).nullable().optional(),
})
export const s_code_scanning_alert_set_state = z.enum(["open", "dismissed"])
@@ -626,6 +627,12 @@ export const s_code_security_configuration = z.object({
description: z.string().optional(),
advanced_security: z.enum(["enabled", "disabled"]).optional(),
dependency_graph: z.enum(["enabled", "disabled", "not_set"]).optional(),
+ dependency_graph_autosubmit_action: z
+ .enum(["enabled", "disabled", "not_set"])
+ .optional(),
+ dependency_graph_autosubmit_action_options: z
+ .object({ labeled_runners: PermissiveBoolean.optional() })
+ .optional(),
dependabot_alerts: z.enum(["enabled", "disabled", "not_set"]).optional(),
dependabot_security_updates: z
.enum(["enabled", "disabled", "not_set"])
@@ -922,6 +929,23 @@ export const s_custom_deployment_rule_app = z.object({
node_id: z.string(),
})
+export const s_custom_property = z.object({
+ property_name: z.string(),
+ url: z.string().optional(),
+ value_type: z.enum(["string", "single_select", "multi_select", "true_false"]),
+ required: PermissiveBoolean.optional(),
+ default_value: z
+ .union([z.string(), z.array(z.string())])
+ .nullable()
+ .optional(),
+ description: z.string().nullable().optional(),
+ allowed_values: z.array(z.string().max(75)).max(200).nullable().optional(),
+ values_editable_by: z
+ .enum(["org_actors", "org_and_repo_actors"])
+ .nullable()
+ .optional(),
+})
+
export const s_custom_property_value = z.object({
property_name: z.string(),
value: z.union([z.string(), z.array(z.string())]).nullable(),
@@ -1710,22 +1734,6 @@ export const s_oidc_custom_sub_repo = z.object({
include_claim_keys: z.array(z.string()).optional(),
})
-export const s_org_custom_property = z.object({
- property_name: z.string(),
- value_type: z.enum(["string", "single_select", "multi_select", "true_false"]),
- required: PermissiveBoolean.optional(),
- default_value: z
- .union([z.string(), z.array(z.string())])
- .nullable()
- .optional(),
- description: z.string().nullable().optional(),
- allowed_values: z.array(z.string().max(75)).max(200).nullable().optional(),
- values_editable_by: z
- .enum(["org_actors", "org_and_repo_actors"])
- .nullable()
- .optional(),
-})
-
export const s_org_hook = z.object({
id: z.coerce.number(),
url: z.string(),
@@ -1745,46 +1753,6 @@ export const s_org_hook = z.object({
type: z.string(),
})
-export const s_organization = z.object({
- login: z.string(),
- url: z.string(),
- id: z.coerce.number(),
- node_id: z.string(),
- repos_url: z.string(),
- events_url: z.string(),
- hooks_url: z.string(),
- issues_url: z.string(),
- members_url: z.string(),
- public_members_url: z.string(),
- avatar_url: z.string(),
- description: z.string().nullable(),
- blog: z.string().optional(),
- html_url: z.string(),
- name: z.string().optional(),
- company: z.string().optional(),
- location: z.string().optional(),
- email: z.string().email().optional(),
- has_organization_projects: PermissiveBoolean,
- has_repository_projects: PermissiveBoolean,
- is_verified: PermissiveBoolean.optional(),
- public_repos: z.coerce.number(),
- public_gists: z.coerce.number(),
- followers: z.coerce.number(),
- following: z.coerce.number(),
- type: z.string(),
- created_at: z.string().datetime({ offset: true }),
- updated_at: z.string().datetime({ offset: true }),
- plan: z
- .object({
- name: z.string().optional(),
- space: z.coerce.number().optional(),
- private_repos: z.coerce.number().optional(),
- filled_seats: z.coerce.number().optional(),
- seats: z.coerce.number().optional(),
- })
- .optional(),
-})
-
export const s_organization_actions_secret = z.object({
name: z.string(),
created_at: z.string().datetime({ offset: true }),
@@ -2448,6 +2416,7 @@ export const s_repository_ruleset_bypass_actor = z.object({
"RepositoryRole",
"Team",
"DeployKey",
+ "EnterpriseTeam",
]),
bypass_mode: z.enum(["always", "pull_request"]),
})
@@ -2704,6 +2673,15 @@ export const s_secret_scanning_location_wiki_commit = z.object({
commit_url: z.string(),
})
+export const s_secret_scanning_push_protection_bypass_placeholder_id =
+ z.string()
+
+export const s_secret_scanning_push_protection_bypass_reason = z.enum([
+ "false_positive",
+ "used_in_tests",
+ "will_fix_later",
+])
+
export const s_security_advisory_credit_types = z.enum([
"analyst",
"finder",
@@ -3350,6 +3328,22 @@ export const s_code_scanning_variant_analysis_skipped_repo_group = z.object({
repositories: z.array(s_code_scanning_variant_analysis_repository),
})
+export const s_code_security_configuration_for_repository = z.object({
+ status: z
+ .enum([
+ "attached",
+ "attaching",
+ "detached",
+ "removed",
+ "enforced",
+ "failed",
+ "updating",
+ "removed_by_enterprise",
+ ])
+ .optional(),
+ configuration: s_code_security_configuration.optional(),
+})
+
export const s_commit = z.object({
url: z.string(),
sha: z.string(),
@@ -4827,6 +4821,12 @@ export const s_secret_scanning_location = z.object({
.optional(),
})
+export const s_secret_scanning_push_protection_bypass = z.object({
+ reason: s_secret_scanning_push_protection_bypass_reason.optional(),
+ expire_at: z.string().datetime({ offset: true }).nullable().optional(),
+ token_type: z.string().optional(),
+})
+
export const s_simple_classroom_assignment = z.object({
id: z.coerce.number(),
public_repo: PermissiveBoolean,
@@ -5744,7 +5744,7 @@ export const s_converted_note_to_issue_issue_event = z.object({
})
export const s_copilot_seat_details = z.object({
- assignee: z.union([s_simple_user, s_team, s_organization]),
+ assignee: s_simple_user,
organization: s_organization_simple.nullable().optional(),
assigning_team: z.union([s_team, s_enterprise_team]).nullable().optional(),
pending_cancellation_date: z.string().nullable().optional(),
diff --git a/integration-tests/typescript-koa/src/generated/stripe.yaml/generated.ts b/integration-tests/typescript-koa/src/generated/stripe.yaml/generated.ts
index c3ebb1a3a..83d766e70 100644
--- a/integration-tests/typescript-koa/src/generated/stripe.yaml/generated.ts
+++ b/integration-tests/typescript-koa/src/generated/stripe.yaml/generated.ts
@@ -133,6 +133,11 @@ import {
t_GetBalanceTransactionsIdParamSchema,
t_GetBalanceTransactionsIdQuerySchema,
t_GetBalanceTransactionsQuerySchema,
+ t_GetBillingAlertsBodySchema,
+ t_GetBillingAlertsIdBodySchema,
+ t_GetBillingAlertsIdParamSchema,
+ t_GetBillingAlertsIdQuerySchema,
+ t_GetBillingAlertsQuerySchema,
t_GetBillingMetersBodySchema,
t_GetBillingMetersIdBodySchema,
t_GetBillingMetersIdEventSummariesBodySchema,
@@ -579,9 +584,12 @@ import {
t_GetSubscriptionsSubscriptionExposedIdBodySchema,
t_GetSubscriptionsSubscriptionExposedIdParamSchema,
t_GetSubscriptionsSubscriptionExposedIdQuerySchema,
+ t_GetTaxCalculationsCalculationBodySchema,
t_GetTaxCalculationsCalculationLineItemsBodySchema,
t_GetTaxCalculationsCalculationLineItemsParamSchema,
t_GetTaxCalculationsCalculationLineItemsQuerySchema,
+ t_GetTaxCalculationsCalculationParamSchema,
+ t_GetTaxCalculationsCalculationQuerySchema,
t_GetTaxCodesBodySchema,
t_GetTaxCodesIdBodySchema,
t_GetTaxCodesIdParamSchema,
@@ -743,6 +751,13 @@ import {
t_PostApplicationFeesIdRefundsParamSchema,
t_PostAppsSecretsBodySchema,
t_PostAppsSecretsDeleteBodySchema,
+ t_PostBillingAlertsBodySchema,
+ t_PostBillingAlertsIdActivateBodySchema,
+ t_PostBillingAlertsIdActivateParamSchema,
+ t_PostBillingAlertsIdArchiveBodySchema,
+ t_PostBillingAlertsIdArchiveParamSchema,
+ t_PostBillingAlertsIdDeactivateBodySchema,
+ t_PostBillingAlertsIdDeactivateParamSchema,
t_PostBillingMeterEventAdjustmentsBodySchema,
t_PostBillingMeterEventsBodySchema,
t_PostBillingMetersBodySchema,
@@ -1076,6 +1091,7 @@ import {
t_PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivateParamSchema,
t_PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignRejectBodySchema,
t_PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignRejectParamSchema,
+ t_PostTestHelpersIssuingSettlementsBodySchema,
t_PostTestHelpersIssuingTransactionsCreateForceCaptureBodySchema,
t_PostTestHelpersIssuingTransactionsCreateUnlinkedRefundBodySchema,
t_PostTestHelpersIssuingTransactionsTransactionRefundBodySchema,
@@ -1152,6 +1168,7 @@ import {
t_balance,
t_balance_transaction,
t_bank_account,
+ t_billing_alert,
t_billing_meter,
t_billing_meter_event,
t_billing_meter_event_adjustment,
@@ -1307,6 +1324,7 @@ import {
s_balance,
s_balance_transaction,
s_bank_account,
+ s_billing_alert,
s_billing_meter,
s_billing_meter_event,
s_billing_meter_event_adjustment,
@@ -2578,6 +2596,129 @@ export type GetBalanceTransactionsId = (
| Response
>
+export type GetBillingAlertsResponder = {
+ with200(): KoaRuntimeResponse<{
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }>
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type GetBillingAlerts = (
+ params: Params<
+ void,
+ t_GetBillingAlertsQuerySchema,
+ t_GetBillingAlertsBodySchema | undefined
+ >,
+ respond: GetBillingAlertsResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<
+ 200,
+ {
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }
+ >
+ | Response
+>
+
+export type PostBillingAlertsResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type PostBillingAlerts = (
+ params: Params,
+ respond: PostBillingAlertsResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_billing_alert>
+ | Response
+>
+
+export type GetBillingAlertsIdResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type GetBillingAlertsId = (
+ params: Params<
+ t_GetBillingAlertsIdParamSchema,
+ t_GetBillingAlertsIdQuerySchema,
+ t_GetBillingAlertsIdBodySchema | undefined
+ >,
+ respond: GetBillingAlertsIdResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_billing_alert>
+ | Response
+>
+
+export type PostBillingAlertsIdActivateResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type PostBillingAlertsIdActivate = (
+ params: Params<
+ t_PostBillingAlertsIdActivateParamSchema,
+ void,
+ t_PostBillingAlertsIdActivateBodySchema | undefined
+ >,
+ respond: PostBillingAlertsIdActivateResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_billing_alert>
+ | Response
+>
+
+export type PostBillingAlertsIdArchiveResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type PostBillingAlertsIdArchive = (
+ params: Params<
+ t_PostBillingAlertsIdArchiveParamSchema,
+ void,
+ t_PostBillingAlertsIdArchiveBodySchema | undefined
+ >,
+ respond: PostBillingAlertsIdArchiveResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_billing_alert>
+ | Response
+>
+
+export type PostBillingAlertsIdDeactivateResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type PostBillingAlertsIdDeactivate = (
+ params: Params<
+ t_PostBillingAlertsIdDeactivateParamSchema,
+ void,
+ t_PostBillingAlertsIdDeactivateBodySchema | undefined
+ >,
+ respond: PostBillingAlertsIdDeactivateResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_billing_alert>
+ | Response
+>
+
export type PostBillingMeterEventAdjustmentsResponder = {
with200(): KoaRuntimeResponse
withDefault(status: StatusCode): KoaRuntimeResponse
@@ -10308,6 +10449,25 @@ export type PostTaxCalculations = (
| Response
>
+export type GetTaxCalculationsCalculationResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type GetTaxCalculationsCalculation = (
+ params: Params<
+ t_GetTaxCalculationsCalculationParamSchema,
+ t_GetTaxCalculationsCalculationQuerySchema,
+ t_GetTaxCalculationsCalculationBodySchema | undefined
+ >,
+ respond: GetTaxCalculationsCalculationResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_tax_calculation>
+ | Response
+>
+
export type GetTaxCalculationsCalculationLineItemsResponder = {
with200(): KoaRuntimeResponse<{
data: t_tax_calculation_line_item[]
@@ -11499,6 +11659,21 @@ export type PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignRej
| Response
>
+export type PostTestHelpersIssuingSettlementsResponder = {
+ with200(): KoaRuntimeResponse
+ withDefault(status: StatusCode): KoaRuntimeResponse
+} & KoaRuntimeResponder
+
+export type PostTestHelpersIssuingSettlements = (
+ params: Params,
+ respond: PostTestHelpersIssuingSettlementsResponder,
+ ctx: RouterContext,
+) => Promise<
+ | KoaRuntimeResponse
+ | Response<200, t_issuing_settlement>
+ | Response
+>
+
export type PostTestHelpersIssuingTransactionsCreateForceCaptureResponder = {
with200(): KoaRuntimeResponse
withDefault(status: StatusCode): KoaRuntimeResponse
@@ -13134,6 +13309,12 @@ export type Implementation = {
getBalanceHistoryId: GetBalanceHistoryId
getBalanceTransactions: GetBalanceTransactions
getBalanceTransactionsId: GetBalanceTransactionsId
+ getBillingAlerts: GetBillingAlerts
+ postBillingAlerts: PostBillingAlerts
+ getBillingAlertsId: GetBillingAlertsId
+ postBillingAlertsIdActivate: PostBillingAlertsIdActivate
+ postBillingAlertsIdArchive: PostBillingAlertsIdArchive
+ postBillingAlertsIdDeactivate: PostBillingAlertsIdDeactivate
postBillingMeterEventAdjustments: PostBillingMeterEventAdjustments
postBillingMeterEvents: PostBillingMeterEvents
getBillingMeters: GetBillingMeters
@@ -13488,6 +13669,7 @@ export type Implementation = {
deleteSubscriptionsSubscriptionExposedIdDiscount: DeleteSubscriptionsSubscriptionExposedIdDiscount
postSubscriptionsSubscriptionResume: PostSubscriptionsSubscriptionResume
postTaxCalculations: PostTaxCalculations
+ getTaxCalculationsCalculation: GetTaxCalculationsCalculation
getTaxCalculationsCalculationLineItems: GetTaxCalculationsCalculationLineItems
getTaxRegistrations: GetTaxRegistrations
postTaxRegistrations: PostTaxRegistrations
@@ -13545,6 +13727,7 @@ export type Implementation = {
postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate
postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate
postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject
+ postTestHelpersIssuingSettlements: PostTestHelpersIssuingSettlements
postTestHelpersIssuingTransactionsCreateForceCapture: PostTestHelpersIssuingTransactionsCreateForceCapture
postTestHelpersIssuingTransactionsCreateUnlinkedRefund: PostTestHelpersIssuingTransactionsCreateUnlinkedRefund
postTestHelpersIssuingTransactionsTransactionRefund: PostTestHelpersIssuingTransactionsTransactionRefund
@@ -18926,6 +19109,376 @@ export function createRouter(implementation: Implementation): KoaRouter {
},
)
+ const getBillingAlertsQuerySchema = z.object({
+ alert_type: z.enum(["usage_threshold"]).optional(),
+ ending_before: z.string().max(5000).optional(),
+ expand: z
+ .preprocess(
+ (it: unknown) => (Array.isArray(it) || it === undefined ? it : [it]),
+ z.array(z.string().max(5000)),
+ )
+ .optional(),
+ limit: z.coerce.number().optional(),
+ meter: z.string().max(5000).optional(),
+ starting_after: z.string().max(5000).optional(),
+ })
+
+ const getBillingAlertsBodySchema = z.object({}).optional()
+
+ const getBillingAlertsResponseValidator = responseValidationFactory(
+ [
+ [
+ "200",
+ z.object({
+ data: z.array(z.lazy(() => s_billing_alert)),
+ has_more: PermissiveBoolean,
+ object: z.enum(["list"]),
+ url: z.string().max(5000).regex(new RegExp("^/v1/billing/alerts")),
+ }),
+ ],
+ ],
+ s_error,
+ )
+
+ router.get("getBillingAlerts", "/v1/billing/alerts", async (ctx, next) => {
+ const input = {
+ params: undefined,
+ query: parseRequestInput(
+ getBillingAlertsQuerySchema,
+ ctx.query,
+ RequestInputType.QueryString,
+ ),
+ body: parseRequestInput(
+ getBillingAlertsBodySchema,
+ Reflect.get(ctx.request, "body"),
+ RequestInputType.RequestBody,
+ ),
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse<{
+ data: t_billing_alert[]
+ has_more: boolean
+ object: "list"
+ url: string
+ }>(200)
+ },
+ withDefault(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .getBillingAlerts(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = getBillingAlertsResponseValidator(status, body)
+ ctx.status = status
+ return next()
+ })
+
+ const postBillingAlertsBodySchema = z.object({
+ alert_type: z.enum(["usage_threshold"]),
+ expand: z.array(z.string().max(5000)).optional(),
+ filter: z.object({ customer: z.string().max(5000).optional() }).optional(),
+ title: z.string().max(256),
+ usage_threshold_config: z
+ .object({
+ gte: z.coerce.number(),
+ meter: z.string().max(5000).optional(),
+ recurrence: z.enum(["one_time"]),
+ })
+ .optional(),
+ })
+
+ const postBillingAlertsResponseValidator = responseValidationFactory(
+ [["200", s_billing_alert]],
+ s_error,
+ )
+
+ router.post("postBillingAlerts", "/v1/billing/alerts", async (ctx, next) => {
+ const input = {
+ params: undefined,
+ query: undefined,
+ body: parseRequestInput(
+ postBillingAlertsBodySchema,
+ Reflect.get(ctx.request, "body"),
+ RequestInputType.RequestBody,
+ ),
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(200)
+ },
+ withDefault(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ withStatus(status: StatusCode) {
+ return new KoaRuntimeResponse(status)
+ },
+ }
+
+ const response = await implementation
+ .postBillingAlerts(input, responder, ctx)
+ .catch((err) => {
+ throw KoaRuntimeError.HandlerError(err)
+ })
+
+ const { status, body } =
+ response instanceof KoaRuntimeResponse ? response.unpack() : response
+
+ ctx.body = postBillingAlertsResponseValidator(status, body)
+ ctx.status = status
+ return next()
+ })
+
+ const getBillingAlertsIdParamSchema = z.object({ id: z.string().max(5000) })
+
+ const getBillingAlertsIdQuerySchema = z.object({
+ expand: z
+ .preprocess(
+ (it: unknown) => (Array.isArray(it) || it === undefined ? it : [it]),
+ z.array(z.string().max(5000)),
+ )
+ .optional(),
+ })
+
+ const getBillingAlertsIdBodySchema = z.object({}).optional()
+
+ const getBillingAlertsIdResponseValidator = responseValidationFactory(
+ [["200", s_billing_alert]],
+ s_error,
+ )
+
+ router.get(
+ "getBillingAlertsId",
+ "/v1/billing/alerts/:id",
+ async (ctx, next) => {
+ const input = {
+ params: parseRequestInput(
+ getBillingAlertsIdParamSchema,
+ ctx.params,
+ RequestInputType.RouteParam,
+ ),
+ query: parseRequestInput(
+ getBillingAlertsIdQuerySchema,
+ ctx.query,
+ RequestInputType.QueryString,
+ ),
+ body: parseRequestInput(
+ getBillingAlertsIdBodySchema,
+ Reflect.get(ctx.request, "body"),
+ RequestInputType.RequestBody,
+ ),
+ }
+
+ const responder = {
+ with200() {
+ return new KoaRuntimeResponse(200)
+ },
+ withDefault(status: StatusCode) {
+ return new KoaRuntimeResponse