@mojaloop/api-snippets 17.3.0 → 17.4.0

package/fspiop/v1_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml

@@ -4,6 +4,5 @@ description: 'The object sent in the PUT /parties/{Type}/{ID} callback.'
 properties:
   party:
     $ref: ./Party.yaml
-    description: Information regarding the requested Party.
 required:
   - party

package/lib/fspiop/v1_0/openapi.d.ts

@@ -1168,7 +1168,6 @@ export interface components {
          * @description The object sent in the PUT /parties/{Type}/{ID} callback.
          */
         PartiesTypeIDPutResponse: {
-            /** @description Information regarding the requested Party. */
             party: components["schemas"]["Party"];
         };
         /**

package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json

@@ -5324,7 +5324,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -13304,7 +13304,7 @@
     },
     "transferError": {
         "type": "object",
-        "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+        "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
         "properties": {
             "httpStatusCode": {
                 "type": "integer",
@@ -13459,7 +13459,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -14951,7 +14951,7 @@
                     },
                     "lastError": {
                         "type": "object",
-                        "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                        "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                         "properties": {
                             "httpStatusCode": {
                                 "type": "integer",
@@ -15116,7 +15116,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -16900,7 +16900,7 @@
                                 },
                                 "lastError": {
                                     "type": "object",
-                                    "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                                    "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                                     "properties": {
                                         "httpStatusCode": {
                                             "type": "integer",
@@ -17065,7 +17065,7 @@
                         },
                         "lastError": {
                             "type": "object",
-                            "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                            "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                             "properties": {
                                 "httpStatusCode": {
                                     "type": "integer",

package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts

@@ -786,7 +786,7 @@ export interface components {
          * @enum {string}
          */
         TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
-        /** @description This object represents a Mojaloop API error received at any time during the transfer process */
+        /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
         transferError: {
             /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
             httpStatusCode?: number;

package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json

@@ -733,7 +733,7 @@
     },
     "transferError": {
         "type": "object",
-        "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+        "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
         "properties": {
             "httpStatusCode": {
                 "type": "integer",
@@ -1105,7 +1105,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -1514,7 +1514,7 @@
                             },
                             "lastError": {
                                 "type": "object",
-                                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                                 "properties": {
                                     "httpStatusCode": {
                                         "type": "integer",
@@ -8169,7 +8169,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -9155,7 +9155,7 @@
                         },
                         "lastError": {
                             "type": "object",
-                            "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                            "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                             "properties": {
                                 "httpStatusCode": {
                                     "type": "integer",
@@ -9383,7 +9383,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -9636,7 +9636,7 @@
                         },
                         "lastError": {
                             "type": "object",
-                            "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                            "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                             "properties": {
                                 "httpStatusCode": {
                                     "type": "integer",
@@ -9914,7 +9914,7 @@
                                         },
                                         "lastError": {
                                             "type": "object",
-                                            "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                                            "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                                             "properties": {
                                                 "httpStatusCode": {
                                                     "type": "integer",
@@ -16418,7 +16418,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -18958,7 +18958,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",
@@ -20570,7 +20570,7 @@
                             },
                             "lastError": {
                                 "type": "object",
-                                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                                 "properties": {
                                     "httpStatusCode": {
                                         "type": "integer",
@@ -23004,7 +23004,7 @@
             },
             "lastError": {
                 "type": "object",
-                "description": "This object represents a Mojaloop API error received at any time during the transfer process",
+                "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
                 "properties": {
                     "httpStatusCode": {
                         "type": "integer",

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

@@ -535,7 +535,7 @@ export interface components {
         mojaloopError: {
             errorInformation?: components["schemas"]["ErrorInformation"];
         };
-        /** @description This object represents a Mojaloop API error received at any time during the transfer process */
+        /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
         transferError: {
             /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
             httpStatusCode?: number;
@@ -980,7 +980,6 @@ export interface components {
          */
         partiesByIdResponse: {
             party: {
-                /** @description Information regarding the requested Party. */
                 body: components["schemas"]["Party"];
                 headers: Record<string, never>;
             };
@@ -1060,7 +1059,6 @@ export interface components {
         };
         /** simpleQuotesPostRequest */
         simpleQuotesPostRequest: {
-            /** destination DFSP requested to calculate the quote */
             fspId: components["schemas"]["FspId"];
             quotesPostRequest: components["schemas"]["QuotesPostRequest"];
         };
@@ -1120,7 +1118,6 @@ export interface components {
          * @description The object sent in the GET /parties/{Type}/{ID} callback.
          */
         getPartiesResponse: {
-            /** @description Information regarding the requested Party. */
             body: components["schemas"]["Party"];
             headers: Record<string, never>;
         };
@@ -1159,7 +1156,6 @@ export interface components {
             currentState: components["schemas"]["requestToPayStatus"];
             getPartiesResponse?: components["schemas"]["getPartiesResponse"];
             transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"];
-            /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
             lastError?: components["schemas"]["transferError"];
         };
         /** @enum {string} */
@@ -1217,7 +1213,6 @@ export interface components {
                 body: components["schemas"]["TransfersIDPutResponse"];
                 headers?: Record<string, never>;
             };
-            /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
             lastError?: components["schemas"]["transferError"];
             /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */
             skipPartyLookup?: boolean;
@@ -1308,7 +1303,6 @@ export interface components {
                 body: components["schemas"]["TransfersIDPutResponse"];
                 headers?: Record<string, never>;
             };
-            /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
             lastError?: components["schemas"]["transferError"];
         };
         transferContinuationAcceptOTP: {