Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jul 5, 2023
1 parent 91bf701 commit c00266f
Show file tree
Hide file tree
Showing 6 changed files with 651 additions and 0 deletions.
132 changes: 132 additions & 0 deletions json/LegalEntityService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2100,6 +2100,108 @@
}
}
},
"/legalEntities/{id}/termsOfServiceStatus" : {
"get" : {
"tags" : [
"Terms of Service"
],
"summary" : "Get Terms of Service status",
"description" : "Returns the required types of Terms of Service that need to be accepted by a legal entity.",
"x-addedInVersion" : "1",
"operationId" : "get-legalEntities-id-termsOfServiceStatus",
"x-groupName" : "Terms of Service",
"x-sortIndex" : 4,
"x-methodName" : "getTermsOfServiceStatus",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CalculateTermsOfServiceStatusResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/themes" : {
"get" : {
"tags" : [
Expand Down Expand Up @@ -3015,6 +3117,27 @@
],
"type" : "object"
},
"CalculateTermsOfServiceStatusResponse" : {
"properties" : {
"termsOfServiceTypes" : {
"description" : "The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted.",
"items" : {
"enum" : [
"adyenAccount",
"adyenCapital",
"adyenCard",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenFranchisee",
"adyenIssuing"
],
"type" : "string"
},
"type" : "array"
}
},
"type" : "object"
},
"CapabilityProblem" : {
"properties" : {
"entity" : {
Expand Down Expand Up @@ -4636,6 +4759,15 @@
]
}
},
"get-legalEntities-id-termsOfServiceStatus-success-200" : {
"summary" : "Terms of Service status for a legal entity",
"description" : "Example response when getting the type of Terms of Service",
"value" : {
"termsOfServiceTypes" : [
"adyenIssuing"
]
}
},
"get-themes-id-success-200" : {
"summary" : "Details of a page theme",
"description" : "Example response when getting the details of a page theme",
Expand Down
132 changes: 132 additions & 0 deletions json/LegalEntityService-v2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2226,6 +2226,108 @@
}
}
},
"/legalEntities/{id}/termsOfServiceStatus" : {
"get" : {
"tags" : [
"Terms of Service"
],
"summary" : "Get Terms of Service status",
"description" : "Returns the required types of Terms of Service that need to be accepted by a legal entity.",
"x-addedInVersion" : "1",
"operationId" : "get-legalEntities-id-termsOfServiceStatus",
"x-groupName" : "Terms of Service",
"x-sortIndex" : 4,
"x-methodName" : "getTermsOfServiceStatus",
"security" : [
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CalculateTermsOfServiceStatusResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/themes" : {
"get" : {
"tags" : [
Expand Down Expand Up @@ -3192,6 +3294,27 @@
],
"type" : "object"
},
"CalculateTermsOfServiceStatusResponse" : {
"properties" : {
"termsOfServiceTypes" : {
"description" : "The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted.",
"items" : {
"enum" : [
"adyenAccount",
"adyenCapital",
"adyenCard",
"adyenForPlatformsAdvanced",
"adyenForPlatformsManage",
"adyenFranchisee",
"adyenIssuing"
],
"type" : "string"
},
"type" : "array"
}
},
"type" : "object"
},
"CapabilityProblem" : {
"properties" : {
"entity" : {
Expand Down Expand Up @@ -5044,6 +5167,15 @@
]
}
},
"get-legalEntities-id-termsOfServiceStatus-success-200" : {
"summary" : "Terms of Service status for a legal entity",
"description" : "Example response when getting the type of Terms of Service",
"value" : {
"termsOfServiceTypes" : [
"adyenIssuing"
]
}
},
"get-themes-id-success-200" : {
"summary" : "Details of a page theme",
"description" : "Example response when getting the details of a page theme",
Expand Down
Loading

0 comments on commit c00266f

Please sign in to comment.