spec release

Adyen · Oct 19, 2023 · d162301 · d162301
1 parent 228421a
commit d162301
Show file tree

Hide file tree

Showing 6 changed files with 165 additions and 48 deletions.
diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json
@@ -1470,7 +1470,7 @@
                "PCI questionnaires"
             ],
             "summary" : "Generate PCI questionnaire",
-            "description" : "Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels). If multiple questionnaires are required, this request creates a single consodilated document to be signed.",
+            "description" : "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).",
             "x-addedInVersion" : "1",
             "operationId" : "post-legalEntities-id-pciQuestionnaires-generatePciTemplates",
             "x-groupName" : "PCI questionnaires",
@@ -3428,6 +3428,19 @@
          },
          "GeneratePciDescriptionRequest" : {
             "properties" : {
+               "additionalSalesChannels" : {
+                  "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/) and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/) for your user.\n\nPossible values:\n*  **eCommerce**\n*  **pos**\n*  **ecomMoto**\n*  **posMoto**\n\n",
+                  "items" : {
+                     "enum" : [
+                        "eCommerce",
+                        "ecomMoto",
+                        "pos",
+                        "posMoto"
+                     ],
+                     "type" : "string"
+                  },
+                  "type" : "array"
+               },
                "language" : {
                   "description" : "Sets the language of the PCI questionnaire. Its value is a two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code, for example, **en**.",
                   "type" : "string"
@@ -5366,15 +5379,15 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire" : {
-            "summary" : "Generate the PCI questionnaire",
-            "description" : "Example request for generating the PCI questionnaire in French",
+            "summary" : "Generate PCI questionnaires",
+            "description" : "Example request for generating PCI questionnaires in French",
             "value" : {
                "language" : "fr"
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200" : {
-            "summary" : "PCI questionnaire returned",
-            "description" : "Example response for getting a PCI questionnaire",
+            "summary" : "PCI questionnaires returned",
+            "description" : "Example response for getting PCI questionnaires",
             "value" : {
                "content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==",
                "language" : "fr",
@@ -5385,8 +5398,8 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire" : {
-            "summary" : "Sign the PCI questionnaires",
-            "description" : "Example request for signing the PCI questionnaires",
+            "summary" : "Sign PCI questionnaires",
+            "description" : "Example request for signing PCI questionnaires",
             "value" : {
                "signedBy" : "LE00000000000000000000002",
                "pciTemplateReferences" : [

diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json
@@ -1596,7 +1596,7 @@
                "PCI questionnaires"
             ],
             "summary" : "Generate PCI questionnaire",
-            "description" : "Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels). If multiple questionnaires are required, this request creates a single consodilated document to be signed.",
+            "description" : "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).",
             "x-addedInVersion" : "1",
             "operationId" : "post-legalEntities-id-pciQuestionnaires-generatePciTemplates",
             "x-groupName" : "PCI questionnaires",
@@ -3665,6 +3665,19 @@
          },
          "GeneratePciDescriptionRequest" : {
             "properties" : {
+               "additionalSalesChannels" : {
+                  "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/) and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/) for your user.\n\nPossible values:\n*  **eCommerce**\n*  **pos**\n*  **ecomMoto**\n*  **posMoto**\n\n",
+                  "items" : {
+                     "enum" : [
+                        "eCommerce",
+                        "ecomMoto",
+                        "pos",
+                        "posMoto"
+                     ],
+                     "type" : "string"
+                  },
+                  "type" : "array"
+               },
                "language" : {
                   "description" : "Sets the language of the PCI questionnaire. Its value is a two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code, for example, **en**.",
                   "type" : "string"
@@ -5945,15 +5958,15 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire" : {
-            "summary" : "Generate the PCI questionnaire",
-            "description" : "Example request for generating the PCI questionnaire in French",
+            "summary" : "Generate PCI questionnaires",
+            "description" : "Example request for generating PCI questionnaires in French",
             "value" : {
                "language" : "fr"
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200" : {
-            "summary" : "PCI questionnaire returned",
-            "description" : "Example response for getting a PCI questionnaire",
+            "summary" : "PCI questionnaires returned",
+            "description" : "Example response for getting PCI questionnaires",
             "value" : {
                "content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==",
                "language" : "fr",
@@ -5964,8 +5977,8 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire" : {
-            "summary" : "Sign the PCI questionnaires",
-            "description" : "Example request for signing the PCI questionnaires",
+            "summary" : "Sign PCI questionnaires",
+            "description" : "Example request for signing PCI questionnaires",
             "value" : {
                "signedBy" : "LE00000000000000000000002",
                "pciTemplateReferences" : [

diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json
@@ -1704,7 +1704,7 @@
                "PCI questionnaires"
             ],
             "summary" : "Generate PCI questionnaire",
-            "description" : "Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels). If multiple questionnaires are required, this request creates a single consodilated document to be signed.",
+            "description" : "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).",
             "x-addedInVersion" : "1",
             "operationId" : "post-legalEntities-id-pciQuestionnaires-generatePciTemplates",
             "x-groupName" : "PCI questionnaires",
@@ -3993,6 +3993,19 @@
          },
          "GeneratePciDescriptionRequest" : {
             "properties" : {
+               "additionalSalesChannels" : {
+                  "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/) and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/) for your user.\n\nPossible values:\n*  **eCommerce**\n*  **pos**\n*  **ecomMoto**\n*  **posMoto**\n\n",
+                  "items" : {
+                     "enum" : [
+                        "eCommerce",
+                        "ecomMoto",
+                        "pos",
+                        "posMoto"
+                     ],
+                     "type" : "string"
+                  },
+                  "type" : "array"
+               },
                "language" : {
                   "description" : "Sets the language of the PCI questionnaire. Its value is a two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code, for example, **en**.",
                   "type" : "string"
@@ -6934,15 +6947,15 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire" : {
-            "summary" : "Generate the PCI questionnaire",
-            "description" : "Example request for generating the PCI questionnaire in French",
+            "summary" : "Generate PCI questionnaires",
+            "description" : "Example request for generating PCI questionnaires in French",
             "value" : {
                "language" : "fr"
             }
          },
          "post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200" : {
-            "summary" : "PCI questionnaire returned",
-            "description" : "Example response for getting a PCI questionnaire",
+            "summary" : "PCI questionnaires returned",
+            "description" : "Example response for getting PCI questionnaires",
             "value" : {
                "content" : "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==",
                "language" : "fr",
@@ -6953,8 +6966,8 @@
             }
          },
          "post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire" : {
-            "summary" : "Sign the PCI questionnaires",
-            "description" : "Example request for signing the PCI questionnaires",
+            "summary" : "Sign PCI questionnaires",
+            "description" : "Example request for signing PCI questionnaires",
             "value" : {
                "signedBy" : "LE00000000000000000000002",
                "pciTemplateReferences" : [

diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml
@@ -939,9 +939,7 @@ paths:
       tags:
       - PCI questionnaires
       summary: Generate PCI questionnaire
-      description: Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).
-        If multiple questionnaires are required, this request creates a single consodilated
-        document to be signed.
+      description: Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).
       x-addedInVersion: '1'
       operationId: post-legalEntities-id-pciQuestionnaires-generatePciTemplates
       x-groupName: PCI questionnaires
@@ -2306,6 +2304,34 @@ components:
       type: object
     GeneratePciDescriptionRequest:
       properties:
+        additionalSalesChannels:
+          description: 'An array of additional sales channels to generate PCI questionnaires.
+            Include the relevant sales channels if you need your user to sign PCI
+            questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/)
+            and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/)
+            for your user.
+
+
+            Possible values:
+
+            *  **eCommerce**
+
+            *  **pos**
+
+            *  **ecomMoto**
+
+            *  **posMoto**
+
+
+            '
+          items:
+            enum:
+            - eCommerce
+            - ecomMoto
+            - pos
+            - posMoto
+            type: string
+          type: array
         language:
           description: Sets the language of the PCI questionnaire. Its value is a
             two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language
@@ -3968,22 +3994,22 @@ components:
       value:
         url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL
     post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire:
-      summary: Generate the PCI questionnaire
-      description: Example request for generating the PCI questionnaire in French
+      summary: Generate PCI questionnaires
+      description: Example request for generating PCI questionnaires in French
       value:
         language: fr
     post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200:
-      summary: PCI questionnaire returned
-      description: Example response for getting a PCI questionnaire
+      summary: PCI questionnaires returned
+      description: Example response for getting PCI questionnaires
       value:
         content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
         language: fr
         pciTemplateReferences:
         - PCIT-T7KC6VGL
         - PCIT-PKB6DKS4
     post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire:
-      summary: Sign the PCI questionnaires
-      description: Example request for signing the PCI questionnaires
+      summary: Sign PCI questionnaires
+      description: Example request for signing PCI questionnaires
       value:
         signedBy: LE00000000000000000000002
         pciTemplateReferences:

diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml
@@ -1015,9 +1015,7 @@ paths:
       tags:
       - PCI questionnaires
       summary: Generate PCI questionnaire
-      description: Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).
-        If multiple questionnaires are required, this request creates a single consodilated
-        document to be signed.
+      description: Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).
       x-addedInVersion: '1'
       operationId: post-legalEntities-id-pciQuestionnaires-generatePciTemplates
       x-groupName: PCI questionnaires
@@ -2484,6 +2482,34 @@ components:
       type: object
     GeneratePciDescriptionRequest:
       properties:
+        additionalSalesChannels:
+          description: 'An array of additional sales channels to generate PCI questionnaires.
+            Include the relevant sales channels if you need your user to sign PCI
+            questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/)
+            and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/)
+            for your user.
+
+
+            Possible values:
+
+            *  **eCommerce**
+
+            *  **pos**
+
+            *  **ecomMoto**
+
+            *  **posMoto**
+
+
+            '
+          items:
+            enum:
+            - eCommerce
+            - ecomMoto
+            - pos
+            - posMoto
+            type: string
+          type: array
         language:
           description: Sets the language of the PCI questionnaire. Its value is a
             two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language
@@ -4467,22 +4493,22 @@ components:
       value:
         url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL
     post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire:
-      summary: Generate the PCI questionnaire
-      description: Example request for generating the PCI questionnaire in French
+      summary: Generate PCI questionnaires
+      description: Example request for generating PCI questionnaires in French
       value:
         language: fr
     post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200:
-      summary: PCI questionnaire returned
-      description: Example response for getting a PCI questionnaire
+      summary: PCI questionnaires returned
+      description: Example response for getting PCI questionnaires
       value:
         content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
         language: fr
         pciTemplateReferences:
         - PCIT-T7KC6VGL
         - PCIT-PKB6DKS4
     post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire:
-      summary: Sign the PCI questionnaires
-      description: Example request for signing the PCI questionnaires
+      summary: Sign PCI questionnaires
+      description: Example request for signing PCI questionnaires
       value:
         signedBy: LE00000000000000000000002
         pciTemplateReferences: