spec release

Adyen · Sep 16, 2023 · f5519d6 · f5519d6
1 parent 009cba1
commit f5519d6
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 42 deletions.
diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json
@@ -1502,7 +1502,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The legal entity ID of the individual who will sign the PCI questionnaire.",
+                  "description" : "The unique identifier of the legal entity to get PCI questionnaire information.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -1845,7 +1845,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -1961,7 +1961,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2072,7 +2072,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2174,7 +2174,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2886,7 +2886,7 @@
          "AcceptTermsOfServiceRequest" : {
             "properties" : {
                "acceptedBy" : {
-                  "description" : "The individual legal entity ID of the user accepting the Terms of Service. For organizations, this must be the legal entity ID of an authorized signatory for the organization.",
+                  "description" : "The legal entity ID of the user accepting the Terms of Service.\n\nFor organizations, this must be the individual legal entity ID of an authorized signatory for the organization.\n\nFor sole proprietorships, this must be the individual legal entity ID of the owner.",
                   "type" : "string"
                },
                "ipAddress" : {

diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json
@@ -1628,7 +1628,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The legal entity ID of the individual who will sign the PCI questionnaire.",
+                  "description" : "The unique identifier of the legal entity to get PCI questionnaire information.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -1971,7 +1971,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2087,7 +2087,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2198,7 +2198,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2300,7 +2300,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -3012,7 +3012,7 @@
          "AcceptTermsOfServiceRequest" : {
             "properties" : {
                "acceptedBy" : {
-                  "description" : "The individual legal entity ID of the user accepting the Terms of Service. For organizations, this must be the legal entity ID of an authorized signatory for the organization.",
+                  "description" : "The legal entity ID of the user accepting the Terms of Service.\n\nFor organizations, this must be the individual legal entity ID of an authorized signatory for the organization.\n\nFor sole proprietorships, this must be the individual legal entity ID of the owner.",
                   "type" : "string"
                },
                "ipAddress" : {

diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json
@@ -1736,7 +1736,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The legal entity ID of the individual who will sign the PCI questionnaire.",
+                  "description" : "The unique identifier of the legal entity to get PCI questionnaire information.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2079,7 +2079,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2195,7 +2195,7 @@
             },
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2306,7 +2306,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -2408,7 +2408,7 @@
             ],
             "parameters" : [
                {
-                  "description" : "The unique identifier of the legal entity.",
+                  "description" : "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.",
                   "name" : "id",
                   "in" : "path",
                   "required" : true,
@@ -3151,7 +3151,7 @@
          "AcceptTermsOfServiceRequest" : {
             "properties" : {
                "acceptedBy" : {
-                  "description" : "The individual legal entity ID of the user accepting the Terms of Service. For organizations, this must be the legal entity ID of an authorized signatory for the organization.",
+                  "description" : "The legal entity ID of the user accepting the Terms of Service.\n\nFor organizations, this must be the individual legal entity ID of an authorized signatory for the organization.\n\nFor sole proprietorships, this must be the individual legal entity ID of the owner.",
                   "type" : "string"
                },
                "ipAddress" : {

diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml
@@ -959,7 +959,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GeneratePciDescriptionRequest'
       parameters:
-      - description: The legal entity ID of the individual who will sign the PCI questionnaire.
+      - description: The unique identifier of the legal entity to get PCI questionnaire
+          information.
         name: id
         in: path
         required: true
@@ -1164,7 +1165,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1233,7 +1235,8 @@ paths:
             schema:
               $ref: '#/components/schemas/AcceptTermsOfServiceRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1300,7 +1303,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1362,7 +1366,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1812,9 +1817,15 @@ components:
     AcceptTermsOfServiceRequest:
       properties:
         acceptedBy:
-          description: The individual legal entity ID of the user accepting the Terms
-            of Service. For organizations, this must be the legal entity ID of an
-            authorized signatory for the organization.
+          description: 'The legal entity ID of the user accepting the Terms of Service.
+
+
+            For organizations, this must be the individual legal entity ID of an authorized
+            signatory for the organization.
+
+
+            For sole proprietorships, this must be the individual legal entity ID
+            of the owner.'
           type: string
         ipAddress:
           description: The IP address of the user accepting the Terms of Service.

diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml
@@ -1035,7 +1035,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GeneratePciDescriptionRequest'
       parameters:
-      - description: The legal entity ID of the individual who will sign the PCI questionnaire.
+      - description: The unique identifier of the legal entity to get PCI questionnaire
+          information.
         name: id
         in: path
         required: true
@@ -1240,7 +1241,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1309,7 +1311,8 @@ paths:
             schema:
               $ref: '#/components/schemas/AcceptTermsOfServiceRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1376,7 +1379,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1438,7 +1442,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1888,9 +1893,15 @@ components:
     AcceptTermsOfServiceRequest:
       properties:
         acceptedBy:
-          description: The individual legal entity ID of the user accepting the Terms
-            of Service. For organizations, this must be the legal entity ID of an
-            authorized signatory for the organization.
+          description: 'The legal entity ID of the user accepting the Terms of Service.
+
+
+            For organizations, this must be the individual legal entity ID of an authorized
+            signatory for the organization.
+
+
+            For sole proprietorships, this must be the individual legal entity ID
+            of the owner.'
           type: string
         ipAddress:
           description: The IP address of the user accepting the Terms of Service.

diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml
@@ -1101,7 +1101,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GeneratePciDescriptionRequest'
       parameters:
-      - description: The legal entity ID of the individual who will sign the PCI questionnaire.
+      - description: The unique identifier of the legal entity to get PCI questionnaire
+          information.
         name: id
         in: path
         required: true
@@ -1306,7 +1307,8 @@ paths:
             schema:
               $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1375,7 +1377,8 @@ paths:
             schema:
               $ref: '#/components/schemas/AcceptTermsOfServiceRequest'
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1442,7 +1445,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1504,7 +1508,8 @@ paths:
       - BasicAuth: []
       - ApiKeyAuth: []
       parameters:
-      - description: The unique identifier of the legal entity.
+      - description: The unique identifier of the legal entity. For sole proprietorships,
+          this is the individual legal entity ID of the owner.
         name: id
         in: path
         required: true
@@ -1979,9 +1984,15 @@ components:
     AcceptTermsOfServiceRequest:
       properties:
         acceptedBy:
-          description: The individual legal entity ID of the user accepting the Terms
-            of Service. For organizations, this must be the legal entity ID of an
-            authorized signatory for the organization.
+          description: 'The legal entity ID of the user accepting the Terms of Service.
+
+
+            For organizations, this must be the individual legal entity ID of an authorized
+            signatory for the organization.
+
+
+            For sole proprietorships, this must be the individual legal entity ID
+            of the owner.'
           type: string
         ipAddress:
           description: The IP address of the user accepting the Terms of Service.