Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Sep 12, 2023
1 parent f6be6db commit 97e5a8c
Show file tree
Hide file tree
Showing 6 changed files with 234 additions and 9 deletions.
38 changes: 36 additions & 2 deletions json/LegalEntityService-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -1948,6 +1948,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceRequest"
}
Expand Down Expand Up @@ -1978,6 +1983,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceResponse"
}
Expand Down Expand Up @@ -3402,8 +3412,8 @@
}
},
"required" : [
"type",
"description"
"description",
"type"
],
"type" : "object"
},
Expand Down Expand Up @@ -3514,6 +3524,10 @@
"type" : "string"
}
},
"required" : [
"type",
"language"
],
"type" : "object"
},
"GetTermsOfServiceDocumentResponse" : {
Expand Down Expand Up @@ -4961,6 +4975,26 @@
"id" : "YOUR_LEGAL_ENTITY"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService" : {
"summary" : "Accept the Terms of Service document",
"description" : "Example request for accepting the Terms of Service document",
"value" : {
"acceptedBy" : "YOUR_LEGAL_ENTITY",
"ipAddress" : "82.199.87.148"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200" : {
"summary" : "Terms of Service document accepted",
"description" : "Example response when accepting a Terms of Service document",
"value" : {
"acceptedBy" : "LE00000000000000000000002",
"id" : "TOSA000AB00000000B2AAAB2BA0AA0",
"ipAddress" : "82.199.87.148",
"language" : "en",
"termsOfServiceDocumentId" : "abc123",
"type" : "adyenIssuing"
}
},
"patch-legalEntities-id-updateLegalEntityOrganization" : {
"summary" : "Add entity associations to an organization",
"description" : "Example request adding entity associations to a legal entity",
Expand Down
38 changes: 36 additions & 2 deletions json/LegalEntityService-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -2074,6 +2074,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceRequest"
}
Expand Down Expand Up @@ -2104,6 +2109,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceResponse"
}
Expand Down Expand Up @@ -3582,8 +3592,8 @@
}
},
"required" : [
"type",
"description"
"description",
"type"
],
"type" : "object"
},
Expand Down Expand Up @@ -3751,6 +3761,10 @@
"type" : "string"
}
},
"required" : [
"type",
"language"
],
"type" : "object"
},
"GetTermsOfServiceDocumentResponse" : {
Expand Down Expand Up @@ -5402,6 +5416,26 @@
"id" : "YOUR_LEGAL_ENTITY"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService" : {
"summary" : "Accept the Terms of Service document",
"description" : "Example request for accepting the Terms of Service document",
"value" : {
"acceptedBy" : "YOUR_LEGAL_ENTITY",
"ipAddress" : "82.199.87.148"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200" : {
"summary" : "Terms of Service document accepted",
"description" : "Example response when accepting a Terms of Service document",
"value" : {
"acceptedBy" : "LE00000000000000000000002",
"id" : "TOSA000AB00000000B2AAAB2BA0AA0",
"ipAddress" : "82.199.87.148",
"language" : "en",
"termsOfServiceDocumentId" : "abc123",
"type" : "adyenIssuing"
}
},
"patch-legalEntities-id-updateLegalEntityOrganization" : {
"summary" : "Add entity associations to an organization",
"description" : "Example request adding entity associations to a legal entity",
Expand Down
65 changes: 63 additions & 2 deletions json/LegalEntityService-v3.json
Original file line number Diff line number Diff line change
Expand Up @@ -2182,6 +2182,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceRequest"
}
Expand Down Expand Up @@ -2212,6 +2217,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"updateTermsofService" : {
"$ref" : "#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/AcceptTermsOfServiceResponse"
}
Expand Down Expand Up @@ -3319,6 +3329,9 @@
{
"$ref" : "#/components/schemas/NOLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/NZLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/NumberAndBicAccountIdentification"
},
Expand Down Expand Up @@ -3907,8 +3920,8 @@
}
},
"required" : [
"type",
"description"
"description",
"type"
],
"type" : "object"
},
Expand Down Expand Up @@ -4076,6 +4089,10 @@
"type" : "string"
}
},
"required" : [
"type",
"language"
],
"type" : "object"
},
"GetTermsOfServiceDocumentResponse" : {
Expand Down Expand Up @@ -4626,6 +4643,30 @@
],
"type" : "object"
},
"NZLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 15- to 16-digit bank account number, where first (2 digits) is bank number, where second (4 digits) is branch number, where next (7 digits) is the account number and last (2 or 3 digits) is the suffix.",
"maxLength" : 16,
"minLength" : 15,
"type" : "string"
},
"type" : {
"default" : "nzLocal",
"description" : "**nzLocal**",
"enum" : [
"nzLocal"
],
"type" : "string"
}
},
"required" : [
"type",
"accountNumber"
],
"type" : "object"
},
"Name" : {
"properties" : {
"firstName" : {
Expand Down Expand Up @@ -6144,6 +6185,26 @@
"id" : "YOUR_LEGAL_ENTITY"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService" : {
"summary" : "Accept the Terms of Service document",
"description" : "Example request for accepting the Terms of Service document",
"value" : {
"acceptedBy" : "YOUR_LEGAL_ENTITY",
"ipAddress" : "82.199.87.148"
}
},
"patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200" : {
"summary" : "Terms of Service document accepted",
"description" : "Example response when accepting a Terms of Service document",
"value" : {
"acceptedBy" : "LE00000000000000000000002",
"id" : "TOSA000AB00000000B2AAAB2BA0AA0",
"ipAddress" : "82.199.87.148",
"language" : "en",
"termsOfServiceDocumentId" : "abc123",
"type" : "adyenIssuing"
}
},
"patch-legalEntities-id-updateLegalEntityOrganization" : {
"summary" : "Add entity associations to an organization",
"description" : "Example request adding entity associations to a legal entity",
Expand Down
27 changes: 26 additions & 1 deletion yaml/LegalEntityService-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1225,6 +1225,9 @@ paths:
requestBody:
content:
application/json:
examples:
updateTermsofService:
$ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService'
schema:
$ref: '#/components/schemas/AcceptTermsOfServiceRequest'
parameters:
Expand All @@ -1244,6 +1247,9 @@ paths:
'200':
content:
application/json:
examples:
updateTermsofService:
$ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200'
schema:
$ref: '#/components/schemas/AcceptTermsOfServiceResponse'
description: OK - the request has succeeded.
Expand Down Expand Up @@ -2276,8 +2282,8 @@ components:
- proofOfIndustry
type: string
required:
- type
- description
- type
type: object
EntityReference:
properties:
Expand Down Expand Up @@ -2363,6 +2369,9 @@ components:
- adyenFranchisee
- adyenIssuing
type: string
required:
- type
- language
type: object
GetTermsOfServiceDocumentResponse:
properties:
Expand Down Expand Up @@ -3671,6 +3680,22 @@ components:
country: US
type: individual
id: YOUR_LEGAL_ENTITY
patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService:
summary: Accept the Terms of Service document
description: Example request for accepting the Terms of Service document
value:
acceptedBy: YOUR_LEGAL_ENTITY
ipAddress: 82.199.87.148
patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200:
summary: Terms of Service document accepted
description: Example response when accepting a Terms of Service document
value:
acceptedBy: LE00000000000000000000002
id: TOSA000AB00000000B2AAAB2BA0AA0
ipAddress: 82.199.87.148
language: en
termsOfServiceDocumentId: abc123
type: adyenIssuing
patch-legalEntities-id-updateLegalEntityOrganization:
summary: Add entity associations to an organization
description: Example request adding entity associations to a legal entity
Expand Down
27 changes: 26 additions & 1 deletion yaml/LegalEntityService-v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1301,6 +1301,9 @@ paths:
requestBody:
content:
application/json:
examples:
updateTermsofService:
$ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService'
schema:
$ref: '#/components/schemas/AcceptTermsOfServiceRequest'
parameters:
Expand All @@ -1320,6 +1323,9 @@ paths:
'200':
content:
application/json:
examples:
updateTermsofService:
$ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200'
schema:
$ref: '#/components/schemas/AcceptTermsOfServiceResponse'
description: OK - the request has succeeded.
Expand Down Expand Up @@ -2412,8 +2418,8 @@ components:
- proofOfFundingOrWealthSource
type: string
required:
- type
- description
- type
type: object
DocumentPage:
properties:
Expand Down Expand Up @@ -2541,6 +2547,9 @@ components:
- adyenFranchisee
- adyenIssuing
type: string
required:
- type
- language
type: object
GetTermsOfServiceDocumentResponse:
properties:
Expand Down Expand Up @@ -4038,6 +4047,22 @@ components:
country: US
type: individual
id: YOUR_LEGAL_ENTITY
patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService:
summary: Accept the Terms of Service document
description: Example request for accepting the Terms of Service document
value:
acceptedBy: YOUR_LEGAL_ENTITY
ipAddress: 82.199.87.148
patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200:
summary: Terms of Service document accepted
description: Example response when accepting a Terms of Service document
value:
acceptedBy: LE00000000000000000000002
id: TOSA000AB00000000B2AAAB2BA0AA0
ipAddress: 82.199.87.148
language: en
termsOfServiceDocumentId: abc123
type: adyenIssuing
patch-legalEntities-id-updateLegalEntityOrganization:
summary: Add entity associations to an organization
description: Example request adding entity associations to a legal entity
Expand Down
Loading

0 comments on commit 97e5a8c

Please sign in to comment.