Updated API from documentation release

Author: ct-sdks[bot]

api-specs/checkout/api.raml

@@ -76,14 +76,34 @@ traits:
               ],
           },
       ]
+  secured_by_view_payment_integrations:
+    securedBy:
+      [
+        oauth_2_0:
+          { scopes: ['view_checkout_payment_integrations:{projectKey}'] },
+      ]
+  secured_by_manage_payment_integrations:
+    securedBy:
+      [
+        oauth_2_0:
+          { scopes: ['manage_checkout_payment_integrations:{projectKey}'] },
+      ]
+  secured_by_view_applications:
+    securedBy:
+      [oauth_2_0: { scopes: ['view_checkout_applications:{projectKey}'] }]
+  secured_by_manage_applications:
+    securedBy:
+      [oauth_2_0: { scopes: ['manage_checkout_applications:{projectKey}'] }]
 
 /{projectKey}:
   (annotations.methodName): withProjectKey
   uriParameters:
     projectKey:
       type: string
       description: Identifier of your Checkout entity and `key` of your [Project](/../api/projects/project#project).
+  displayName: Project
   /payment-intents:
+    displayName: Payment Intents
     /{paymentId}:
       (annotations.methodName): withPaymentId
       uriParameters:
@@ -92,6 +112,7 @@ traits:
           description: |
             `id` of the [Payment](/../api/projects/payments).
       post:
+        displayName: Manage Payment by ID
         is:
           - secured_by_manage_payments
         body:
@@ -111,7 +132,9 @@ traits:
             body:
               type: ErrorResponse
   /transactions:
+    displayName: Transactions
     post:
+      displayName: Create Transaction
       is:
         - secured_by_manage_transactions
       body:
@@ -141,6 +164,7 @@ traits:
           description: |
             `id` of the [Transaction](/transactions-api#transaction).
       get:
+        displayName: Get Transaction by ID
         is:
           - secured_by_view_transactions
         description: |
@@ -164,6 +188,7 @@ traits:
           description: |
             `key` of the [Transaction](/transactions-api#transaction).
       get:
+        displayName: Get Transaction by key
         is:
           - secured_by_view_transactions
         description: |
@@ -179,3 +204,306 @@ traits:
             description: The request was invalid.
             body:
               type: ErrorResponse
+  /payment-integrations:
+    get:
+      is:
+        - secured_by_view_payment_integrations
+      description: |
+        Retrieves Payment Integrations in a [Project](/../api/projects#project).
+
+        The results are [paginated](/../api/general-concepts#pagination).
+      queryParameters:
+        sort?:
+          type: string[]
+          description: |
+            Controls [Sorting](/general-concepts#sorting) of query results.
+          example: ['createdAt asc', 'name desc']
+        limit?:
+          type: integer
+          format: int32
+          description: |
+            Number of results requested.
+          default: 20
+          minimum: 0
+          maximum: 500
+        offset?:
+          type: integer
+          format: int32
+          description: |
+            Number of elements skipped.
+          default: 0
+          maximum: 10000
+        withTotal?:
+          type: boolean
+          default: true
+          description: |
+            Controls the calculation of the total number of query results.
+      responses:
+        200:
+          body:
+            type: PaginatedPaymentIntegration
+            example: !include ../checkout/examples/payment-integrations/paginatedPaymentIntegrations.json
+    post:
+      is:
+        - secured_by_manage_payment_integrations
+      description: |
+        Creates a new PaymentIntegration.
+      body:
+        type: PaymentIntegrationDraft
+        example: !include ../checkout/examples/payment-integrations/paymentIntegrationDraft.json
+      responses:
+        201:
+          body:
+            type: PaymentIntegration
+            example: !include ../checkout/examples/payment-integrations/paymentIntegration.json
+
+        400:
+          description: The request was invalid.
+          body:
+            type: ErrorResponse
+    /{id}:
+      (annotations.methodName): withId
+      uriParameters:
+        id:
+          type: string
+          description: |
+            `id` of the [PaymentIntegration](/payment-integrations-api#payment-integration).
+      get:
+        is:
+          - secured_by_view_payment_integrations
+        description: |
+          Retrieves Payment Integrations in a [Project](/..api/projects/project#project) with a given `id`.
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+              example: !include ../checkout/examples/payment-integrations/paymentIntegration.json
+
+      head:
+        is:
+          - secured_by_view_payment_integrations
+        description: |
+          Checks if a PaymentIntegration with a given `id` exists. Returns `200 OK` if the PaymentIntegration exists, or `404 Not Found` if it doesn't. Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            description: PaymentIntegration exists
+      post:
+        is:
+          - secured_by_manage_payment_integrations
+        body:
+          type: PaymentIntegrationUpdateActions
+          example: !include examples/payment-integrations/paymentIntegrationUpdateActions.json
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+      delete:
+        is:
+          - secured_by_manage_payment_integrations
+        body:
+          type: PaymentIntegration
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+    /key={key}:
+      (annotations.methodName): withKey
+      uriParameters:
+        key:
+          type: string
+          description: |
+            `key` of the [PaymentIntegration](/payment-integrations-api#paymentintegration).
+      get:
+        is:
+          - secured_by_view_payment_integrations
+        description: |
+          Retrieves Payment Integrations in a [Project](/..api/projects/project#project with a given `key`. Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+              example: !include ../checkout/examples/payment-integrations/paymentIntegration.json
+
+      post:
+        is:
+          - secured_by_manage_payment_integrations
+        body:
+          type: PaymentIntegrationUpdateActions
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+      head:
+        is:
+          - secured_by_view_payment_integrations
+        description: |
+          Checks if a PaymentIntegration with a given `key` exists. Returns `200 OK` if the PaymentIntegration exists, or `404 Not Found` if it doesn't. Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            description: PaymentIntegration exists
+      delete:
+        is:
+          - secured_by_manage_payment_integrations
+        body:
+          type: PaymentIntegration
+        responses:
+          200:
+            body:
+              type: PaymentIntegration
+  /applications:
+    get:
+      is:
+        - secured_by_view_applications
+      description: |
+        Retrieves Applications
+      queryParameters:
+        sort?:
+          type: string[]
+          description: |
+            Controls [Sorting](/general-concepts#sorting) of query results.
+          example: ['createdAt asc', 'name desc']
+        limit?:
+          type: integer
+          format: int32
+          description: |
+            Number of results requested.
+          default: 20
+          minimum: 0
+          maximum: 500
+        offset?:
+          type: integer
+          format: int32
+          description: |
+            Number of elements skipped.
+          default: 0
+          maximum: 10000
+        withTotal?:
+          type: boolean
+          default: true
+          description: |
+            Controls the calculation of the total number of query results.
+      responses:
+        200:
+          body:
+            type: PaginatedApplication
+            example: !include examples/applications/paginatedApplications.json
+    post:
+      is:
+        - secured_by_manage_applications
+      description: |
+        Creates a new [Application](/applications-api#application).
+      body:
+        type: ApplicationDraft
+        example: !include examples/applications/CompleteFlowApplicationDraft.json
+
+      responses:
+        201:
+          body:
+            type: Application
+            example: !include examples/applications/CompleteFlowApplication.json
+
+        400:
+          description: The request was invalid.
+          body:
+            type: ErrorResponse
+    /{id}:
+      (annotations.methodName): withId
+      uriParameters:
+        id:
+          type: string
+          description: |
+            `id` of the [Application](/applications-api#application).
+      get:
+        is:
+          - secured_by_view_applications
+        description: |
+          Retrieves an [Application](/applications-api#application) by a given `id`.
+        responses:
+          200:
+            body:
+              type: Application
+              example: !include examples/applications/CompleteFlowApplication.json
+      head:
+        is:
+          - secured_by_view_applications
+        description: |
+          Checks if an [Application](/applications-api#application) with a given `id` exists. Returns `200 OK` if the Application exists, or `404 Not Found` if it doesn't. Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            description: Application exists
+      post:
+        is:
+          - secured_by_manage_applications
+        body:
+          type: ApplicationUpdateActions
+          example: !include examples/applications/ApplicationUpdateActions.json
+        responses:
+          200:
+            body:
+              type: Application
+      delete:
+        is:
+          - secured_by_manage_applications
+        body:
+          type: Application
+        responses:
+          200:
+            body:
+              type: Application
+    /key={key}:
+      (annotations.methodName): withKey
+      uriParameters:
+        key:
+          type: string
+          description: |
+            `key` of the [Application](/applications-api#application).
+      get:
+        is:
+          - secured_by_view_applications
+        description: |
+          Retrieves an [Application](/applications-api#application) with a given `key`.
+          Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            body:
+              type: Application
+              example: !include ../checkout/examples/applications/PaymentOnlyApplication.json
+
+      post:
+        is:
+          - secured_by_manage_applications
+        body:
+          type: ApplicationUpdateActions
+        responses:
+          200:
+            body:
+              type: Application
+      head:
+        is:
+          - secured_by_view_applications
+        description: |
+          Checks if an [Application](/applications-api#application) with a given `key` exists. Returns `200 OK` if the Application exists, or `404 Not Found` if it doesn't. Specific Error Codes:
+          - [ResourceNotFound](ctp:checkout:type:ResourceNotFoundError)
+          - [GeneralError](ctp:checkout:type:GeneralError)
+        responses:
+          200:
+            description: Application exists
+      delete:
+        is:
+          - secured_by_manage_applications
+        body:
+          type: Application
+        responses:
+          200:
+            body:
+              type: Application

api-specs/checkout/examples/applications/AddAllowedOriginUpdateAction.json

@@ -0,0 +1,4 @@
+{
+    "action": "addAllowedOrigin",
+    "origin": "https://new-domain.example.com"
+}

api-specs/checkout/examples/applications/AddApplicationAgreementUpdateAction.json

@@ -0,0 +1,12 @@
+{
+  "action": "addAgreement",
+  "agreement": {
+    "name": "Marketing Consent",
+    "type": "Text",
+    "status": "Active",
+    "text": {
+      "en": "I would like to receive marketing communications",
+      "de": "Ich möchte Marketing-Mitteilungen erhalten"
+    }
+  }
+}