Skip to content

Commit

Permalink
OpenAPI Update (#535)
Browse files Browse the repository at this point in the history
Update OpenAPI for 517205bf85a70b1456a262423b5afecb8abffaef

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
  • Loading branch information
stripe-openapi[bot] authored Nov 17, 2023
1 parent 09d3de2 commit 22cdb59
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 2 deletions.
34 changes: 33 additions & 1 deletion embedded/openapi/spec3.beta.sdk.json
Original file line number Diff line number Diff line change
Expand Up @@ -14125,7 +14125,7 @@
}
},
"event": {
"description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events]\n(/docs/webhooks) so that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.",
"description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.",
"properties": {
"account": {
"description": "The connected account that originates the event.",
Expand Down Expand Up @@ -38664,6 +38664,15 @@
"nullable": true,
"type": "string"
},
"offline": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_offline"
}
],
"description": "Details about payments collected offline.",
"nullable": true
},
"overcapture_supported": {
"description": "Defines whether the authorized amount can be over-captured or not",
"type": "boolean"
Expand Down Expand Up @@ -38704,20 +38713,43 @@
"incremental_authorization_supported",
"last4",
"network",
"offline",
"overcapture_supported",
"read_method",
"receipt"
],
"title": "payment_method_details_card_present",
"type": "object",
"x-expandableFields": [
"offline",
"receipt"
],
"x-stripeResource": {
"class_name": "CardPresent",
"in_package": ""
}
},
"payment_method_details_card_present_offline": {
"description": "",
"properties": {
"stored_at": {
"description": "Time at which the payment was collected while offline",
"format": "unix-time",
"nullable": true,
"type": "integer"
}
},
"required": [
"stored_at"
],
"title": "payment_method_details_card_present_offline",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Offline",
"in_package": ""
}
},
"payment_method_details_card_present_receipt": {
"description": "",
"properties": {
Expand Down
26 changes: 25 additions & 1 deletion embedded/openapi/spec3.json
Original file line number Diff line number Diff line change
Expand Up @@ -9157,7 +9157,7 @@
"type": "object"
},
"event": {
"description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events]\n(/docs/webhooks) so that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.",
"description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.",
"properties": {
"account": {
"description": "The connected account that originates the event.",
Expand Down Expand Up @@ -25300,6 +25300,15 @@
"nullable": true,
"type": "string"
},
"offline": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_offline"
}
],
"description": "Details about payments collected offline.",
"nullable": true
},
"overcapture_supported": {
"description": "Defines whether the authorized amount can be over-captured or not",
"type": "boolean"
Expand Down Expand Up @@ -25335,9 +25344,24 @@
"title": "payment_method_details_card_present",
"type": "object",
"x-expandableFields": [
"offline",
"receipt"
]
},
"payment_method_details_card_present_offline": {
"description": "",
"properties": {
"stored_at": {
"description": "Time at which the payment was collected while offline",
"format": "unix-time",
"nullable": true,
"type": "integer"
}
},
"title": "payment_method_details_card_present_offline",
"type": "object",
"x-expandableFields": []
},
"payment_method_details_card_present_receipt": {
"description": "",
"properties": {
Expand Down

0 comments on commit 22cdb59

Please sign in to comment.