From 274a2e34fdeee074663d5ca598bc3f5cde494641 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 19 Sep 2023 23:40:25 +0000 Subject: [PATCH] Update OpenAPI specification --- openapi/spec3.beta.sdk.json | 38 ++++++++--------- openapi/spec3.beta.sdk.yaml | 83 +++++++++++++++++-------------------- openapi/spec3.json | 36 ++++++++-------- openapi/spec3.sdk.json | 38 ++++++++--------- openapi/spec3.sdk.yaml | 83 +++++++++++++++++-------------------- openapi/spec3.yaml | 79 ++++++++++++++++------------------- 6 files changed, 166 insertions(+), 191 deletions(-) diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index 7d90d031..4ca7d6d3 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -13101,7 +13101,7 @@ } }, "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.", @@ -13109,13 +13109,13 @@ "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" @@ -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" @@ -13266,7 +13266,7 @@ } }, "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.", @@ -13274,11 +13274,11 @@ "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" @@ -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, @@ -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" }, @@ -83570,7 +83570,7 @@ }, "/v1/files": { "get": { - "description": "

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.

", + "description": "

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.

", "operationId": "GetFiles", "parameters": [ { @@ -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, @@ -83759,7 +83759,7 @@ } }, "post": { - "description": "

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

", + "description": "

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

", "operationId": "PostFiles", "requestBody": { "content": { @@ -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" }, @@ -83885,7 +83885,7 @@ }, "/v1/files/{file}": { "get": { - "description": "

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 File Upload Guide.

", + "description": "

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

", "operationId": "GetFilesFile", "parameters": [ { diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index b38a02e6..6db20b9d 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -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)). @@ -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 @@ -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 @@ -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: @@ -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 @@ -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 @@ -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: @@ -76240,9 +76235,9 @@ paths: /v1/files: get: description: >- -

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.

+

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.

operationId: GetFiles parameters: - explode: true @@ -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 @@ -76396,14 +76391,13 @@ paths: description: Error response. post: description: >- -

To upload a file to Stripe, you’ll need to send a request of type - multipart/form-data. The request should contain the file - you would like to upload, as well as the parameters for creating a - file.

+

To upload a file to Stripe, you need to send a request of type + multipart/form-data. Include the file you want to upload in + the request, and the parameters for creating a file.

-

All of Stripe’s officially supported Client libraries should have - support for sending multipart/form-data.

+

All of Stripe’s officially supported Client libraries support sending + multipart/form-data.

operationId: PostFiles requestBody: content: @@ -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: @@ -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: @@ -76514,11 +76506,10 @@ paths: '/v1/files/{file}': get: description: >- -

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 File Upload - Guide.

+

Retrieves the details of an existing file object. After you supply a + unique file ID, Stripe returns the corresponding file object. Learn how + to access file + contents.

operationId: GetFilesFile parameters: - description: Specifies which fields in the response should be expanded. diff --git a/openapi/spec3.json b/openapi/spec3.json index f2de6a8f..0b9a8903 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -9297,7 +9297,7 @@ "x-resourceId": "fee_refund" }, "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.", @@ -9305,13 +9305,13 @@ "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" @@ -9392,23 +9392,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" @@ -9429,7 +9429,7 @@ "x-resourceId": "file" }, "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.", @@ -9437,11 +9437,11 @@ "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" @@ -69509,7 +69509,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, @@ -69651,7 +69651,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" }, @@ -69891,7 +69891,7 @@ }, "/v1/files": { "get": { - "description": "

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.

", + "description": "

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.

", "operationId": "GetFiles", "parameters": [ { @@ -69963,7 +69963,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, @@ -70076,7 +70076,7 @@ } }, "post": { - "description": "

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

", + "description": "

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

", "operationId": "PostFiles", "requestBody": { "content": { @@ -70103,12 +70103,12 @@ "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": { "type": "boolean" @@ -70199,7 +70199,7 @@ }, "/v1/files/{file}": { "get": { - "description": "

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 File Upload Guide.

", + "description": "

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

", "operationId": "GetFilesFile", "parameters": [ { diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json index 18485372..92e5d7f2 100644 --- a/openapi/spec3.sdk.json +++ b/openapi/spec3.sdk.json @@ -11560,7 +11560,7 @@ } }, "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.", @@ -11568,13 +11568,13 @@ "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" @@ -11655,23 +11655,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" @@ -11725,7 +11725,7 @@ } }, "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.", @@ -11733,11 +11733,11 @@ "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" @@ -72476,7 +72476,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, @@ -72618,7 +72618,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" }, @@ -72858,7 +72858,7 @@ }, "/v1/files": { "get": { - "description": "

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.

