@mojaloop/api-snippets 17.8.0 → 18.0.0-snapshot.1

package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml

@@ -48,6 +48,43 @@ paths:
           $ref: '#/components/responses/accountsCreationError'
         '504':
           $ref: '#/components/responses/accountsCreationTimeout'
+  /accounts/{Type}/{ID}:
+    delete:
+      summary: Delete account on the Account Lookup Service
+      description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+      tags:
+        - Accounts
+      parameters:
+        - $ref: '#/components/parameters/Type'
+        - $ref: '#/components/parameters/ID'
+      responses:
+        '200':
+          $ref: '#/components/responses/accountDeletionCompleted'
+        '400':
+          $ref: '#/components/responses/accountDeletionError'
+        '500':
+          $ref: '#/components/responses/accountDeletionError'
+        '504':
+          $ref: '#/components/responses/accountDeletionTimeout'
+  /accounts/{Type}/{ID}/{SubId}:
+    delete:
+      summary: Delete account on the Account Lookup Service
+      description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+      tags:
+        - Accounts
+      parameters:
+        - $ref: '#/components/parameters/Type'
+        - $ref: '#/components/parameters/ID'
+        - $ref: '#/components/parameters/SubId'
+      responses:
+        '200':
+          $ref: '#/components/responses/accountDeletionCompleted'
+        '400':
+          $ref: '#/components/responses/accountDeletionError'
+        '500':
+          $ref: '#/components/responses/accountDeletionError'
+        '504':
+          $ref: '#/components/responses/accountDeletionTimeout'
   /bulkQuotes:
     post:
       summary: Request bulk quotes for the provided financial transactions
@@ -2834,6 +2871,24 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/errorAccountsResponse'
+    accountDeletionCompleted:
+      description: Account deletion completed
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/accountsResponse'
+    accountDeletionError:
+      description: An error occurred while deleting an account
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/errorAccountsResponse'
+    accountDeletionTimeout:
+      description: Timeout occurred while deleting an account
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/errorAccountsResponse'
     bulkQuoteSuccess:
       description: Bulk quote completed successfully
       content:
@@ -2974,27 +3029,6 @@ components:
           schema:
             $ref: '#/components/schemas/ServicesFXPPutResponse'
   parameters:
-    bulkQuoteId:
-      name: bulkQuoteId
-      in: path
-      required: true
-      schema:
-        $ref: '#/components/schemas/CorrelationId'
-      description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
-    bulkTransactionId:
-      name: bulkTransactionId
-      in: path
-      required: true
-      schema:
-        $ref: '#/components/schemas/CorrelationId'
-      description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
-    bulkTransferId:
-      name: bulkTransferId
-      in: path
-      required: true
-      schema:
-        $ref: '#/components/schemas/CorrelationId'
-      description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
     Type:
       name: Type
       in: path
@@ -3016,6 +3050,27 @@ components:
       schema:
         type: string
       description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+    bulkQuoteId:
+      name: bulkQuoteId
+      in: path
+      required: true
+      schema:
+        $ref: '#/components/schemas/CorrelationId'
+      description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
+    bulkTransactionId:
+      name: bulkTransactionId
+      in: path
+      required: true
+      schema:
+        $ref: '#/components/schemas/CorrelationId'
+      description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
+    bulkTransferId:
+      name: bulkTransferId
+      in: path
+      required: true
+      schema:
+        $ref: '#/components/schemas/CorrelationId'
+      description: Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request.
     transactionRequestId:
       name: transactionRequestId
       in: path

package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts

