Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Sep 19, 2023
1 parent ccf293e commit 274a2e3
Show file tree
Hide file tree
Showing 6 changed files with 166 additions and 191 deletions.
38 changes: 19 additions & 19 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13101,21 +13101,21 @@
}
},
"file": {
"description": "This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
"description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independetly (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"expires_at": {
"description": "The time at which the file expires and is no longer available in epoch seconds.",
"description": "The file expires and isn't available at this time in epoch seconds.",
"format": "unix-time",
"nullable": true,
"type": "integer"
},
"filename": {
"description": "A filename for the file, suitable for saving to a filesystem.",
"description": "The suitable name for saving the file to a filesystem.",
"maxLength": 5000,
"nullable": true,
"type": "string"
Expand Down Expand Up @@ -13196,23 +13196,23 @@
"x-stripeBypassValidation": true
},
"size": {
"description": "The size in bytes of the file object.",
"description": "The size of the file object in bytes.",
"type": "integer"
},
"title": {
"description": "A user friendly title for the document.",
"description": "A suitable title for the document.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"type": {
"description": "The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).",
"description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"url": {
"description": "The URL from which the file can be downloaded using your live secret API key.",
"description": "Use your live secret API key to download the file from this URL.",
"maxLength": 5000,
"nullable": true,
"type": "string"
Expand Down Expand Up @@ -13266,19 +13266,19 @@
}
},
"file_link": {
"description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that can be used to\nretrieve the contents of the file without authentication.",
"description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"expired": {
"description": "Whether this link is already expired.",
"description": "Returns if the link is already expired.",
"type": "boolean"
},
"expires_at": {
"description": "Time at which the link expires.",
"description": "Time that the link expires.",
"format": "unix-time",
"nullable": true,
"type": "integer"
Expand Down Expand Up @@ -83188,7 +83188,7 @@
"style": "deepObject"
},
{
"description": "Filter links by their expiration status. By default, all links are returned.",
"description": "Filter links by their expiration status. By default, Stripe returns all links.",
"in": "query",
"name": "expired",
"required": false,
Expand Down Expand Up @@ -83330,7 +83330,7 @@
"type": "array"
},
"expires_at": {
"description": "A future timestamp after which the link will no longer be usable.",
"description": "The link isn't usable after this future timestamp.",
"format": "unix-time",
"type": "integer"
},
Expand Down Expand Up @@ -83570,7 +83570,7 @@
},
"/v1/files": {
"get": {
"description": "<p>Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.</p>",
"description": "<p>Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.</p>",
"operationId": "GetFiles",
"parameters": [
{
Expand Down Expand Up @@ -83646,7 +83646,7 @@
"style": "form"
},
{
"description": "The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.",
"description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.",
"in": "query",
"name": "purpose",
"required": false,
Expand Down Expand Up @@ -83759,7 +83759,7 @@
}
},
"post": {
"description": "<p>To upload a file to Stripe, you’ll need to send a request of type <code>multipart/form-data</code>. The request should contain the file you would like to upload, as well as the parameters for creating a file.</p>\n\n<p>All of Stripe’s officially supported Client libraries should have support for sending <code>multipart/form-data</code>.</p>",
"description": "<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and the parameters for creating a file.</p>\n\n<p>All of Stripe’s officially supported Client libraries support sending <code>multipart/form-data</code>.</p>",
"operationId": "PostFiles",
"requestBody": {
"content": {
Expand All @@ -83786,19 +83786,19 @@
"type": "array"
},
"file": {
"description": "A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol).",
"description": "A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.",
"format": "binary",
"type": "string"
},
"file_link_data": {
"description": "Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
"description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
"properties": {
"create": {
"description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"type": "boolean"
},
"expires_at": {
"description": "A future timestamp after which the link will no longer be usable.",
"description": "The link isn't available after this future timestamp.",
"format": "unix-time",
"type": "integer"
},
Expand Down Expand Up @@ -83885,7 +83885,7 @@
},
"/v1/files/{file}": {
"get": {
"description": "<p>Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the <a href=\"/docs/file-upload#download-file-contents\">File Upload Guide</a>.</p>",
"description": "<p>Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href=\"/docs/file-upload#download-file-contents\">access file contents</a>.</p>",
"operationId": "GetFilesFile",
"parameters": [
{
Expand Down
83 changes: 37 additions & 46 deletions openapi/spec3.beta.sdk.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12295,14 +12295,15 @@ components:
- balance_transaction_source
file:
description: >-
This is an object representing a file hosted on Stripe's servers. The
This object represents files hosted on Stripe's servers. You can upload

file may have been uploaded by yourself using the [create
file](https://stripe.com/docs/api#create_file)
files with the [create file](https://stripe.com/docs/api#create_file)
request

request (for example, when uploading dispute evidence) or it may have
(for example, when uploading dispute evidence). Stripe also

been created by Stripe (for example, the results of a [Sigma scheduled
creates files independetly (for example, the results of a [Sigma
scheduled

query](#scheduled_queries)).

Expand All @@ -12316,14 +12317,12 @@ components:
format: unix-time
type: integer
expires_at:
description: >-
The time at which the file expires and is no longer available in
epoch seconds.
description: The file expires and isn't available at this time in epoch seconds.
format: unix-time
nullable: true
type: integer
filename:
description: 'A filename for the file, suitable for saving to a filesystem.'
description: The suitable name for saving the file to a filesystem.
maxLength: 5000
nullable: true
type: string
Expand Down Expand Up @@ -12398,22 +12397,20 @@ components:
type: string
x-stripeBypassValidation: true
size:
description: The size in bytes of the file object.
description: The size of the file object in bytes.
type: integer
title:
description: A user friendly title for the document.
description: A suitable title for the document.
maxLength: 5000
nullable: true
type: string
type:
description: 'The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).'
description: 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).'
maxLength: 5000
nullable: true
type: string
url:
description: >-
The URL from which the file can be downloaded using your live secret
API key.
description: Use your live secret API key to download the file from this URL.
maxLength: 5000
nullable: true
type: string
Expand Down Expand Up @@ -12456,7 +12453,7 @@ components:
file_link:
description: |-
To share the contents of a `File` object with non-Stripe users, you can
create a `FileLink`. `FileLink`s contain a URL that can be used to
create a `FileLink`. `FileLink`s contain a URL that you can use to
retrieve the contents of the file without authentication.
properties:
created:
Expand All @@ -12466,10 +12463,10 @@ components:
format: unix-time
type: integer
expired:
description: Whether this link is already expired.
description: Returns if the link is already expired.
type: boolean
expires_at:
description: Time at which the link expires.
description: Time that the link expires.
format: unix-time
nullable: true
type: integer
Expand Down Expand Up @@ -75951,8 +75948,8 @@ paths:
type: array
style: deepObject
- description: >-
Filter links by their expiration status. By default, all links are
returned.
Filter links by their expiration status. By default, Stripe returns
all links.
in: query
name: expired
required: false
Expand Down Expand Up @@ -76065,9 +76062,7 @@ paths:
type: string
type: array
expires_at:
description: >-
A future timestamp after which the link will no longer be
usable.
description: The link isn't usable after this future timestamp.
format: unix-time
type: integer
file:
Expand Down Expand Up @@ -76240,9 +76235,9 @@ paths:
/v1/files:
get:
description: >-
<p>Returns a list of the files that your account has access to. The
files are returned sorted by creation date, with the most recently
created files appearing first.</p>
<p>Returns a list of the files that your account has access to. Stripe
sorts and returns the files by their creation dates, placing the most
recently created files at the top.</p>
operationId: GetFiles
parameters:
- explode: true
Expand Down Expand Up @@ -76302,8 +76297,8 @@ paths:
type: integer
style: form
- description: >-
The file purpose to filter queries by. If none is provided, files
will not be filtered by purpose.
Filter queries by the file purpose. If you don't provide a purpose,
the queries return unfiltered files.
in: query
name: purpose
required: false
Expand Down Expand Up @@ -76396,14 +76391,13 @@ paths:
description: Error response.
post:
description: >-
<p>To upload a file to Stripe, you’ll need to send a request of type
<code>multipart/form-data</code>. The request should contain the file
you would like to upload, as well as the parameters for creating a
file.</p>
<p>To upload a file to Stripe, you need to send a request of type
<code>multipart/form-data</code>. Include the file you want to upload in
the request, and the parameters for creating a file.</p>


<p>All of Stripe’s officially supported Client libraries should have
support for sending <code>multipart/form-data</code>.</p>
<p>All of Stripe’s officially supported Client libraries support sending
<code>multipart/form-data</code>.</p>
operationId: PostFiles
requestBody:
content:
Expand All @@ -76426,14 +76420,14 @@ paths:
type: array
file:
description: >-
A file to upload. The file should follow the specifications
of RFC 2388 (which defines file transfers for the
`multipart/form-data` protocol).
A file to upload. Make sure that the specifications follow
RFC 2388, which defines file transfers for the
`multipart/form-data` protocol.
format: binary
type: string
file_link_data:
description: >-
Optional parameters to automatically create a [file
Optional parameters that automatically create a [file
link](https://stripe.com/docs/api#file_links) for the newly
created file.
properties:
Expand All @@ -76448,9 +76442,7 @@ paths:
`terminal_reader_splashscreen`.
type: boolean
expires_at:
description: >-
A future timestamp after which the link will no longer
be usable.
description: The link isn't available after this future timestamp.
format: unix-time
type: integer
metadata:
Expand Down Expand Up @@ -76514,11 +76506,10 @@ paths:
'/v1/files/{file}':
get:
description: >-
<p>Retrieves the details of an existing file object. Supply the unique
file ID from a file, and Stripe will return the corresponding file
object. To access file contents, see the <a
href="/docs/file-upload#download-file-contents">File Upload
Guide</a>.</p>
<p>Retrieves the details of an existing file object. After you supply a
unique file ID, Stripe returns the corresponding file object. Learn how
to <a href="/docs/file-upload#download-file-contents">access file
contents</a>.</p>
operationId: GetFilesFile
parameters:
- description: Specifies which fields in the response should be expanded.
Expand Down
Loading

0 comments on commit 274a2e3

Please sign in to comment.