", + "description": "

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.

", "operationId": "GetFiles", "parameters": [ { @@ -72934,7 +72934,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, @@ -73047,7 +73047,7 @@ } }, "post": { - "description": "

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

", + "description": "

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n\n

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

", "operationId": "PostFiles", "requestBody": { "content": { @@ -73074,19 +73074,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" }, @@ -73173,7 +73173,7 @@ }, "/v1/files/{file}": { "get": { - "description": "

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 File Upload Guide.

", + "description": "

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

", "operationId": "GetFilesFile", "parameters": [ { diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml index 73116c32..81c52347 100644 --- a/openapi/spec3.sdk.yaml +++ b/openapi/spec3.sdk.yaml @@ -10926,14 +10926,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)). @@ -10947,14 +10948,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 @@ -11029,22 +11028,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 @@ -11087,7 +11084,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: @@ -11097,10 +11094,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 @@ -66662,8 +66659,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 @@ -66776,9 +66773,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: @@ -66951,9 +66946,9 @@ paths: /v1/files: get: description: >- -

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.

+

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.

operationId: GetFiles parameters: - explode: true @@ -67013,8 +67008,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 @@ -67107,14 +67102,13 @@ paths: description: Error response. post: description: >- -

To upload a file to Stripe, you’ll need to send a request of type - multipart/form-data. The request should contain the file - you would like to upload, as well as the parameters for creating a - file.

+

To upload a file to Stripe, you need to send a request of type + multipart/form-data. Include the file you want to upload in + the request, and the parameters for creating a file.

-

All of Stripe’s officially supported Client libraries should have - support for sending multipart/form-data.

+

All of Stripe’s officially supported Client libraries support sending + multipart/form-data.

operationId: PostFiles requestBody: content: @@ -67137,14 +67131,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: @@ -67159,9 +67153,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: @@ -67225,11 +67217,10 @@ paths: '/v1/files/{file}': get: description: >- -

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 File Upload - Guide.

+

Retrieves the details of an existing file object. After you supply a + unique file ID, Stripe returns the corresponding file object. Learn how + to access file + contents.

operationId: GetFilesFile parameters: - description: Specifies which fields in the response should be expanded. diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml index ca3946e8..fe03ca18 100644 --- a/openapi/spec3.yaml +++ b/openapi/spec3.yaml @@ -9077,14 +9077,15 @@ components: x-resourceId: fee_refund 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)). @@ -9098,14 +9099,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 @@ -9180,22 +9179,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 @@ -9213,7 +9210,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: @@ -9223,10 +9220,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 @@ -61199,8 +61196,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 @@ -61313,9 +61310,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: @@ -61488,9 +61483,9 @@ paths: /v1/files: get: description: >- -

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.

+

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.

operationId: GetFiles parameters: - explode: true @@ -61546,8 +61541,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 @@ -61640,14 +61635,13 @@ paths: description: Error response. post: description: >- -

To upload a file to Stripe, you’ll need to send a request of type - multipart/form-data. The request should contain the file - you would like to upload, as well as the parameters for creating a - file.

+

To upload a file to Stripe, you need to send a request of type + multipart/form-data. Include the file you want to upload in + the request, and the parameters for creating a file.

-

All of Stripe’s officially supported Client libraries should have - support for sending multipart/form-data.

+

All of Stripe’s officially supported Client libraries support sending + multipart/form-data.

operationId: PostFiles requestBody: content: @@ -61670,14 +61664,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: @@ -61739,11 +61733,10 @@ paths: '/v1/files/{file}': get: description: >- -

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 File Upload - Guide.

+

Retrieves the details of an existing file object. After you supply a + unique file ID, Stripe returns the corresponding file object. Learn how + to access file + contents.

operationId: GetFilesFile parameters: - description: Specifies which fields in the response should be expanded.