@mojaloop/api-snippets 17.6.1 → 17.7.0-snapshot.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -467,7 +467,7 @@ export interface components {
467
467
  };
468
468
  /** @enum {string} */
469
469
  amountType: "SEND" | "RECEIVE";
470
- /** @description A Mojaloop API bulk quote identifier (UUID). */
470
+ /** @description A Mojaloop API bulk quote identifier (UUID/ULID). */
471
471
  bulkQuoteId: string;
472
472
  /** @description A request for a bulk quote. */
473
473
  bulkQuoteRequest: {
@@ -484,7 +484,7 @@ export interface components {
484
484
  /** @description Fees for each individual transaction, if any of them are charged per transaction. */
485
485
  individualQuoteResults: (components["schemas"]["IndividualQuoteResultSuccess"] | components["schemas"]["IndividualQuoteResultFailed"])[];
486
486
  };
487
- /** @description A Mojaloop API transfer identifier (UUID). */
487
+ /** @description A Mojaloop API transfer identifier (UUID/ULID). */
488
488
  bulkTransferId: string;
489
489
  bulkTransferRequest: {
490
490
  bulkQuote?: components["schemas"]["bulkQuoteResponse"];
@@ -613,7 +613,7 @@ export interface components {
613
613
  };
614
614
  /** @enum {string} */
615
615
  payerType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
616
- /** @description A Mojaloop API quote identifier (UUID). */
616
+ /** @description A Mojaloop API quote identifier (UUID/ULID). */
617
617
  quoteId: string;
618
618
  /** @description A request for a quote for transfer from the DFSP backend. */
619
619
  quoteRequest: {
@@ -680,7 +680,7 @@ export interface components {
680
680
  subScenario?: components["schemas"]["TransactionSubScenario"];
681
681
  authenticationType?: components["schemas"]["AuthenticationType"];
682
682
  };
683
- /** @description A Mojaloop API transaction request identifier (UUID). */
683
+ /** @description A Mojaloop API transaction request identifier (UUID/ULID). */
684
684
  transactionRequestId: string;
685
685
  /** @description A response to a request for a quote. */
686
686
  transactionRequestResponse: {
@@ -721,7 +721,7 @@ export interface components {
721
721
  transactionType: components["schemas"]["transactionType"];
722
722
  transferState: components["schemas"]["transferState"];
723
723
  };
724
- /** @description A Mojaloop API transfer identifier (UUID). */
724
+ /** @description A Mojaloop API transfer identifier (UUID/ULID). */
725
725
  transferId: string;
726
726
  transferParty: {
727
727
  dateOfBirth?: components["schemas"]["dateOfBirth"];
@@ -835,7 +835,7 @@ export interface components {
835
835
  };
836
836
  /**
837
837
  * CorrelationId
838
- * @description 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 (‘-‘).
838
+ * @description Identifier that correlates all messages of the same sequence. The supported identifiers formats are for lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and uppercase [ULID](https://github.com/ulid/spec)
839
839
  * @example b51ec534-ee48-4575-b6a9-ead2955b8069
840
840
  */
841
841
  CorrelationId: string;