Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Apr 3, 2024
1 parent 4282f2e commit cbd0602
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions json/TfmAPIService-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,7 @@
"components" : {
"schemas" : {
"Address" : {
"additionalProperties" : false,
"properties" : {
"city" : {
"type" : "string"
Expand All @@ -694,6 +695,7 @@
"type" : "object"
},
"AssignTerminalsRequest" : {
"additionalProperties" : false,
"properties" : {
"companyAccount" : {
"description" : "Your company account. To return terminals to the company inventory, specify only this parameter and the `terminals`.",
Expand Down Expand Up @@ -726,6 +728,7 @@
"type" : "object"
},
"AssignTerminalsResponse" : {
"additionalProperties" : false,
"properties" : {
"results" : {
"additionalProperties" : {
Expand All @@ -741,6 +744,7 @@
"type" : "object"
},
"FindTerminalRequest" : {
"additionalProperties" : false,
"properties" : {
"terminal" : {
"description" : "The unique terminal ID in the format `[Device model]-[Serial number]`. \n\nFor example, **V400m-324689776**.",
Expand All @@ -753,6 +757,7 @@
"type" : "object"
},
"FindTerminalResponse" : {
"additionalProperties" : false,
"properties" : {
"companyAccount" : {
"description" : "The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.",
Expand Down Expand Up @@ -782,6 +787,7 @@
"type" : "object"
},
"GetStoresUnderAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"companyAccount" : {
"description" : "The company account. If you only specify this parameter, the response includes the stores of all merchant accounts that are associated with the company account.",
Expand All @@ -798,6 +804,7 @@
"type" : "object"
},
"GetStoresUnderAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"stores" : {
"description" : "Array that returns a list of all stores for the specified merchant account, or for all merchant accounts under the company account.",
Expand All @@ -810,6 +817,7 @@
"type" : "object"
},
"GetTerminalDetailsRequest" : {
"additionalProperties" : false,
"properties" : {
"terminal" : {
"description" : "The unique terminal ID in the format `[Device model]-[Serial number]`. \n\nFor example, **V400m-324689776**.",
Expand All @@ -822,6 +830,7 @@
"type" : "object"
},
"GetTerminalDetailsResponse" : {
"additionalProperties" : false,
"properties" : {
"bluetoothIp" : {
"description" : "The Bluetooth IP address of the terminal.",
Expand Down Expand Up @@ -947,6 +956,7 @@
"type" : "object"
},
"GetTerminalsUnderAccountRequest" : {
"additionalProperties" : false,
"properties" : {
"companyAccount" : {
"description" : "Your company account. If you only specify this parameter, the response includes all terminals at all account levels.",
Expand All @@ -967,6 +977,7 @@
"type" : "object"
},
"GetTerminalsUnderAccountResponse" : {
"additionalProperties" : false,
"properties" : {
"companyAccount" : {
"description" : "Your company account.",
Expand All @@ -993,6 +1004,7 @@
"type" : "object"
},
"MerchantAccount" : {
"additionalProperties" : false,
"properties" : {
"inStoreTerminals" : {
"description" : "List of terminals assigned to this merchant account as in-store terminals. This means that the terminal is ready to be boarded, or is already boarded.",
Expand Down Expand Up @@ -1026,6 +1038,7 @@
"type" : "object"
},
"ServiceError" : {
"additionalProperties" : false,
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
Expand All @@ -1052,6 +1065,7 @@
"type" : "object"
},
"Store" : {
"additionalProperties" : false,
"properties" : {
"address" : {
"description" : "The address of the store.",
Expand Down
14 changes: 14 additions & 0 deletions yaml/TfmAPIService-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ paths:
components:
schemas:
Address:
additionalProperties: false
properties:
city:
type: string
Expand All @@ -471,6 +472,7 @@ components:
type: string
type: object
AssignTerminalsRequest:
additionalProperties: false
properties:
companyAccount:
description: Your company account. To return terminals to the company inventory,
Expand Down Expand Up @@ -513,6 +515,7 @@ components:
- terminals
type: object
AssignTerminalsResponse:
additionalProperties: false
properties:
results:
additionalProperties:
Expand All @@ -530,6 +533,7 @@ components:
- results
type: object
FindTerminalRequest:
additionalProperties: false
properties:
terminal:
description: "The unique terminal ID in the format `[Device model]-[Serial\
Expand All @@ -539,6 +543,7 @@ components:
- terminal
type: object
FindTerminalResponse:
additionalProperties: false
properties:
companyAccount:
description: The company account that the terminal is associated with. If
Expand Down Expand Up @@ -575,6 +580,7 @@ components:
- terminal
type: object
GetStoresUnderAccountRequest:
additionalProperties: false
properties:
companyAccount:
description: The company account. If you only specify this parameter, the
Expand All @@ -589,6 +595,7 @@ components:
- companyAccount
type: object
GetStoresUnderAccountResponse:
additionalProperties: false
properties:
stores:
description: Array that returns a list of all stores for the specified merchant
Expand All @@ -598,6 +605,7 @@ components:
type: array
type: object
GetTerminalDetailsRequest:
additionalProperties: false
properties:
terminal:
description: "The unique terminal ID in the format `[Device model]-[Serial\
Expand All @@ -607,6 +615,7 @@ components:
- terminal
type: object
GetTerminalDetailsResponse:
additionalProperties: false
properties:
bluetoothIp:
description: The Bluetooth IP address of the terminal.
Expand Down Expand Up @@ -730,6 +739,7 @@ components:
- terminal
type: object
GetTerminalsUnderAccountRequest:
additionalProperties: false
properties:
companyAccount:
description: Your company account. If you only specify this parameter, the
Expand All @@ -749,6 +759,7 @@ components:
- companyAccount
type: object
GetTerminalsUnderAccountResponse:
additionalProperties: false
properties:
companyAccount:
description: Your company account.
Expand All @@ -769,6 +780,7 @@ components:
- companyAccount
type: object
MerchantAccount:
additionalProperties: false
properties:
inStoreTerminals:
description: List of terminals assigned to this merchant account as in-store
Expand All @@ -795,6 +807,7 @@ components:
- merchantAccount
type: object
ServiceError:
additionalProperties: false
properties:
errorCode:
description: The error code mapped to the error message.
Expand All @@ -814,6 +827,7 @@ components:
type: integer
type: object
Store:
additionalProperties: false
properties:
address:
description: The address of the store.
Expand Down

0 comments on commit cbd0602

Please sign in to comment.