From e884ddc27aa5201cafd2b62c3a22a4a4e77f3a71 Mon Sep 17 00:00:00 2001 From: einaralex Date: Fri, 23 Aug 2024 05:14:13 +0000 Subject: [PATCH] docs: wip --- .../packages/SDK/classes/MoneriumClient.md | 80 ++++++++++++------- .../packages/SDK/enumerations/OrderKind.md | 4 +- .../packages/SDK/enumerations/OrderState.md | 8 +- .../docs/packages/SDK/interfaces/Address.md | 10 ++- .../docs/packages/SDK/interfaces/Addresses.md | 2 +- .../SDK/interfaces/AuthFlowOptions.md | 14 ++-- .../AuthorizationCodeCredentials.md | 4 +- .../docs/packages/SDK/interfaces/Balances.md | 8 +- .../SDK/interfaces/ClientCredentials.md | 4 +- .../packages/SDK/interfaces/Corporation.md | 4 +- .../packages/SDK/interfaces/Counterpart.md | 4 +- .../SDK/interfaces/CrossChainIdentifier.md | 6 +- .../SDK/interfaces/CurrencyBalance.md | 4 +- .../docs/packages/SDK/interfaces/Fee.md | 6 +- .../docs/packages/SDK/interfaces/IBAN.md | 10 +-- .../packages/SDK/interfaces/IBANIdentifier.md | 4 +- .../packages/SDK/interfaces/IBANsResponse.md | 2 +- .../SDK/interfaces/IbansQueryParams.md | 4 +- .../packages/SDK/interfaces/Individual.md | 6 +- .../packages/SDK/interfaces/LinkAddress.md | 10 +-- .../SDK/interfaces/MoveIbanPayload.md | 4 +- .../SDK/interfaces/NewOrderByAccountId.md | 16 ++-- .../SDK/interfaces/NewOrderByAddress.md | 18 ++--- .../packages/SDK/interfaces/NewOrderCommon.md | 14 ++-- .../docs/packages/SDK/interfaces/Order.md | 28 +++---- .../packages/SDK/interfaces/OrderFilter.md | 12 +-- .../packages/SDK/interfaces/OrderMetadata.md | 16 ++-- .../OrderNotificationQueryParams.md | 4 +- .../SDK/interfaces/RequestIbanPayload.md | 6 +- .../packages/SDK/interfaces/SCANIdentifier.md | 6 +- .../packages/SDK/interfaces/SignUpPayload.md | 2 +- .../packages/SDK/interfaces/SignUpResponse.md | 4 +- .../packages/SDK/interfaces/SupportingDoc.md | 12 +-- .../SDK/interfaces/SupportingDocMetadata.md | 6 +- .../docs/packages/SDK/interfaces/Token.md | 12 +-- .../type-aliases/BearerTokenCredentials.md | 2 +- .../packages/SDK/type-aliases/ClassOptions.md | 2 +- .../packages/SDK/type-aliases/NewOrder.md | 2 +- .../SDK/type-aliases/ResponseStatus.md | 2 +- apps/developer/package.json | 2 +- packages/sdk/src/client.ts | 26 ++++-- packages/sdk/src/types.ts | 3 + 42 files changed, 218 insertions(+), 175 deletions(-) diff --git a/apps/developer/docs/packages/SDK/classes/MoneriumClient.md b/apps/developer/docs/packages/SDK/classes/MoneriumClient.md index 765f2a1a..a569d9ca 100644 --- a/apps/developer/docs/packages/SDK/classes/MoneriumClient.md +++ b/apps/developer/docs/packages/SDK/classes/MoneriumClient.md @@ -21,8 +21,8 @@ #### Example ```ts -new MoneriumClient() // defaults to `sandbox` - +const monerium = new MoneriumClient() // defaults to `sandbox` +// or new MoneriumClient('production') new MoneriumClient({ @@ -30,11 +30,18 @@ new MoneriumClient({ clientId: 'your-client-id', redirectUri: 'your-redirect-url' }) + +// Server side only +new MoneriumClient({ + environment: 'sandbox', + clientId: 'your-client-id', + clientSecret: 'your-secret' +}) ``` #### Defined in -[client.ts:98](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L98) +[client.ts:105](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L105) ## Properties @@ -78,21 +85,29 @@ The state parameter is used to maintain state between the request and the callba > **getAddress**(`address`): `Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\> -[https://monerium.dev/api-docs-v2#tag/addresses/operation/address](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) +# Get a single address +Get details for a single address by using the address public key after the address has been successfully linked to Monerium. ##### Parameters • **address**: `string` The public key of the blockchain account. +[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) ##### Returns `Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\> +##### Example + +``` +monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') +``` + ##### Defined in -[client.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L319) +[client.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L333) *** @@ -112,7 +127,7 @@ The public key of the blockchain account. ##### Defined in -[client.ts:329](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L329) +[client.ts:343](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L343) *** @@ -132,7 +147,7 @@ The public key of the blockchain account. ##### Defined in -[client.ts:345](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L345) +[client.ts:359](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L359) *** @@ -152,7 +167,7 @@ The public key of the blockchain account. ##### Defined in -[client.ts:398](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L398) +[client.ts:412](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L412) ### Authentication @@ -173,11 +188,14 @@ For automatic wallet link, add the following properties: `address`, `signature` `Promise`\<`void`\> string -[https://monerium.dev/api-docs-v2#tag/auth/operation/auth](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) + +##### Link + +[API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) ##### Defined in -[client.ts:141](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L141) +[client.ts:148](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L148) *** @@ -193,7 +211,7 @@ Cleanups the socket and the subscriptions ##### Defined in -[client.ts:655](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L655) +[client.ts:669](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L669) *** @@ -231,7 +249,7 @@ await monerium.getAccess(); ##### Defined in -[client.ts:183](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L183) +[client.ts:190](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L190) *** @@ -247,7 +265,7 @@ Revokes access ##### Defined in -[client.ts:667](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L667) +[client.ts:681](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L681) *** @@ -267,7 +285,7 @@ Revokes access ##### Defined in -[client.ts:454](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L454) +[client.ts:468](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L468) ### IBANs @@ -287,7 +305,7 @@ Revokes access ##### Defined in -[client.ts:353](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L353) +[client.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L367) *** @@ -307,7 +325,7 @@ Revokes access ##### Defined in -[client.ts:360](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L360) +[client.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L374) *** @@ -329,7 +347,7 @@ Revokes access ##### Defined in -[client.ts:424](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L424) +[client.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L438) *** @@ -349,7 +367,7 @@ Revokes access ##### Defined in -[client.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L438) +[client.ts:452](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L452) ### Orders [Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) @@ -376,7 +394,7 @@ Connects to the order notifications socket ##### Defined in -[client.ts:575](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L575) +[client.ts:589](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L589) *** @@ -396,7 +414,7 @@ Closes the order notifications sockets ##### Defined in -[client.ts:630](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L630) +[client.ts:644](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L644) ### Profiles @@ -404,7 +422,7 @@ Closes the order notifications sockets > **getProfile**(`profile`): `Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\> -[https://monerium.dev/api-docs-v2#tag/profiles/operation/profile](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) +# TELL ##### Parameters @@ -416,9 +434,13 @@ the id of the profile to fetch. `Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\> +##### Link + +[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) + ##### Defined in -[client.ts:304](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L304) +[client.ts:312](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L312) *** @@ -438,7 +460,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:311](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L311) +[client.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L319) *** @@ -460,7 +482,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:466](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L466) +[client.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L480) ### Orders @@ -480,7 +502,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:380](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L380) +[client.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L394) *** @@ -500,7 +522,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:373](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L373) +[client.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L387) *** @@ -520,7 +542,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:407](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L407) +[client.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L421) *** @@ -540,7 +562,7 @@ the id of the profile to fetch. ##### Defined in -[client.ts:481](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L481) +[client.ts:495](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L495) ### Tokens @@ -556,4 +578,4 @@ the id of the profile to fetch. ##### Defined in -[client.ts:388](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L388) +[client.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L402) diff --git a/apps/developer/docs/packages/SDK/enumerations/OrderKind.md b/apps/developer/docs/packages/SDK/enumerations/OrderKind.md index 06231963..533c2795 100644 --- a/apps/developer/docs/packages/SDK/enumerations/OrderKind.md +++ b/apps/developer/docs/packages/SDK/enumerations/OrderKind.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:306](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L306) +[types.ts:309](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L309) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:305](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L305) +[types.ts:308](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L308) diff --git a/apps/developer/docs/packages/SDK/enumerations/OrderState.md b/apps/developer/docs/packages/SDK/enumerations/OrderState.md index f0a7b017..da07679c 100644 --- a/apps/developer/docs/packages/SDK/enumerations/OrderState.md +++ b/apps/developer/docs/packages/SDK/enumerations/OrderState.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:311](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L311) +[types.ts:314](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L314) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:310](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L310) +[types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:312](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L312) +[types.ts:315](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L315) *** @@ -38,4 +38,4 @@ #### Defined in -[types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313) +[types.ts:316](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L316) diff --git a/apps/developer/docs/packages/SDK/interfaces/Address.md b/apps/developer/docs/packages/SDK/interfaces/Address.md index 113eed00..1a26b52d 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Address.md +++ b/apps/developer/docs/packages/SDK/interfaces/Address.md @@ -6,9 +6,11 @@ > **address**: `string` +The address + #### Defined in -[types.ts:281](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L281) +[types.ts:284](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L284) *** @@ -18,7 +20,7 @@ #### Defined in -[types.ts:282](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L282) +[types.ts:285](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L285) *** @@ -26,6 +28,8 @@ > **profile**: `string` +The id of the profile. + #### Defined in -[types.ts:280](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L280) +[types.ts:281](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L281) diff --git a/apps/developer/docs/packages/SDK/interfaces/Addresses.md b/apps/developer/docs/packages/SDK/interfaces/Addresses.md index 8a3fa3cc..a8533b15 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Addresses.md +++ b/apps/developer/docs/packages/SDK/interfaces/Addresses.md @@ -8,4 +8,4 @@ #### Defined in -[types.ts:286](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L286) +[types.ts:289](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L289) diff --git a/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md b/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md index a2a99230..78401468 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md +++ b/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:524](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L524) +[types.ts:527](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L527) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:526](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L526) +[types.ts:529](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L529) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:522](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L522) +[types.ts:525](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L525) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:523](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L523) +[types.ts:526](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L526) *** @@ -48,7 +48,7 @@ #### Defined in -[types.ts:525](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L525) +[types.ts:528](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L528) *** @@ -58,7 +58,7 @@ #### Defined in -[types.ts:528](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L528) +[types.ts:531](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L531) *** @@ -68,4 +68,4 @@ #### Defined in -[types.ts:527](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L527) +[types.ts:530](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L530) diff --git a/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md b/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md index cef7404e..6fdc1497 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md +++ b/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:537](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L537) +[types.ts:540](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L540) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:538](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L538) +[types.ts:541](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L541) diff --git a/apps/developer/docs/packages/SDK/interfaces/Balances.md b/apps/developer/docs/packages/SDK/interfaces/Balances.md index c886dc05..2e4b76bd 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Balances.md +++ b/apps/developer/docs/packages/SDK/interfaces/Balances.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:297](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L297) +[types.ts:300](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L300) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:299](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L299) +[types.ts:302](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L302) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:298](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L298) +[types.ts:301](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L301) *** @@ -38,4 +38,4 @@ #### Defined in -[types.ts:296](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L296) +[types.ts:299](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L299) diff --git a/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md b/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md index d23f0ab0..a73a2765 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md +++ b/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:532](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L532) +[types.ts:535](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L535) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:533](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L533) +[types.ts:536](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L536) diff --git a/apps/developer/docs/packages/SDK/interfaces/Corporation.md b/apps/developer/docs/packages/SDK/interfaces/Corporation.md index d0e46faa..d91ac3c6 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Corporation.md +++ b/apps/developer/docs/packages/SDK/interfaces/Corporation.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:348](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L348) +[types.ts:351](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L351) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:349](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L349) +[types.ts:352](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L352) diff --git a/apps/developer/docs/packages/SDK/interfaces/Counterpart.md b/apps/developer/docs/packages/SDK/interfaces/Counterpart.md index 4a09592a..2f897dfa 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Counterpart.md +++ b/apps/developer/docs/packages/SDK/interfaces/Counterpart.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:354](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L354) +[types.ts:357](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L357) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:353](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L353) +[types.ts:356](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L356) diff --git a/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md b/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md index c1478152..e1e23d01 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md @@ -14,7 +14,7 @@ The receivers address #### Defined in -[types.ts:330](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L330) +[types.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L333) *** @@ -40,7 +40,7 @@ The receivers network #### Defined in -[types.ts:332](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L332) +[types.ts:335](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L335) *** @@ -54,4 +54,4 @@ The receivers network #### Defined in -[types.ts:328](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L328) +[types.ts:331](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L331) diff --git a/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md b/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md index dd53eed6..e688cd2c 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md +++ b/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:292](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L292) +[types.ts:295](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L295) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:291](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L291) +[types.ts:294](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L294) diff --git a/apps/developer/docs/packages/SDK/interfaces/Fee.md b/apps/developer/docs/packages/SDK/interfaces/Fee.md index 974e0d77..2ce810a5 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Fee.md +++ b/apps/developer/docs/packages/SDK/interfaces/Fee.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L319) +[types.ts:322](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L322) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:318](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L318) +[types.ts:321](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L321) *** @@ -28,4 +28,4 @@ #### Defined in -[types.ts:317](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L317) +[types.ts:320](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L320) diff --git a/apps/developer/docs/packages/SDK/interfaces/IBAN.md b/apps/developer/docs/packages/SDK/interfaces/IBAN.md index 5d2d0808..59042baf 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBAN.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBAN.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:497](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L497) +[types.ts:500](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L500) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:495](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L495) +[types.ts:498](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L498) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:498](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L498) +[types.ts:501](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L501) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:494](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L494) +[types.ts:497](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L497) *** @@ -48,4 +48,4 @@ #### Defined in -[types.ts:496](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L496) +[types.ts:499](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L499) diff --git a/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md b/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md index b234d777..c96e2a02 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md @@ -26,7 +26,7 @@ #### Defined in -[types.ts:324](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L324) +[types.ts:327](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L327) *** @@ -40,4 +40,4 @@ #### Defined in -[types.ts:323](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L323) +[types.ts:326](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L326) diff --git a/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md b/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md index d5d634b6..e4b4cc74 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md @@ -8,4 +8,4 @@ #### Defined in -[types.ts:502](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L502) +[types.ts:505](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L505) diff --git a/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md b/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md index d2132498..fc53f464 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:490](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L490) +[types.ts:493](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L493) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:489](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L489) +[types.ts:492](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L492) diff --git a/apps/developer/docs/packages/SDK/interfaces/Individual.md b/apps/developer/docs/packages/SDK/interfaces/Individual.md index 927a78c6..2b1bd2bc 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Individual.md +++ b/apps/developer/docs/packages/SDK/interfaces/Individual.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:344](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L344) +[types.ts:347](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L347) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:342](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L342) +[types.ts:345](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L345) *** @@ -28,4 +28,4 @@ #### Defined in -[types.ts:343](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L343) +[types.ts:346](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L346) diff --git a/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md b/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md index 73f6f7ea..35a7136d 100644 --- a/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md +++ b/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md @@ -10,7 +10,7 @@ The public key of the blockchain account. #### Defined in -[types.ts:464](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L464) +[types.ts:467](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L467) *** @@ -20,7 +20,7 @@ The public key of the blockchain account. #### Defined in -[types.ts:477](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L477) +[types.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L480) *** @@ -34,7 +34,7 @@ Fixed message to be signed with the private key corresponding to the given addre #### Defined in -[types.ts:470](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L470) +[types.ts:473](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L473) *** @@ -46,7 +46,7 @@ Profile ID that owns the address. #### Defined in -[types.ts:462](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L462) +[types.ts:465](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L465) *** @@ -60,4 +60,4 @@ https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address #### Defined in -[types.ts:476](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L476) +[types.ts:479](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L479) diff --git a/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md b/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md index 9c5760ae..8720b97d 100644 --- a/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:506](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L506) +[types.ts:509](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L509) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:507](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L507) +[types.ts:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L510) diff --git a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md index 8371ecbc..1011a62b 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md @@ -12,7 +12,7 @@ #### Defined in -[types.ts:428](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L428) +[types.ts:431](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L431) *** @@ -26,7 +26,7 @@ #### Defined in -[types.ts:414](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L414) +[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) *** @@ -40,7 +40,7 @@ #### Defined in -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) +[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) *** @@ -54,7 +54,7 @@ #### Defined in -[types.ts:416](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L416) +[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) *** @@ -68,7 +68,7 @@ #### Defined in -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) +[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) *** @@ -82,7 +82,7 @@ #### Defined in -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) +[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) *** @@ -96,7 +96,7 @@ #### Defined in -[types.ts:415](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L415) +[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) *** @@ -110,4 +110,4 @@ #### Defined in -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) +[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) diff --git a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md index 1afcd6ba..83bd3fe8 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md @@ -12,7 +12,7 @@ #### Defined in -[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) +[types.ts:426](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L426) *** @@ -26,7 +26,7 @@ #### Defined in -[types.ts:414](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L414) +[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) *** @@ -38,7 +38,7 @@ The senders network #### Defined in -[types.ts:425](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L425) +[types.ts:428](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L428) *** @@ -52,7 +52,7 @@ The senders network #### Defined in -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) +[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) *** @@ -66,7 +66,7 @@ The senders network #### Defined in -[types.ts:416](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L416) +[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) *** @@ -80,7 +80,7 @@ The senders network #### Defined in -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) +[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) *** @@ -94,7 +94,7 @@ The senders network #### Defined in -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) +[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) *** @@ -108,7 +108,7 @@ The senders network #### Defined in -[types.ts:415](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L415) +[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) *** @@ -122,4 +122,4 @@ The senders network #### Defined in -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) +[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) diff --git a/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md b/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md index dd20d868..1c3f2dde 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md @@ -13,7 +13,7 @@ #### Defined in -[types.ts:414](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L414) +[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) *** @@ -23,7 +23,7 @@ #### Defined in -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) +[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) *** @@ -33,7 +33,7 @@ #### Defined in -[types.ts:416](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L416) +[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) *** @@ -43,7 +43,7 @@ #### Defined in -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) +[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) *** @@ -53,7 +53,7 @@ #### Defined in -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) +[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) *** @@ -63,7 +63,7 @@ #### Defined in -[types.ts:415](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L415) +[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) *** @@ -73,4 +73,4 @@ #### Defined in -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) +[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) diff --git a/apps/developer/docs/packages/SDK/interfaces/Order.md b/apps/developer/docs/packages/SDK/interfaces/Order.md index 6bbff9ad..c736e896 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Order.md +++ b/apps/developer/docs/packages/SDK/interfaces/Order.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:380](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L380) +[types.ts:383](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L383) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:381](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L381) +[types.ts:384](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L384) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:383](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L383) +[types.ts:386](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L386) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L387) +[types.ts:390](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L390) *** @@ -48,7 +48,7 @@ #### Defined in -[types.ts:384](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L384) +[types.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L387) *** @@ -58,7 +58,7 @@ #### Defined in -[types.ts:386](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L386) +[types.ts:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L389) *** @@ -68,7 +68,7 @@ #### Defined in -[types.ts:378](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L378) +[types.ts:381](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L381) *** @@ -78,7 +78,7 @@ #### Defined in -[types.ts:382](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L382) +[types.ts:385](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L385) *** @@ -88,7 +88,7 @@ #### Defined in -[types.ts:388](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L388) +[types.ts:391](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L391) *** @@ -98,7 +98,7 @@ #### Defined in -[types.ts:391](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L391) +[types.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L394) *** @@ -108,7 +108,7 @@ #### Defined in -[types.ts:379](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L379) +[types.ts:382](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L382) *** @@ -118,7 +118,7 @@ #### Defined in -[types.ts:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L389) +[types.ts:392](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L392) *** @@ -128,7 +128,7 @@ #### Defined in -[types.ts:390](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L390) +[types.ts:393](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L393) *** @@ -138,4 +138,4 @@ #### Defined in -[types.ts:385](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L385) +[types.ts:388](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L388) diff --git a/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md b/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md index fecf580b..b3be5836 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:373](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L373) +[types.ts:376](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L376) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:369](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L369) +[types.ts:372](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L372) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:372](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L372) +[types.ts:375](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L375) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:371](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L371) +[types.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L374) *** @@ -48,7 +48,7 @@ #### Defined in -[types.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L374) +[types.ts:377](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L377) *** @@ -58,4 +58,4 @@ #### Defined in -[types.ts:370](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L370) +[types.ts:373](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L373) diff --git a/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md b/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md index 5ac95a9c..88ac763f 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:358](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L358) +[types.ts:361](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L361) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:363](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L363) +[types.ts:366](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L366) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:362](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L362) +[types.ts:365](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L365) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:359](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L359) +[types.ts:362](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L362) *** @@ -48,7 +48,7 @@ #### Defined in -[types.ts:364](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L364) +[types.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L367) *** @@ -58,7 +58,7 @@ #### Defined in -[types.ts:360](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L360) +[types.ts:363](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L363) *** @@ -68,7 +68,7 @@ #### Defined in -[types.ts:365](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L365) +[types.ts:368](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L368) *** @@ -78,4 +78,4 @@ #### Defined in -[types.ts:361](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L361) +[types.ts:364](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L364) diff --git a/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md b/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md index 1856ddd8..71f8a9ae 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:514](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L514) +[types.ts:517](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L517) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:513](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L513) +[types.ts:516](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L516) diff --git a/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md b/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md index 8cd5d5e8..7eaa9968 100644 --- a/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:483](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L483) +[types.ts:486](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L486) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:484](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L484) +[types.ts:487](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L487) *** @@ -28,4 +28,4 @@ #### Defined in -[types.ts:485](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L485) +[types.ts:488](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L488) diff --git a/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md b/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md index 6822b6f5..49278486 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md @@ -12,7 +12,7 @@ #### Defined in -[types.ts:338](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L338) +[types.ts:341](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L341) *** @@ -36,7 +36,7 @@ #### Defined in -[types.ts:337](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L337) +[types.ts:340](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L340) *** @@ -50,4 +50,4 @@ #### Defined in -[types.ts:336](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L336) +[types.ts:339](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L339) diff --git a/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md b/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md index 0704b27d..e8137f65 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md @@ -8,4 +8,4 @@ #### Defined in -[types.ts:451](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L451) +[types.ts:454](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L454) diff --git a/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md b/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md index 13c3f835..90db95cc 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md +++ b/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:454](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L454) +[types.ts:457](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L457) *** @@ -18,4 +18,4 @@ #### Defined in -[types.ts:455](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L455) +[types.ts:458](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L458) diff --git a/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md b/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md index b0c3834e..4a0b0b06 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md +++ b/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:444](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L444) +[types.ts:447](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L447) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:440](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L440) +[types.ts:443](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L443) *** @@ -28,7 +28,7 @@ #### Defined in -[types.ts:445](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L445) +[types.ts:448](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L448) *** @@ -38,7 +38,7 @@ #### Defined in -[types.ts:441](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L441) +[types.ts:444](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L444) *** @@ -48,7 +48,7 @@ #### Defined in -[types.ts:443](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L443) +[types.ts:446](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L446) *** @@ -58,4 +58,4 @@ #### Defined in -[types.ts:442](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L442) +[types.ts:445](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L445) diff --git a/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md b/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md index 6119796f..78183cad 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md +++ b/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md @@ -8,7 +8,7 @@ #### Defined in -[types.ts:435](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L435) +[types.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L438) *** @@ -18,7 +18,7 @@ #### Defined in -[types.ts:436](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L436) +[types.ts:439](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L439) *** @@ -28,4 +28,4 @@ #### Defined in -[types.ts:434](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L434) +[types.ts:437](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L437) diff --git a/apps/developer/docs/packages/SDK/interfaces/Token.md b/apps/developer/docs/packages/SDK/interfaces/Token.md index a13a5d1a..8774b3b7 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Token.md +++ b/apps/developer/docs/packages/SDK/interfaces/Token.md @@ -12,7 +12,7 @@ The address of the EURe contract on this network #### Defined in -[types.ts:404](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L404) +[types.ts:407](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L407) *** @@ -22,7 +22,7 @@ The address of the EURe contract on this network #### Defined in -[types.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L402) +[types.ts:405](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L405) *** @@ -32,7 +32,7 @@ The address of the EURe contract on this network #### Defined in -[types.ts:399](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L399) +[types.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L402) *** @@ -44,7 +44,7 @@ How many decimals this token supports #### Defined in -[types.ts:406](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L406) +[types.ts:409](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L409) *** @@ -54,7 +54,7 @@ How many decimals this token supports #### Defined in -[types.ts:401](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L401) +[types.ts:404](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L404) *** @@ -64,4 +64,4 @@ How many decimals this token supports #### Defined in -[types.ts:400](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L400) +[types.ts:403](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L403) diff --git a/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md b/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md index b9ec84d2..24ba68f5 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md +++ b/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md @@ -4,4 +4,4 @@ ## Defined in -[types.ts:541](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L541) +[types.ts:544](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L544) diff --git a/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md b/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md index 1fc0f4e9..8596412f 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md +++ b/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:517](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L517) +[types.ts:520](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L520) diff --git a/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md b/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md index 5cd34045..fd77257c 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md +++ b/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md @@ -4,4 +4,4 @@ ## Defined in -[types.ts:411](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L411) +[types.ts:414](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L414) diff --git a/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md b/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md index 51861412..74c6e5a3 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md +++ b/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md @@ -14,4 +14,4 @@ ## Defined in -[types.ts:545](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L545) +[types.ts:548](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L548) diff --git a/apps/developer/package.json b/apps/developer/package.json index 1375a36d..e8878104 100644 --- a/apps/developer/package.json +++ b/apps/developer/package.json @@ -1,5 +1,5 @@ { - "name": "apps-docs", + "name": "developer", "version": "0.0.0", "private": true, "scripts": { diff --git a/packages/sdk/src/client.ts b/packages/sdk/src/client.ts index 64d74e9d..ef25d8d6 100644 --- a/packages/sdk/src/client.ts +++ b/packages/sdk/src/client.ts @@ -85,8 +85,8 @@ export class MoneriumClient { /** * @defaultValue `sandbox` * @example - * new MoneriumClient() // defaults to `sandbox` - * + * const monerium = new MoneriumClient() // defaults to `sandbox` + * // or * new MoneriumClient('production') * * new MoneriumClient({ @@ -94,6 +94,13 @@ export class MoneriumClient { * clientId: 'your-client-id', * redirectUri: 'your-redirect-url' * }) + * + * // Server side only + * new MoneriumClient({ + * environment: 'sandbox', + * clientId: 'your-client-id', + * clientSecret: 'your-secret' + * }) * */ constructor(envOrOptions?: ENV | ClassOptions) { // No arguments, default to sandbox @@ -101,7 +108,7 @@ export class MoneriumClient { this.#env = MONERIUM_CONFIG.environments['sandbox']; return; } - // String argument + if (typeof envOrOptions === 'string') { this.#env = MONERIUM_CONFIG.environments[envOrOptions]; } else { @@ -135,8 +142,8 @@ export class MoneriumClient { * Code Verifier needed for the code challenge is stored in local storage * For automatic wallet link, add the following properties: `address`, `signature` & `chain` * @returns string - * {@link https://monerium.dev/api-docs-v2#tag/auth/operation/auth} * @category Authentication + * @link [API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) */ async authorize(client?: AuthFlowOptions) { const clientId = @@ -297,9 +304,10 @@ export class MoneriumClient { // -- Read Methods /** - * {@link https://monerium.dev/api-docs-v2#tag/profiles/operation/profile} + * # TELL * @param {string} profile - the id of the profile to fetch. * @category Profiles + * @link [API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) */ getProfile(profile: string): Promise { return this.#api('get', `profiles/${profile}`); @@ -312,9 +320,15 @@ export class MoneriumClient { return this.#api('get', `profiles${queryParams(params)}`); } /** - * {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/address} + * # Get a single address + * Get details for a single address by using the address public key after the address has been successfully linked to Monerium. * @param {string} address - The public key of the blockchain account. + * {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/address | API Documentation} * @category Addresses + * @example + * ``` + * monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') + * ``` */ getAddress(address: string): Promise
{ return this.#api
('get', `addresses/${address}`); diff --git a/packages/sdk/src/types.ts b/packages/sdk/src/types.ts index d42689c1..d23fb4a1 100644 --- a/packages/sdk/src/types.ts +++ b/packages/sdk/src/types.ts @@ -277,7 +277,10 @@ export interface AddressesQueryParams { // } export interface Address { + /** The id of the profile. */ profile: string; + + /** The address */ address: string; chains: Chain[]; }