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 Aug 27, 2024
1 parent 457bce9 commit 816b29f
Show file tree
Hide file tree
Showing 2 changed files with 275 additions and 0 deletions.
156 changes: 156 additions & 0 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2621,6 +2621,7 @@
"taxes_calculation_failed",
"terminal_location_country_unsupported",
"terminal_reader_busy",
"terminal_reader_collected_data_invalid",
"terminal_reader_hardware_fault",
"terminal_reader_invalid_location_for_payment",
"terminal_reader_offline",
Expand Down Expand Up @@ -67472,6 +67473,75 @@
"type": "terminal.reader.action_updated"
}
},
"terminal.reader_collected_data": {
"description": "Returns data collected by Terminal readers. This data is only stored for 24 hours.",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"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"
},
"magstripe": {
"anyOf": [
{
"$ref": "#/components/schemas/terminal_reader_collected_data_resource_magstripe_data"
}
],
"description": "The magstripe data collected by the reader.",
"nullable": true
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"terminal.reader_collected_data"
],
"type": "string"
},
"type": {
"description": "The type of data collected by the reader.",
"enum": [
"magstripe"
],
"type": "string"
}
},
"required": [
"created",
"id",
"livemode",
"magstripe",
"object",
"type"
],
"title": "TerminalReaderCollectedData",
"type": "object",
"x-expandableFields": [
"magstripe"
],
"x-resourceId": "terminal.reader_collected_data",
"x-stripeOperations": [
{
"method_name": "retrieve",
"method_on": "service",
"method_type": "retrieve",
"operation": "get",
"path": "/v1/terminal/reader_collected_data/{reader_collected_data}"
}
],
"x-stripeResource": {
"class_name": "ReaderCollectedData",
"in_package": "Terminal"
}
},
"terminal_configuration_configuration_resource_currency_specific_config": {
"description": "",
"properties": {
Expand Down Expand Up @@ -67630,6 +67700,23 @@
"usd"
]
},
"terminal_reader_collected_data_resource_magstripe_data": {
"description": "Represents magstripe data collected by the reader.",
"properties": {
"data": {
"description": "The raw magstripe data collected by the reader.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"required": [
"data"
],
"title": "TerminalReaderCollectedDataResourceMagstripeData",
"type": "object",
"x-expandableFields": []
},
"terminal_reader_reader_resource_cart": {
"description": "Represents a cart to be displayed on the reader",
"properties": {
Expand Down Expand Up @@ -196690,6 +196777,75 @@
}
}
},
"/v1/terminal/reader_collected_data/{reader_collected_data}": {
"get": {
"description": "<p>Retrieve data collected using Reader hardware.</p>",
"operationId": "GetTerminalReaderCollectedDataReaderCollectedData",
"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"
},
{
"description": "The ID of the ReaderCollectedData to retrieve.",
"in": "path",
"name": "reader_collected_data",
"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/terminal.reader_collected_data"
}
}
},
"description": "Successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
},
"description": "Error response."
}
}
}
},
"/v1/terminal/readers": {
"get": {
"description": "<p>Returns a list of <code>Reader</code> objects.</p>",
Expand Down
119 changes: 119 additions & 0 deletions openapi/spec3.beta.sdk.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2563,6 +2563,7 @@ components:
- taxes_calculation_failed
- terminal_location_country_unsupported
- terminal_reader_busy
- terminal_reader_collected_data_invalid
- terminal_reader_hardware_fault
- terminal_reader_invalid_location_for_payment
- terminal_reader_offline
Expand Down Expand Up @@ -61630,6 +61631,65 @@ components:
x-expandableFields: []
x-stripeEvent:
type: terminal.reader.action_updated
terminal.reader_collected_data:
description: >-
Returns data collected by Terminal readers. This data is only stored for
24 hours.
properties:
created:
description: >-
Time at which the object was created. Measured in seconds since the
Unix epoch.
format: unix-time
type: integer
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
magstripe:
anyOf:
- $ref: >-
#/components/schemas/terminal_reader_collected_data_resource_magstripe_data
description: The magstripe data collected by the reader.
nullable: true
object:
description: >-
String representing the object's type. Objects of the same type
share the same value.
enum:
- terminal.reader_collected_data
type: string
type:
description: The type of data collected by the reader.
enum:
- magstripe
type: string
required:
- created
- id
- livemode
- magstripe
- object
- type
title: TerminalReaderCollectedData
type: object
x-expandableFields:
- magstripe
x-resourceId: terminal.reader_collected_data
x-stripeOperations:
- method_name: retrieve
method_on: service
method_type: retrieve
operation: get
path: '/v1/terminal/reader_collected_data/{reader_collected_data}'
x-stripeResource:
class_name: ReaderCollectedData
in_package: Terminal
terminal_configuration_configuration_resource_currency_specific_config:
description: ''
properties:
Expand Down Expand Up @@ -61766,6 +61826,19 @@ components:
- sek
- sgd
- usd
terminal_reader_collected_data_resource_magstripe_data:
description: Represents magstripe data collected by the reader.
properties:
data:
description: The raw magstripe data collected by the reader.
maxLength: 5000
nullable: true
type: string
required:
- data
title: TerminalReaderCollectedDataResourceMagstripeData
type: object
x-expandableFields: []
terminal_reader_reader_resource_cart:
description: Represents a cart to be displayed on the reader
properties:
Expand Down Expand Up @@ -187643,6 +187716,52 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
'/v1/terminal/reader_collected_data/{reader_collected_data}':
get:
description: <p>Retrieve data collected using Reader hardware.</p>
operationId: GetTerminalReaderCollectedDataReaderCollectedData
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
- description: The ID of the ReaderCollectedData to retrieve.
in: path
name: reader_collected_data
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/terminal.reader_collected_data'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
/v1/terminal/readers:
get:
description: <p>Returns a list of <code>Reader</code> objects.</p>
Expand Down

0 comments on commit 816b29f

Please sign in to comment.