@@ -81,6 +81,86 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/accounts/{Type}/{ID}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete account on the Account Lookup Service
+         * @description The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
+                    Type: components["parameters"]["Type"];
+                    /** @description The identifier value. */
+                    ID: components["parameters"]["ID"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["accountDeletionCompleted"];
+                400: components["responses"]["accountDeletionError"];
+                500: components["responses"]["accountDeletionError"];
+                504: components["responses"]["accountDeletionTimeout"];
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/accounts/{Type}/{ID}/{SubId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Delete account on the Account Lookup Service
+         * @description The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
+                    Type: components["parameters"]["Type"];
+                    /** @description The identifier value. */
+                    ID: components["parameters"]["ID"];
+                    /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
+                    SubId: components["parameters"]["SubId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["accountDeletionCompleted"];
+                400: components["responses"]["accountDeletionError"];
+                500: components["responses"]["accountDeletionError"];
+                504: components["responses"]["accountDeletionTimeout"];
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/bulkQuotes": {
         parameters: {
             query?: never;
@@ -2015,6 +2095,33 @@ export interface components {
                 "application/json": components["schemas"]["errorAccountsResponse"];
             };
         };
+        /** @description Account deletion completed */
+        accountDeletionCompleted: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["accountsResponse"];
+            };
+        };
+        /** @description An error occurred while deleting an account */
+        accountDeletionError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["errorAccountsResponse"];
+            };
+        };
+        /** @description Timeout occurred while deleting an account */
+        accountDeletionTimeout: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["errorAccountsResponse"];
+            };
+        };
         /** @description Bulk quote completed successfully */
         bulkQuoteSuccess: {
             headers: {
@@ -2224,18 +2331,18 @@ export interface components {
         };
     };
     parameters: {
-        /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
-        bulkQuoteId: components["schemas"]["CorrelationId"];
-        /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
-        bulkTransactionId: components["schemas"]["CorrelationId"];
-        /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
-        bulkTransferId: components["schemas"]["CorrelationId"];
         /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
         Type: string;
         /** @description The identifier value. */
         ID: string;
         /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
         SubId: string;
+        /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
+        bulkQuoteId: components["schemas"]["CorrelationId"];
+        /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
+        bulkTransactionId: components["schemas"]["CorrelationId"];
+        /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
+        bulkTransferId: components["schemas"]["CorrelationId"];
         /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
         transactionRequestId: components["schemas"]["CorrelationId"];
         /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.8.0",
+  "version": "18.0.0-snapshot.1",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -101,15 +101,15 @@
     "@redocly/cli": "^1.5.0",
     "@types/jest": "^29.5.14",
     "@types/js-yaml": "^4.0.9",
-    "@typescript-eslint/eslint-plugin": "^8.24.1",
-    "@typescript-eslint/parser": "^8.24.1",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
     "audit-ci": "^7.1.0",
     "browser-sync": "^3.0.3",
     "diff": "^7.0.0",
     "eslint": "^8.55.0",
-    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-prettier": "^10.0.2",
     "eslint-config-standard": "^17.1.0",
-    "eslint-import-resolver-typescript": "^3.8.2",
+    "eslint-import-resolver-typescript": "^3.8.3",
     "eslint-plugin-cucumber": "^2.0.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-node": "^11.1.0",
@@ -120,15 +120,15 @@
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
     "lint-staged": "^15.4.3",
-    "npm-check-updates": "^17.1.14",
-    "prettier": "^3.5.1",
+    "npm-check-updates": "^17.1.15",
+    "prettier": "^3.5.3",
     "standard-version": "^9.5.0",
     "swagger-cli": "^4.0.4",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.2.6",
     "ts-node": "^10.9.2",
     "ts-patch": "^3.3.0",
     "tslib": "^2.8.1",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionCompleted.yaml

@@ -0,0 +1,5 @@
+description: Account deletion completed
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/accountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred while deleting an account
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionTimeout.yaml

@@ -0,0 +1,5 @@
+description: Timeout occurred while deleting an account
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionResponse.yaml

@@ -0,0 +1,23 @@
+type: object
+required:
+  - accounts
+properties:
+  modelId:
+    $ref: ./CorrelationId.yaml
+  fspId:
+    $ref: ./FspId.yaml
+  response:
+    $ref: ./accountDeletionStatus.yaml
+  currentState:
+    $ref: ./accountDeletionState.yaml
+  lastError:
+    $ref: ./transferError.yaml
+  postAccountsResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object

package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionState.yaml

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - COMPLETED

package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionStatus.yaml

@@ -0,0 +1,10 @@
+type: array
+items:
+  type: object
+  required:
+    - fspId
+  properties:
+    fspId:
+      $ref: ./FspId.yaml
+    error:
+      $ref: ./errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml

@@ -24,6 +24,10 @@ paths:
     $ref: paths.yaml
   /accounts:
     $ref: paths/accounts.yaml
+  /accounts/{Type}/{ID}:
+    $ref: paths/accounts_Type_ID.yaml
+  /accounts/{Type}/{ID}/{SubId}:
+    $ref: paths/accounts_Type_ID_SubId.yaml
   /bulkQuotes:
     $ref: paths/bulkQuotes.yaml
   /bulkQuotes/{bulkQuoteId}:

package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID.yaml

@@ -0,0 +1,19 @@
+delete:
+  summary: Delete account on the Account Lookup Service
+  description: >-
+    The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on
+    the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+  tags:
+    - Accounts
+  parameters:
+    - $ref: ../../components/parameters/Type.yaml
+    - $ref: ../../components/parameters/ID.yaml
+  responses:
+    '200':
+      $ref: ../../components/responses/accountDeletionCompleted.yaml
+    '400':
+      $ref: ../../components/responses/accountDeletionError.yaml
+    '500':
+      $ref: ../../components/responses/accountDeletionError.yaml
+    '504':
+      $ref: ../../components/responses/accountDeletionTimeout.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID_SubId.yaml

@@ -0,0 +1,20 @@
+delete:
+  summary: Delete account on the Account Lookup Service
+  description: >-
+    The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on
+    the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+  tags:
+    - Accounts
+  parameters:
+    - $ref: ../../components/parameters/Type.yaml
+    - $ref: ../../components/parameters/ID.yaml
+    - $ref: ../../components/parameters/SubId.yaml
+  responses:
+    '200':
+      $ref: ../../components/responses/accountDeletionCompleted.yaml
+    '400':
+      $ref: ../../components/responses/accountDeletionError.yaml
+    '500':
+      $ref: ../../components/responses/accountDeletionError.yaml
+    '504':
+      $ref: ../../components/responses/accountDeletionTimeout.yaml