chore: update POST /consentRequests and PUT /consentRequests/{ID} (#83)

* chore: update POST /consentRequests and PUT /consentREquests/{ID}

* chore: rebuild files

src/thirdparty/index.ts

@@ -22,9 +22,7 @@ export namespace Schemas {
   export type ConsentRequestsIDPatchRequest = components['schemas']['ConsentRequestsIDPatchRequest']
   export type AuthorizationsIDPutResponse = components['schemas']['AuthorizationsIDPutResponse']
   export type ConsentRequestsIDPutResponseOTP = components['schemas']['ConsentRequestsIDPutResponseOTP']
-  export type ConsentRequestsIDPutResponseOTPAuth = components['schemas']['ConsentRequestsIDPutResponseOTPAuth']
   export type ConsentRequestsIDPutResponseWeb = components['schemas']['ConsentRequestsIDPutResponseWeb']
-  export type ConsentRequestsIDPutResponseWebAuth = components['schemas']['ConsentRequestsIDPutResponseWebAuth']
   export type ConsentRequestsPostRequest = components['schemas']['ConsentRequestsPostRequest']
   export type ConsentScopeType = components['schemas']['ConsentScopeType']
   export type ConsentsIDGenerateChallengePostRequest = components['schemas']['ConsentsIDGenerateChallengePostRequest']

src/thirdparty/openapi.ts

@@ -6639,11 +6639,11 @@ export interface operations {
         /**
          * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
          */
-        id: string;
+        consentRequestId: string;
         /**
-         * The id of the PISP who will initiate transactions on a user's behalf.
+         * ID used to associate request with GET /accounts request.
          */
-        initiatorId: string;
+        userId: string;
         scopes: {
           /**
            * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -6982,33 +6982,9 @@ export interface operations {
       "application/json":
       | {
         /**
-             * The id of the PISP who will initiate transactions on a user's behalf.
-             */
-        initiatorId: string;
-        scopes: {
-          /**
-               * A long-lived unique account identifier provided by the DFSP. This MUST NOT
-               * be Bank Account Number or anything that may expose a User's private bank
-               * account information.
-               */
-          accountId: string;
-          actions: ("accounts.getBalance" | "accounts.transfer")[];
-        }[];
-        authChannels: "WEB"[];
-        /**
-             * The callback uri that the user will be redirected to after completing the WEB auth channel.
-             */
-        callbackUri: string;
-        /**
-             * The callback uri that the pisp app redirects to for user to complete their login.
-             */
-        authUri: string;
-      }
-      | {
-        /**
-             * The id of the PISP who will initiate transactions on a user's behalf.
+             * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
              */
-        initiatorId: string;
+        consentRequestId: string;
         scopes: {
           /**
                * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -7027,36 +7003,12 @@ export interface operations {
              * The callback uri that the pisp app redirects to for user to complete their login.
              */
         authUri: string;
-        /**
-             * The Auth token from the OTP or redirect to pisp app.
-             */
-        authToken: string;
       }
       | {
         /**
-             * The id of the PISP who will initiate transactions on a user's behalf.
-             */
-        initiatorId: string;
-        scopes: {
-          /**
-               * A long-lived unique account identifier provided by the DFSP. This MUST NOT
-               * be Bank Account Number or anything that may expose a User's private bank
-               * account information.
-               */
-          accountId: string;
-          actions: ("accounts.getBalance" | "accounts.transfer")[];
-        }[];
-        authChannels: "OTP"[];
-        /**
-             * The callback uri that the user will be redirected to after completing the WEB auth channel.
-             */
-        callbackUri: string;
-      }
-      | {
-        /**
-             * The id of the PISP who will initiate transactions on a user's behalf.
+             * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
              */
-        initiatorId: string;
+        consentRequestId: string;
         scopes: {
           /**
                * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -7071,10 +7023,6 @@ export interface operations {
              * The callback uri that the user will be redirected to after completing the WEB auth channel.
              */
         callbackUri: string;
-        /**
-             * The Auth token from the OTP or redirect to pisp app.
-             */
-        authToken: string;
       };
     };
     responses: {
@@ -7393,12 +7341,7 @@ export interface operations {
    */
   PatchConsentRequest: {
     requestBody: {
-      "application/json": {
-        /**
-         * The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
-         */
-        authToken: string;
-      };
+      "application/json": { authToken: string };
     };
     responses: {
       /**
@@ -23819,11 +23762,11 @@ export interface components {
       /**
        * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
        */
-      id: string;
+      consentRequestId: string;
       /**
-       * The id of the PISP who will initiate transactions on a user's behalf.
+       * ID used to associate request with GET /accounts request.
        */
-      initiatorId: string;
+      userId: string;
       scopes: {
         /**
          * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -23853,40 +23796,9 @@ export interface components {
      */
     ConsentRequestsIDPutResponseWeb: {
       /**
-       * The id of the PISP who will initiate transactions on a user's behalf.
-       */
-      initiatorId: string;
-      scopes: {
-        /**
-         * A long-lived unique account identifier provided by the DFSP. This MUST NOT
-         * be Bank Account Number or anything that may expose a User's private bank
-         * account information.
-         */
-        accountId: string;
-        actions: ("accounts.getBalance" | "accounts.transfer")[];
-      }[];
-      authChannels: "WEB"[];
-      /**
-       * The callback uri that the user will be redirected to after completing the WEB auth channel.
-       */
-      callbackUri: string;
-      /**
-       * The callback uri that the pisp app redirects to for user to complete their login.
-       */
-      authUri: string;
-    };
-    /**
-     * The object sent in a `PUT /consentRequests/{ID}` request.
-     *
-     * Schema used in the authentication phase of the account linking flow,
-     * the user is expected to prove their identity to the DFSP by passing a OTP
-     * or secret to the PISP.
-     */
-    ConsentRequestsIDPutResponseWebAuth: {
-      /**
-       * The id of the PISP who will initiate transactions on a user's behalf.
+       * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
        */
-      initiatorId: string;
+      consentRequestId: string;
       scopes: {
         /**
          * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -23905,10 +23817,6 @@ export interface components {
        * The callback uri that the pisp app redirects to for user to complete their login.
        */
       authUri: string;
-      /**
-       * The Auth token from the OTP or redirect to pisp app.
-       */
-      authToken: string;
     };
     /**
      * The OTP auth channel being used for PUT consentRequest/{ID} request.
@@ -23921,36 +23829,9 @@ export interface components {
      */
     ConsentRequestsIDPutResponseOTP: {
       /**
-       * The id of the PISP who will initiate transactions on a user's behalf.
-       */
-      initiatorId: string;
-      scopes: {
-        /**
-         * A long-lived unique account identifier provided by the DFSP. This MUST NOT
-         * be Bank Account Number or anything that may expose a User's private bank
-         * account information.
-         */
-        accountId: string;
-        actions: ("accounts.getBalance" | "accounts.transfer")[];
-      }[];
-      authChannels: "OTP"[];
-      /**
-       * The callback uri that the user will be redirected to after completing the WEB auth channel.
-       */
-      callbackUri: string;
-    };
-    /**
-     * The object sent in a `PUT /consentRequests/{ID}` request.
-     *
-     * Schema used in the authentication phase of the account linking flow,
-     * the user is expected to prove their identity to the DFSP by passing a OTP
-     * or secret to the PISP.
-     */
-    ConsentRequestsIDPutResponseOTPAuth: {
-      /**
-       * The id of the PISP who will initiate transactions on a user's behalf.
+       * Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
        */
-      initiatorId: string;
+      consentRequestId: string;
       scopes: {
         /**
          * A long-lived unique account identifier provided by the DFSP. This MUST NOT
@@ -23965,20 +23846,11 @@ export interface components {
        * The callback uri that the user will be redirected to after completing the WEB auth channel.
        */
       callbackUri: string;
-      /**
-       * The Auth token from the OTP or redirect to pisp app.
-       */
-      authToken: string;
     };
     /**
      * The object sent in a `PATCH /consentRequests/{ID}` request.
      */
-    ConsentRequestsIDPatchRequest: {
-      /**
-       * The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
-       */
-      authToken: string;
-    };
+    ConsentRequestsIDPatchRequest: { authToken: string };
     /**
      * The object sent in a `POST /consents` request.
      */

tests/dto/thirdparty.test.ts

@@ -200,28 +200,17 @@ describe('thirdparty', () => {
 
   test('ConsentRequestsIDPutResponseOTP', () => {
     const consentRequestsIDPutResponseOTP: Schemas.ConsentRequestsIDPutResponseOTP = {
-      initiatorId: 'pisp-id',
+      consentRequestId: 'pisp-id',
       scopes: [scope],
       authChannels: [consentRequestChannelTypeOTP],
       callbackUri: 'https://fspiId/callback'
     }
     expect(consentRequestsIDPutResponseOTP).toBeDefined()
   })
 
-  test('ConsentRequestsIDPutResponseOTPAuth', () => {
-    const consentRequestsIDPutResponseOTPAuth: Schemas.ConsentRequestsIDPutResponseOTPAuth = {
-      initiatorId: 'pisp-id',
-      scopes: [scope],
-      authChannels: [consentRequestChannelTypeOTP],
-      callbackUri: 'https://fspiId/callback',
-      authToken: 'abcdefghijklmnopqrstuvxyz'
-    }
-    expect(consentRequestsIDPutResponseOTPAuth).toBeDefined()
-  })
-
   test('ConsentRequestsIDPutResponseWeb', () => {
     const consentRequestsIDPutResponseWeb: Schemas.ConsentRequestsIDPutResponseWeb = {
-      initiatorId: 'pisp-id',
+      consentRequestId: 'pisp-id',
       scopes: [scope],
       authChannels: [consentRequestChannelTypeWeb],
       callbackUri: 'https://fspiId/callback',
@@ -230,22 +219,10 @@ describe('thirdparty', () => {
     expect(consentRequestsIDPutResponseWeb).toBeDefined()
   })
 
-  test('ConsentRequestsIDPutResponseWebAuth', () => {
-    const consentRequestsIDPutResponseWebAuth: Schemas.ConsentRequestsIDPutResponseWebAuth = {
-      initiatorId: 'pisp-id',
-      scopes: [scope],
-      authChannels: [consentRequestChannelTypeWeb],
-      callbackUri: 'https://fspiId/callback',
-      authUri: 'https://fspId/auth',
-      authToken: 'abcdefghijklmnopqrstuvxyz'
-    }
-    expect(consentRequestsIDPutResponseWebAuth).toBeDefined()
-  })
-
   test('ConsentRequestsPostRequest', () => {
     const consentRequestsPostRequest: Schemas.ConsentRequestsPostRequest = {
-      id: correlationId,
-      initiatorId: 'pisp-id',
+      consentRequestId: 'pisp-id',
+      userId: 'pisp-id-user',
       scopes: [scope],
       authChannels: [consentRequestChannelType],
       callbackUri: 'https://fspiId/callback'

thirdparty/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml

@@ -3,6 +3,6 @@ type: object
 description: The object sent in a `PATCH /consentRequests/{ID}` request.
 properties:
   authToken:
-    $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/OtpValue.yaml'
+    type: string
 required:
   - authToken

thirdparty/openapi3/components/schemas/ConsentRequestsIDPutResponseOTP.yaml

@@ -5,9 +5,8 @@ description: |
 
   Schema used in the request consent phase of the account linking OTP/SMS flow.
 properties:
-  initiatorId:
-    type: string
-    description: The id of the PISP who will initiate transactions on a user's behalf.
+  consentRequestId:
+    $ref: ./CorrelationId.yaml
   scopes:
     type: array
     items:
@@ -22,7 +21,7 @@ properties:
       The callback uri that the user will be redirected to after completing the
       WEB auth channel.
 required:
-  - initiatorId
+  - consentRequestId
   - scopes
   - authChannels
   - callbackUri

thirdparty/openapi3/components/schemas/ConsentRequestsIDPutResponseWeb.yaml

@@ -8,9 +8,8 @@ description: |
   supposed user should be redirected. This URL should be a place where
   the user can prove their identity (e.g., by logging in).
 properties:
-  initiatorId:
-    type: string
-    description: The id of the PISP who will initiate transactions on a user's behalf.
+  consentRequestId:
+    $ref: ./CorrelationId.yaml
   scopes:
     type: array
     items:
@@ -30,7 +29,7 @@ properties:
       The callback uri that the pisp app redirects to for user to complete their
       login.
 required:
-  - initiatorId
+  - consentRequestId
   - scopes
   - authChannels
   - callbackUri