From c4eb46cdc98653788abab460d070ee3b5f12fcef Mon Sep 17 00:00:00 2001 From: einaralex Date: Fri, 23 Aug 2024 17:17:47 +0000 Subject: [PATCH] docs: adjust docusaurus --- .github/workflows/ci.yml | 4 - README.md | 4 +- apps/customer/app/test/page.tsx | 10 +- .../functions/MoneriumProvider.md | 37 -- .../functions/useAddress.md | 44 -- .../functions/useAddresses.md | 50 -- .../SDK React Provider/functions/useAuth.md | 31 - .../functions/useBalances.md | 46 -- .../SDK React Provider/functions/useIBAN.md | 42 -- .../SDK React Provider/functions/useIBANs.md | 50 -- .../functions/useLinkAddress.md | 45 -- .../functions/useMoveIban.md | 42 -- .../SDK React Provider/functions/useOrder.md | 44 -- .../SDK React Provider/functions/useOrders.md | 62 -- .../functions/usePlaceOrder.md | 47 -- .../functions/useProfile.md | 45 -- .../functions/useProfiles.md | 42 -- .../functions/useRequestIban.md | 43 -- .../functions/useSubmitProfileDetails.md | 47 -- .../SDK React Provider/functions/useTokens.md | 42 -- .../docs/packages/SDK React Provider/index.md | 56 -- .../type-aliases/AuthorizeParams.md | 7 - .../type-aliases/MutationOptions.md | 69 -- .../type-aliases/MutationResult.md | 64 -- .../type-aliases/QueryOptions.md | 74 --- .../type-aliases/QueryResult.md | 66 -- .../type-aliases/SdkInstance.md | 15 - .../type-aliases/UseAuthReturn.md | 55 -- .../variables/MoneriumContext.md | 7 - .../SDK React Provider/variables/keys.md | 141 ---- .../packages/SDK/classes/MoneriumClient.md | 619 +++++++++--------- .../packages/SDK/enumerations/AccountState.md | 32 +- .../packages/SDK/enumerations/Currency.md | 43 +- .../SDK/enumerations/IdDocumentKind.md | 32 +- .../packages/SDK/enumerations/KYCOutcome.md | 32 +- .../packages/SDK/enumerations/KYCState.md | 43 +- .../docs/packages/SDK/enumerations/Method.md | 43 +- .../packages/SDK/enumerations/OrderKind.md | 21 +- .../packages/SDK/enumerations/OrderState.md | 43 +- .../SDK/enumerations/PaymentStandard.md | 32 +- .../packages/SDK/enumerations/Permission.md | 21 +- .../packages/SDK/enumerations/ProfileState.md | 64 +- .../packages/SDK/enumerations/ProfileType.md | 21 +- .../docs/packages/SDK/functions/getChain.md | 27 +- .../SDK/functions/placeOrderMessage.md | 43 +- .../docs/packages/SDK/functions/rfc3339.md | 20 +- apps/developer/docs/packages/SDK/index.md | 180 ++--- .../docs/packages/SDK/interfaces/Address.md | 36 +- .../docs/packages/SDK/interfaces/Addresses.md | 10 +- .../SDK/interfaces/AddressesQueryParams.md | 25 +- .../SDK/interfaces/AuthCodePayload.md | 56 +- .../SDK/interfaces/AuthFlowOptions.md | 76 +-- .../AuthorizationCodeCredentials.md | 21 +- .../docs/packages/SDK/interfaces/Balances.md | 43 +- .../packages/SDK/interfaces/BearerProfile.md | 65 +- .../SDK/interfaces/ClientCredentials.md | 21 +- .../interfaces/ClientCredentialsPayload.md | 34 +- .../SDK/interfaces/CorporateProfileDetails.md | 115 +--- .../CorporateProfileDetailsRequest.md | 10 +- .../packages/SDK/interfaces/Corporation.md | 21 +- .../packages/SDK/interfaces/Counterpart.md | 21 +- .../SDK/interfaces/CrossChainIdentifier.md | 57 +- .../SDK/interfaces/CurrencyBalance.md | 21 +- .../docs/packages/SDK/interfaces/Fee.md | 32 +- .../docs/packages/SDK/interfaces/IBAN.md | 54 +- .../packages/SDK/interfaces/IBANIdentifier.md | 42 +- .../packages/SDK/interfaces/IBANsResponse.md | 10 +- .../SDK/interfaces/IbansQueryParams.md | 21 +- .../packages/SDK/interfaces/Identifier.md | 27 +- .../packages/SDK/interfaces/Individual.md | 32 +- .../docs/packages/SDK/interfaces/KYC.md | 21 +- .../packages/SDK/interfaces/LinkAddress.md | 66 +- .../SDK/interfaces/MoveIbanPayload.md | 21 +- .../SDK/interfaces/NewOrderByAccountId.md | 117 +--- .../SDK/interfaces/NewOrderByAddress.md | 130 +--- .../packages/SDK/interfaces/NewOrderCommon.md | 80 +-- .../docs/packages/SDK/interfaces/Order.md | 153 +---- .../packages/SDK/interfaces/OrderFilter.md | 65 +- .../packages/SDK/interfaces/OrderMetadata.md | 87 +-- .../OrderNotificationQueryParams.md | 21 +- .../SDK/interfaces/PersonalProfileDetails.md | 119 +--- .../PersonalProfileDetailsRequest.md | 10 +- .../docs/packages/SDK/interfaces/Profile.md | 54 +- .../SDK/interfaces/ProfilePermissions.md | 43 +- .../SDK/interfaces/ProfilesQueryParams.md | 21 +- .../SDK/interfaces/ProfilesResponse.md | 10 +- .../SDK/interfaces/RefreshTokenPayload.md | 34 +- .../SDK/interfaces/RequestIbanPayload.md | 32 +- .../packages/SDK/interfaces/SCANIdentifier.md | 53 +- .../packages/SDK/interfaces/SignUpPayload.md | 10 +- .../packages/SDK/interfaces/SignUpResponse.md | 21 +- .../packages/SDK/interfaces/SupportingDoc.md | 65 +- .../SDK/interfaces/SupportingDocMetadata.md | 32 +- .../docs/packages/SDK/interfaces/Token.md | 69 +- .../packages/SDK/type-aliases/AuthArgs.md | 2 +- .../type-aliases/BearerTokenCredentials.md | 2 +- .../packages/SDK/type-aliases/Beneficiary.md | 10 +- .../packages/SDK/type-aliases/ClassOptions.md | 8 +- .../docs/packages/SDK/type-aliases/Config.md | 18 +- .../packages/SDK/type-aliases/Director.md | 2 +- .../packages/SDK/type-aliases/Environment.md | 18 +- .../packages/SDK/type-aliases/NewOrder.md | 2 +- .../packages/SDK/type-aliases/OpenArgs.md | 2 +- .../packages/SDK/type-aliases/PKCERequest.md | 80 +-- .../SDK/type-aliases/PKCERequestArgs.md | 2 +- .../SDK/type-aliases/Representative.md | 2 +- .../SDK/type-aliases/ResponseStatus.md | 13 +- .../SubmitProfileDetailsPayload.md | 2 +- .../docs/packages/SDK/variables/constants.md | 24 +- apps/developer/docs/packages/index.md | 6 - .../docs/packages/typedoc-sidebar.cjs | 4 - apps/developer/docusaurus.config.ts | 116 +++- apps/developer/package.json | 3 +- apps/developer/sidebars.ts | 33 +- apps/developer/src/pages/index.tsx | 2 +- package.json | 4 +- packages/sdk-react-provider/package.json | 1 + packages/sdk-react-provider/src/lib/hooks.tsx | 27 +- .../src/lib/provider.test.tsx | 2 - .../sdk-react-provider/src/lib/provider.tsx | 1 - packages/sdk-react-provider/src/lib/types.ts | 89 +-- packages/sdk-react-provider/tsconfig.json | 3 +- packages/sdk-react-provider/typedoc.config.js | 92 --- packages/sdk/src/client.ts | 204 +++--- packages/sdk/src/utils.ts | 52 +- packages/sdk/typedoc.config.js | 77 --- pnpm-lock.yaml | 76 +-- turbo.json | 10 +- 128 files changed, 1272 insertions(+), 4548 deletions(-) delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/MoneriumProvider.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useAddress.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useAuth.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useBalances.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useOrder.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useOrders.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useProfile.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useProfiles.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useRequestIban.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useSubmitProfileDetails.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/functions/useTokens.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/index.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/AuthorizeParams.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/MutationOptions.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/MutationResult.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/QueryOptions.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/QueryResult.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/SdkInstance.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/type-aliases/UseAuthReturn.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/variables/MoneriumContext.md delete mode 100644 apps/developer/docs/packages/SDK React Provider/variables/keys.md delete mode 100644 apps/developer/docs/packages/index.md delete mode 100644 apps/developer/docs/packages/typedoc-sidebar.cjs delete mode 100644 packages/sdk-react-provider/typedoc.config.js delete mode 100644 packages/sdk/typedoc.config.js diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 606e404e..b7ac1e45 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -51,10 +51,6 @@ jobs: - name: Build run: pnpm build - - name: Generate Documentation - if: github.ref == 'refs/heads/main' - run: pnpm run generate-docs - - name: Commit and Push Documentation if: github.ref == 'refs/heads/main' run: | diff --git a/README.md b/README.md index cd5c3d66..0a1f0a92 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ To build all apps and packages, run the following command: ``` cd js-monorepo -pnpm build +turbo build ``` ### Develop @@ -44,7 +44,7 @@ To develop all apps and packages, run the following command: ``` cd js-monorepo -pnpm dev +turbo dev ``` Note: use `pnpm dev --log-order stream` for a more traditional log output. diff --git a/apps/customer/app/test/page.tsx b/apps/customer/app/test/page.tsx index fc92acaa..14b88af9 100644 --- a/apps/customer/app/test/page.tsx +++ b/apps/customer/app/test/page.tsx @@ -1,12 +1,5 @@ 'use client'; -import { - ChangeEvent, - FormEvent, - useContext, - useEffect, - useRef, - useState, -} from 'react'; +import { ChangeEvent, FormEvent, useContext, useEffect, useState } from 'react'; import Link from 'next/link'; import { useAccount, useChainId, useSignMessage } from 'wagmi'; import { ConnectButton } from '@rainbow-me/rainbowkit'; @@ -27,7 +20,6 @@ import { useAddress, useAddresses, useAuth, - // useAuthContext, useBalances, useIBAN, useIBANs, diff --git a/apps/developer/docs/packages/SDK React Provider/functions/MoneriumProvider.md b/apps/developer/docs/packages/SDK React Provider/functions/MoneriumProvider.md deleted file mode 100644 index 1e27bf7e..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/MoneriumProvider.md +++ /dev/null @@ -1,37 +0,0 @@ -# Function: MoneriumProvider() - -> **MoneriumProvider**(`params`): `Element` - -## Parameters - -• **params** - -• **params.children**: `ReactNode` - -Rest of the application. - -• **params.clientId**: `string` - -Monerium auth flow client id. - -• **params.environment?**: `"sandbox"` \| `"production"` = `'sandbox'` - -Monerium environment. - -• **params.redirectUri**: `string` - -Monerium auth flow redirect url. - -• **params.redirectUrl?**: `string` - -**Deprecated** - -use redirectUri - -## Returns - -`Element` - -## Defined in - -[provider.tsx:19](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/provider.tsx#L19) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAddress.md b/apps/developer/docs/packages/SDK React Provider/functions/useAddress.md deleted file mode 100644 index 83f7b44f..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useAddress.md +++ /dev/null @@ -1,44 +0,0 @@ -# Function: useAddress() - -> **useAddress**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\> - -# Get address - -## Parameters - -• **params** - -• **params.address**: `string` - -Fetch a specific address. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`\> = `{}` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\> - -## Example - -```ts -const { - address, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useAddress(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) - -[Address interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Address.md) - -## Defined in - -[hooks.tsx:311](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L311) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md b/apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md deleted file mode 100644 index 293072bb..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md +++ /dev/null @@ -1,50 +0,0 @@ -# Function: useAddresses() - -> **useAddresses**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\> - -# Get addresses - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.chain?**: `number` \| `Chain` - -Fetch addresses for a specific chain. - -• **params.profile?**: `string` - -Fetch addresses for a specific profile. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`[]\> = `{}` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\> - -## Example - -```ts -const { - addresses, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useAddresses(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses) - -[Address interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Address.md) - -## Defined in - -[hooks.tsx:368](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L368) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAuth.md b/apps/developer/docs/packages/SDK React Provider/functions/useAuth.md deleted file mode 100644 index 4e728c90..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useAuth.md +++ /dev/null @@ -1,31 +0,0 @@ -# Function: useAuth() - -> **useAuth**(): [`UseAuthReturn`](/docs/packages/SDK%20React%20Provider/type-aliases/UseAuthReturn.md) - -# Redirect to the Monerium auth flow. - -## Returns - -[`UseAuthReturn`](/docs/packages/SDK%20React%20Provider/type-aliases/UseAuthReturn.md) - -- `authorize` - Redirects to the Monerium auth flow. -- `isAuthorized` - Whether the user is authorized. -- `isLoading` - Whether the auth flow is loading. -- `error` - Error message if the auth flow fails. -- `disconnect` - Disconnect the user. -- `revokeAccess` - Revoke the user's access. - -## Example - -```ts -const { authorize, isAuthorized, isLoading, error } = useAuth(); - -authorize(); // Redirects to the Monerium auth flow. - -// To opt-in to automated wallet linking, pass the address, signature and chain. -authorize({ address, signature, chain }). -``` - -## Defined in - -[hooks.tsx:107](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L107) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useBalances.md b/apps/developer/docs/packages/SDK React Provider/functions/useBalances.md deleted file mode 100644 index 6c15a94c..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useBalances.md +++ /dev/null @@ -1,46 +0,0 @@ -# Function: useBalances() - -> **useBalances**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\> - -# Get balances - -## Parameters - -• **params?** - -No required parameters. - -• **params.profile?**: `string` - -Fetch balances for a specific profile. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Balances`[]\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\> - -## Example - -```ts -const { - balances, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useBalances(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/profile-balances) - -[Balances interface](/docs/packages/SDK/interfaces/Balances.md) - -## Defined in - -[hooks.tsx:425](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L425) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md b/apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md deleted file mode 100644 index d485e318..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md +++ /dev/null @@ -1,42 +0,0 @@ -# Function: useIBAN() - -> **useIBAN**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\> - -# Get IBAN - -## Parameters - -• **params** - -• **params.iban**: `string` - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\> - -## Example - -```ts -const { - iban, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useIBAN(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/iban) - -[IBAN interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/IBAN.md) - -## Defined in - -[hooks.tsx:482](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L482) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md b/apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md deleted file mode 100644 index 8b6653d0..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md +++ /dev/null @@ -1,50 +0,0 @@ -# Function: useIBANs() - -> **useIBANs**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\> - -# Get IBANs - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.chain?**: `number` \| `Chain` - -Fetch IBANs for a specific chain. - -• **params.profile?**: `string` - -Fetch IBANs for a specific profile. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`[]\> = `{}` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\> - -## Example - -```ts -const { - ibans, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useIBANs(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans) - -[IBAN interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/IBAN.md) - -## Defined in - -[hooks.tsx:538](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L538) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md b/apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md deleted file mode 100644 index 8be3c05c..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md +++ /dev/null @@ -1,45 +0,0 @@ -# Function: useLinkAddress() - -> **useLinkAddress**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\> - -# Add address to profile. -When the address has been linked, the relevant profile query will be invalidated and re-fetched. - -## Parameters - -• **param** - -• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`object`, `Error`, `LinkAddress`\> - -See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options. - -• **param.profileId**: `string` - -Which profile to link the address. - -## Returns - -[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\> - -## Example - -```ts -const { - linkAddress, // useMutation's `mutateAsync` property - isPending, - isError, - error, - status, - ...moreUseMutationResults -} = useLinkAddress(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/profile-addresses) - -[LinkAddress interface](/docs/packages/SDK/interfaces/LinkAddress.md) - -## Defined in - -[hooks.tsx:1040](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L1040) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md b/apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md deleted file mode 100644 index 1d162326..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md +++ /dev/null @@ -1,42 +0,0 @@ -# Function: useMoveIban() - -> **useMoveIban**(`params`?): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\> - -# Move Iban -Move an existing IBAN to a specified address an chain. -All incoming EUR payments will automatically be routed to the address on that chain. - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\> = `{}` - -## Returns - -[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\> - -## Example - -```ts -const { - moveIban, // useMutation's `mutateAsync` property - isPending, - isError, - error, - status, - ...moreUseMutationResults -} = useMoveIban(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban) - -[NewOrder type](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/MoveIbanPayload.md) - -## Defined in - -[hooks.tsx:869](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L869) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useOrder.md b/apps/developer/docs/packages/SDK React Provider/functions/useOrder.md deleted file mode 100644 index 6214ea34..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useOrder.md +++ /dev/null @@ -1,44 +0,0 @@ -# Function: useOrder() - -> **useOrder**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\> - -# Get single order - -## Parameters - -• **params** - -• **params.orderId**: `string` - -The id of the order. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`\> = `{}` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\> - -## Example - -```ts -const { - order, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useOrder(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/order) - -[Order interface](/docs/packages/SDK/interfaces/Order.md) - -## Defined in - -[hooks.tsx:596](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L596) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useOrders.md b/apps/developer/docs/packages/SDK React Provider/functions/useOrders.md deleted file mode 100644 index 78d312a7..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useOrders.md +++ /dev/null @@ -1,62 +0,0 @@ -# Function: useOrders() - -> **useOrders**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\> - -# Get orders - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.address?**: `string` - -Filter based on the blockchain address associated with the order. - -• **params.memo?**: `string` - -Filter by the payment memo/reference.. - -• **params.profile?**: `string` - -Filter based on the profile ID associated with the order. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`[]\> = `{}` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -• **params.state?**: `OrderState` - -Filter based on the state of the order. - -• **params.txHash?**: `string` - -Filter based on the blockchain transaction hash. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\> - -## Example - -```ts -const { - orders, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useOrders(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/orders) - -[Order interface](/docs/packages/SDK/interfaces/Order.md) - -## Defined in - -[hooks.tsx:657](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L657) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md b/apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md deleted file mode 100644 index 21b6bd85..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md +++ /dev/null @@ -1,47 +0,0 @@ -# Function: usePlaceOrder() - -> **usePlaceOrder**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\> - -# Place an order. -When the order has been placed, the orders query will be invalidated and re-fetched. - -If the order amount is above 15000, a supporting document is required. - -## Parameters - -• **param** = `{}` - -• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`Order`, `Error`, `NewOrder`\> - -See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options. - -• **param.supportingDocument?**: `File` - -Supporting document file. - -## Returns - -[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\> - -## Example - -```ts -const { - placeOrder, // useMutation's `mutateAsync` property - isPending, - isError, - error, - status, - ...moreUseMutationResults -} = usePlaceOrder(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/post-orders) - -[NewOrder type](/docs/packages/SDK/type-aliases/NewOrder.md) - -## Defined in - -[hooks.tsx:954](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L954) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useProfile.md b/apps/developer/docs/packages/SDK React Provider/functions/useProfile.md deleted file mode 100644 index 420b7f1d..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useProfile.md +++ /dev/null @@ -1,45 +0,0 @@ -# Function: useProfile() - -> **useProfile**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\> - -# Get single profile -If no `profileId` is provided, the default profile is used. - -## Parameters - -• **params** = `{}` - -• **params.profile?**: `string` - -The id of the profile. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Profile`\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\> - -## Example - -```ts -const { - profile, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useProfile(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/profile) - -[Profile interface](/docs/packages/SDK/interfaces/Profile.md) - -## Defined in - -[hooks.tsx:149](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L149) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useProfiles.md b/apps/developer/docs/packages/SDK React Provider/functions/useProfiles.md deleted file mode 100644 index 680c4a93..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useProfiles.md +++ /dev/null @@ -1,42 +0,0 @@ -# Function: useProfiles() - -> **useProfiles**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `ProfilePermissions`[]\> - -# Get profiles - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`ProfilePermissions`[]\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `ProfilePermissions`[]\> - -## Example - -```ts -const { - profiles, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useProfiles(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/profiles) - -[Profile interface](/docs/packages/SDK/interfaces/Profile.md) - -## Defined in - -[hooks.tsx:211](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L211) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useRequestIban.md b/apps/developer/docs/packages/SDK React Provider/functions/useRequestIban.md deleted file mode 100644 index c4d2faab..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useRequestIban.md +++ /dev/null @@ -1,43 +0,0 @@ -# Function: useRequestIban() - -> **useRequestIban**(`params`?): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"requestIban"`, `ResponseStatus`, `Error`, `RequestIbanPayload`\> - -# Request Iban -Create an IBAN for a specified address and chain. -All incoming EUR payments will automatically be routed to the linked address on that chain. -Any linked address can use this IBAN for outgoing payments. - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `RequestIbanPayload`\> = `{}` - -## Returns - -[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"requestIban"`, `ResponseStatus`, `Error`, `RequestIbanPayload`\> - -## Example - -```ts -const { - requestIban, // useMutation's `mutateAsync` property - isPending, - isError, - error, - status, - ...moreUseMutationResults -} = useRequestIban(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban) - -[RequestIbanPayload type](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/RequestIbanPayload.md) - -## Defined in - -[hooks.tsx:798](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L798) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useSubmitProfileDetails.md b/apps/developer/docs/packages/SDK React Provider/functions/useSubmitProfileDetails.md deleted file mode 100644 index 0e7c87d1..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useSubmitProfileDetails.md +++ /dev/null @@ -1,47 +0,0 @@ -# Function: useSubmitProfileDetails() - -> **useSubmitProfileDetails**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"submitProfileDetails"`, `ResponseStatus`, `Error`, `SubmitProfileDetailsPayload`\> - -# Submit profile details. -Submit the required compliance information to onboard the customer. - -Note that you won't be able to change the profile "kind" from personal to corporate or vice versa once the profile has been approved. - -## Parameters - -• **param** - -• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `SubmitProfileDetailsPayload`\> = `{}` - -See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options. - -• **param.profile**: `string` - -The id of the profile to submit to. - -## Returns - -[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"submitProfileDetails"`, `ResponseStatus`, `Error`, `SubmitProfileDetailsPayload`\> - -## Example - -```ts -const { - submitProfileDetails, // useMutation's `mutateAsync` property - isPending, - isError, - error, - status, - ...moreUseMutationResults -} = useSubmitProfileDetails(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details) - -[SubmitProfileDetailsPayload type](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/type-aliases/SubmitProfileDetailsPayload.md) - -## Defined in - -[hooks.tsx:719](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L719) diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useTokens.md b/apps/developer/docs/packages/SDK React Provider/functions/useTokens.md deleted file mode 100644 index 1e0f5498..00000000 --- a/apps/developer/docs/packages/SDK React Provider/functions/useTokens.md +++ /dev/null @@ -1,42 +0,0 @@ -# Function: useTokens() - -> **useTokens**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\> - -# Get tokens - -## Parameters - -• **params?** = `{}` - -No required parameters. - -• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Token`[]\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Returns - -[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\> - -## Example - -```ts -const { - tokens, // useQuery's `data` property - isLoading, - isError, - error, - refetch, - ...moreUseQueryResults -} = useTokens(); -``` - -## See - -[API Documentation](https://monerium.dev/api-docs#operation/tokens) - -[Token interface](/docs/packages/SDK/interfaces/Token.md) - -## Defined in - -[hooks.tsx:262](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L262) diff --git a/apps/developer/docs/packages/SDK React Provider/index.md b/apps/developer/docs/packages/SDK React Provider/index.md deleted file mode 100644 index 4f138fcb..00000000 --- a/apps/developer/docs/packages/SDK React Provider/index.md +++ /dev/null @@ -1,56 +0,0 @@ -# SDK React Provider - -## Provider - -- [MoneriumProvider](/docs/packages/SDK%20React%20Provider/functions/MoneriumProvider.md) - -## Hooks - -### Addresses - -- [useAddress](/docs/packages/SDK%20React%20Provider/functions/useAddress.md) -- [useAddresses](/docs/packages/SDK%20React%20Provider/functions/useAddresses.md) -- [useBalances](/docs/packages/SDK%20React%20Provider/functions/useBalances.md) - -### Authentication - -- [useAuth](/docs/packages/SDK%20React%20Provider/functions/useAuth.md) - -### IBANs - -- [useIBAN](/docs/packages/SDK%20React%20Provider/functions/useIBAN.md) -- [useIBANs](/docs/packages/SDK%20React%20Provider/functions/useIBANs.md) -- [useMoveIban](/docs/packages/SDK%20React%20Provider/functions/useMoveIban.md) -- [useRequestIban](/docs/packages/SDK%20React%20Provider/functions/useRequestIban.md) - -### Orders - -- [useOrder](/docs/packages/SDK%20React%20Provider/functions/useOrder.md) -- [useOrders](/docs/packages/SDK%20React%20Provider/functions/useOrders.md) -- [usePlaceOrder](/docs/packages/SDK%20React%20Provider/functions/usePlaceOrder.md) - -### Profiles - -- [useLinkAddress](/docs/packages/SDK%20React%20Provider/functions/useLinkAddress.md) -- [useProfile](/docs/packages/SDK%20React%20Provider/functions/useProfile.md) -- [useProfiles](/docs/packages/SDK%20React%20Provider/functions/useProfiles.md) -- [useSubmitProfileDetails](/docs/packages/SDK%20React%20Provider/functions/useSubmitProfileDetails.md) - -### Other - -- [useTokens](/docs/packages/SDK%20React%20Provider/functions/useTokens.md) - -## Variables - -- [MoneriumContext](/docs/packages/SDK%20React%20Provider/variables/MoneriumContext.md) -- [keys](/docs/packages/SDK%20React%20Provider/variables/keys.md) - -## Type Aliases - -- [AuthorizeParams](/docs/packages/SDK%20React%20Provider/type-aliases/AuthorizeParams.md) -- [MutationOptions](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md) -- [MutationResult](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md) -- [QueryOptions](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md) -- [QueryResult](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md) -- [SdkInstance](/docs/packages/SDK%20React%20Provider/type-aliases/SdkInstance.md) -- [UseAuthReturn](/docs/packages/SDK%20React%20Provider/type-aliases/UseAuthReturn.md) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/AuthorizeParams.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/AuthorizeParams.md deleted file mode 100644 index 1393743c..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/AuthorizeParams.md +++ /dev/null @@ -1,7 +0,0 @@ -# Type Alias: AuthorizeParams - -> **AuthorizeParams**: `object` \| `object` \| `object` - -## Defined in - -[types.ts:16](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L16) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationOptions.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationOptions.md deleted file mode 100644 index 6e023083..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationOptions.md +++ /dev/null @@ -1,69 +0,0 @@ -# Type Alias: MutationOptions\ - -> **MutationOptions**\<`TData`, `TError`, `TVariables`\>: `Omit`\<`UseMutationOptions`\<`TData`, `TError`, `TVariables`\>, `"mutationKey"` \| `"mutationFn"`\> - -See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options. - -## Type Parameters - -• **TData** = `unknown` - -The data returned. - -• **TError** = `unknown` - -The error returned. - -• **TVariables** = `unknown` - -The variables used in the mutation. - -## See - -# [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) - -## Options - -> `mutationKey` and `mutationFn` are used internally and therefore not included in the options. -```diff -mutation: { - gcTime, - meta, -- mutationFn, -- mutationKey, - networkMode, - onError, - onMutate, - onSettled, - onSuccess, - retry, - retryDelay, - scope, - throwOnError, -} - ``` - -## Example - -```ts -useMutationHook({ - mutation: { - onSuccess: (data, variables) => { - console.log('onSuccess callback', data, variables); - }, - onError: (error) => { - console.log('onError callback', error); - }, - }, -}) -``` - -## Used By - -[useLinkAddress](/docs/packages/SDK%20React%20Provider/functions/useLinkAddress.md) - -[usePlaceOrder](/docs/packages/SDK%20React%20Provider/functions/usePlaceOrder.md) - -## Defined in - -[types.ts:202](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L202) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationResult.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationResult.md deleted file mode 100644 index d35c66da..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/MutationResult.md +++ /dev/null @@ -1,64 +0,0 @@ -# Type Alias: MutationResult\ - -> **MutationResult**\<`TFuncName`, `TData`, `TError`, `TVariables`, `TContext`\>: `Omit`\<`UseMutationResult`\<`TData`, `TError`, `TVariables`, `TContext`\>, `"mutateAsync"`\> & `{ [P in TFuncName]: UseMutationResult["mutateAsync"] }` - -See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) returns. - -## Type Parameters - -• **TFuncName** *extends* `string` - -The name of the function that mutates. - -• **TData** - -The data returned. - -• **TError** - -The error returned. - -• **TVariables** - -The variables used in the mutation. - -• **TContext** = `unknown` - -The context used in the mutation. - -## See - -# [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) - -## Example - -> `mutateAsync` is renamed according to the `TFuncName` and therefore not included in the result. -```diff -const { - data, - error, - isError, - isIdle, - isPending, - isPaused, - isSuccess, - failureCount, - failureReason, - mutate, -- mutateAsync, - reset, - status, - submittedAt, - variables, -} = useMutationHook(); - ``` - -## Used By - -[useLinkAddress](/docs/packages/SDK%20React%20Provider/functions/useLinkAddress.md) - -[usePlaceOrder](/docs/packages/SDK%20React%20Provider/functions/usePlaceOrder.md) - -## Defined in - -[types.ts:247](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L247) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryOptions.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryOptions.md deleted file mode 100644 index eeb96725..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryOptions.md +++ /dev/null @@ -1,74 +0,0 @@ -# Type Alias: QueryOptions\ - -> **QueryOptions**\<`TData`\>: `Omit`\<`UseQueryOptions`\<`TData`\>, `"queryKey"` \| `"queryFn"`\> - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. - -## Type Parameters - -• **TData** = `unknown` - -The data returned. - -## See - -# [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) - -## Options - -> `queryKey` and `queryFn` are used internally and therefore not included in the options. -```diff -query: { -- queryKey, -- queryFn, - gcTime, - enabled, - networkMode, - initialData, - initialDataUpdatedAt, - meta, - notifyOnChangeProps, - placeholderData, - queryKeyHashFn, - refetchInterval, - refetchIntervalInBackground, - refetchOnMount, - refetchOnReconnect, - refetchOnWindowFocus, - retry, - retryOnMount, - retryDelay, - select, - staleTime, - structuralSharing, - throwOnError -} - ``` - -## Example - -```ts -useQueryHook({ - query: { - enabled: isReady, - staleTime: 1000, - placeHolderData: { foo: 'bar' }, - } -}) -``` - -## Used By - -useAuthContext - -[useBalances](/docs/packages/SDK%20React%20Provider/functions/useBalances.md) - -[useOrders](/docs/packages/SDK%20React%20Provider/functions/useOrders.md) - -[useProfile](/docs/packages/SDK%20React%20Provider/functions/useProfile.md) - -[useTokens](/docs/packages/SDK%20React%20Provider/functions/useTokens.md) - -## Defined in - -[types.ts:96](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L96) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryResult.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryResult.md deleted file mode 100644 index d22323f2..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/QueryResult.md +++ /dev/null @@ -1,66 +0,0 @@ -# Type Alias: QueryResult\ - -> **QueryResult**\<`TVarName`, `TData`\>: `Omit`\<`UseQueryResult`\<`TData`\>, `"data"`\> & `{ [P in TVarName]: UseQueryResult["data"] }` - -See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) returns. - -## Type Parameters - -• **TVarName** *extends* `string` - -The name of the variable that returns the data. - -• **TData** = `unknown` - -The data returned. - -## See - -# [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) - -## Example - -> `data` is renamed according to the `TVarName` and therefore not included in the result. -```diff -{ -- data, - dataUpdatedAt, - error, - errorUpdatedAt, - failureCount, - failureReason, - fetchStatus, - isError, - isFetched, - isFetchedAfterMount, - isFetching, - isInitialLoading, - isLoading, - isLoadingError, - isPaused, - isPending, - isPlaceholderData, - isRefetchError, - isRefetching, - isStale, - isSuccess, - refetch, - status, -} - ``` - -## Used By - -useAuthContext - -[useBalances](/docs/packages/SDK%20React%20Provider/functions/useBalances.md) - -[useOrders](/docs/packages/SDK%20React%20Provider/functions/useOrders.md) - -[useProfile](/docs/packages/SDK%20React%20Provider/functions/useProfile.md) - -[useTokens](/docs/packages/SDK%20React%20Provider/functions/useTokens.md) - -## Defined in - -[types.ts:149](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L149) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/SdkInstance.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/SdkInstance.md deleted file mode 100644 index abd4b4bd..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/SdkInstance.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: SdkInstance - -> **SdkInstance**: `object` - -## Type declaration - -### sdk? - -> `optional` **sdk**: `MoneriumClient` - -Monerium SDK instance. - -## Defined in - -[types.ts:11](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L11) diff --git a/apps/developer/docs/packages/SDK React Provider/type-aliases/UseAuthReturn.md b/apps/developer/docs/packages/SDK React Provider/type-aliases/UseAuthReturn.md deleted file mode 100644 index f081558d..00000000 --- a/apps/developer/docs/packages/SDK React Provider/type-aliases/UseAuthReturn.md +++ /dev/null @@ -1,55 +0,0 @@ -# Type Alias: UseAuthReturn - -> **UseAuthReturn**: `object` - -## Type declaration - -### authorize() - -> **authorize**: (`params`?) => `Promise`\<`void`\> - -Constructs the url and redirects to the Monerium auth flow. - -#### Parameters - -• **params?**: [`AuthorizeParams`](/docs/packages/SDK%20React%20Provider/type-aliases/AuthorizeParams.md) - -#### Returns - -`Promise`\<`void`\> - -### disconnect() - -> **disconnect**: () => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -### error - -> **error**: `unknown` - -### isAuthorized - -> **isAuthorized**: `boolean` - -Indicates whether the SDK is authorized. - -### isLoading - -> **isLoading**: `boolean` - -Indicates whether the SDK authorization is loading. - -### revokeAccess() - -> **revokeAccess**: () => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -## Defined in - -[types.ts:21](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L21) diff --git a/apps/developer/docs/packages/SDK React Provider/variables/MoneriumContext.md b/apps/developer/docs/packages/SDK React Provider/variables/MoneriumContext.md deleted file mode 100644 index 2811030d..00000000 --- a/apps/developer/docs/packages/SDK React Provider/variables/MoneriumContext.md +++ /dev/null @@ -1,7 +0,0 @@ -# Variable: MoneriumContext - -> `const` **MoneriumContext**: `Context`\<`null` \| [`UseAuthReturn`](/docs/packages/SDK%20React%20Provider/type-aliases/UseAuthReturn.md) & [`SdkInstance`](/docs/packages/SDK%20React%20Provider/type-aliases/SdkInstance.md)\> - -## Defined in - -[context.tsx:5](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/context.tsx#L5) diff --git a/apps/developer/docs/packages/SDK React Provider/variables/keys.md b/apps/developer/docs/packages/SDK React Provider/variables/keys.md deleted file mode 100644 index 652f4a38..00000000 --- a/apps/developer/docs/packages/SDK React Provider/variables/keys.md +++ /dev/null @@ -1,141 +0,0 @@ -# Variable: keys - -> `const` **keys**: `object` - -**`Internal`** - -Query keys - -## Type declaration - -### getAddress() - -> **getAddress**: (`address`) => (`string` \| `string`[])[] - -#### Parameters - -• **address**: `string` - -#### Returns - -(`string` \| `string`[])[] - -### getAddresses() - -> **getAddresses**: (`filter`?) => `object`[] - -#### Parameters - -• **filter?**: `unknown` - -#### Returns - -`object`[] - -### getAll - -> **getAll**: `string`[] - -### getBalances() - -> **getBalances**: (`profileId`?) => `string`[] - -#### Parameters - -• **profileId?**: `string` - -#### Returns - -`string`[] - -### getIban() - -> **getIban**: (`iban`) => `string`[] - -#### Parameters - -• **iban**: `string` - -#### Returns - -`string`[] - -### getIbans() - -> **getIbans**: (`filter`?) => `object`[] - -#### Parameters - -• **filter?**: `unknown` - -#### Returns - -`object`[] - -### getOrder() - -> **getOrder**: (`orderId`) => `string`[] - -#### Parameters - -• **orderId**: `string` - -#### Returns - -`string`[] - -### getOrders() - -> **getOrders**: (`filter`?) => `object`[] - -#### Parameters - -• **filter?**: `unknown` - -#### Returns - -`object`[] - -### getProfile() - -> **getProfile**: (`profileId`) => `string`[] - -#### Parameters - -• **profileId**: `string` - -#### Returns - -`string`[] - -### getProfiles - -> **getProfiles**: `string`[] - -### getTokens - -> **getTokens**: `string`[] - -### linkAddress - -> **linkAddress**: `string`[] - -### moveIban - -> **moveIban**: `string`[] - -### placeOrder - -> **placeOrder**: `string`[] - -### requestIban - -> **requestIban**: `string`[] - -### submitProfileDetails - -> **submitProfileDetails**: `string`[] - -## Defined in - -[hooks.tsx:36](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L36) diff --git a/apps/developer/docs/packages/SDK/classes/MoneriumClient.md b/apps/developer/docs/packages/SDK/classes/MoneriumClient.md index a569d9ca..bd508a26 100644 --- a/apps/developer/docs/packages/SDK/classes/MoneriumClient.md +++ b/apps/developer/docs/packages/SDK/classes/MoneriumClient.md @@ -1,581 +1,584 @@ # Class: MoneriumClient -## Constructors - -### new MoneriumClient() - -> **new MoneriumClient**(`envOrOptions`?): [`MoneriumClient`](/docs/packages/SDK/classes/MoneriumClient.md) - -#### Parameters - -• **envOrOptions?**: [`ENV`](/docs/packages/SDK/type-aliases/ENV.md) \| [`ClassOptions`](/docs/packages/SDK/type-aliases/ClassOptions.md) - -#### Returns - -[`MoneriumClient`](/docs/packages/SDK/classes/MoneriumClient.md) - -#### Default Value - -`sandbox` - -#### Example - +In the [Monerium UI](https://monerium.app/), create an application to get the `clientId` and register your `redirectUri`. ```ts +import { MoneriumClient } from '@monerium/sdk'; + const monerium = new MoneriumClient() // defaults to `sandbox` + // or new MoneriumClient('production') +// or new MoneriumClient({ environment: 'sandbox', clientId: 'your-client-id', - redirectUri: 'your-redirect-url' -}) + redirectUri: 'http://your-redirect-url.com/monerium' +}); -// Server side only +// or - server only new MoneriumClient({ environment: 'sandbox', clientId: 'your-client-id', - clientSecret: 'your-secret' + clientSecret: 'your-client-secret' }) ``` -#### Defined in - -[client.ts:105](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L105) - -## Properties - -### bearerProfile? - -> `optional` **bearerProfile**: [`BearerProfile`](/docs/packages/SDK/interfaces/BearerProfile.md) - -The bearer profile will be available after authentication, it includes the `access_token` and `refresh_token` - -#### Defined in - -[client.ts:71](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L71) - -*** +## Constructors -### isAuthorized +### new MoneriumClient() -> **isAuthorized**: `boolean` = `!!this.bearerProfile` +> **new MoneriumClient**(`envOrOptions`?: [`ENV`](/docs/packages/sdk/type-aliases/ENV.md) \| [`ClassOptions`](/docs/packages/sdk/type-aliases/ClassOptions.md)): [`MoneriumClient`](/docs/packages/sdk/classes/MoneriumClient.md) -#### Defined in +#### Parameters -[client.ts:77](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L77) +| Parameter | Type | +| ------ | ------ | +| `envOrOptions`? | [`ENV`](/docs/packages/sdk/type-aliases/ENV.md) \| [`ClassOptions`](/docs/packages/sdk/type-aliases/ClassOptions.md) | -*** +#### Returns -### state +[`MoneriumClient`](/docs/packages/sdk/classes/MoneriumClient.md) -> **state**: `undefined` \| `string` +#### Default Value -The state parameter is used to maintain state between the request and the callback. +`sandbox` #### Defined in -[client.ts:83](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L83) +[client.ts:115](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L115) -## Methods +## Properties -### Addresses +| Property | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `bearerProfile?` | [`BearerProfile`](/docs/packages/sdk/interfaces/BearerProfile.md) | `undefined` | The bearer profile will be available after authentication, it includes the `access_token` and `refresh_token` | [client.ts:96](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L96) | +| `isAuthorized` | `boolean` | `!!this.bearerProfile` | The client is authorized if the bearer profile is available | [client.ts:104](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L104) | +| `state` | `undefined` \| `string` | `undefined` | The state parameter is used to maintain state between the request and the callback. | [client.ts:110](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L110) | -#### getAddress() +## Authentication -> **getAddress**(`address`): `Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\> +### authorize() -# 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. +> **authorize**(`client`?: [`AuthFlowOptions`](/docs/packages/sdk/interfaces/AuthFlowOptions.md)): `Promise`\<`void`\> -##### Parameters +[API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) -• **address**: `string` +Construct the url to the authorization code flow and redirects, +Code Verifier needed for the code challenge is stored in local storage +For automatic wallet link, add the following properties: `address`, `signature` & `chain` -The public key of the blockchain account. -[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) +#### Parameters -##### Returns +| Parameter | Type | +| ------ | ------ | +| `client`? | [`AuthFlowOptions`](/docs/packages/sdk/interfaces/AuthFlowOptions.md) | -`Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\> +#### Returns -##### Example +`Promise`\<`void`\> -``` -monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') -``` +string -##### Defined in +#### Defined in -[client.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L333) +[client.ts:161](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L161) *** -#### getAddresses() +### disconnect() -> **getAddresses**(`__namedParameters`): `Promise`\<[`Addresses`](/docs/packages/SDK/interfaces/Addresses.md)\> - -[https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses](https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses) - -##### Parameters +> **disconnect**(): `Promise`\<`void`\> -• **\_\_namedParameters**: [`AddressesQueryParams`](/docs/packages/SDK/interfaces/AddressesQueryParams.md) = `{}` +Cleanups the socket and the subscriptions -##### Returns +#### Returns -`Promise`\<[`Addresses`](/docs/packages/SDK/interfaces/Addresses.md)\> +`Promise`\<`void`\> -##### Defined in +#### Defined in -[client.ts:343](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L343) +[client.ts:723](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L723) *** -#### getBalances() +### getAccess() -> **getBalances**(`profile`): `Promise`\<[`Balances`](/docs/packages/SDK/interfaces/Balances.md)[]\> +> **getAccess**(`client`?: [`ClientCredentials`](/docs/packages/sdk/interfaces/ClientCredentials.md) \| [`AuthorizationCodeCredentials`](/docs/packages/sdk/interfaces/AuthorizationCodeCredentials.md)): `Promise`\<`boolean`\> -[https://monerium.dev/api-docs-v2#tag/addresses/operation/profile-balances](https://monerium.dev/api-docs-v2#tag/addresses/operation/profile-balances) +Will redirect to the authorization code flow and store the code verifier in the local storage -##### Parameters +#### Parameters -• **profile**: `string` +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `client`? | [`ClientCredentials`](/docs/packages/sdk/interfaces/ClientCredentials.md) \| [`AuthorizationCodeCredentials`](/docs/packages/sdk/interfaces/AuthorizationCodeCredentials.md) | the client credentials | -##### Returns +#### Returns -`Promise`\<[`Balances`](/docs/packages/SDK/interfaces/Balances.md)[]\> +`Promise`\<`boolean`\> -##### Defined in +boolean to indicate if access has been granted -[client.ts:359](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L359) +#### Example -*** +```ts + import { MoneriumClient } from '@monerium/sdk'; + // Initialize the client with credentials + const monerium = new MoneriumClient({ + environment: 'sandbox', + clientId: 'your_client_credentials_uuid', // replace with your client ID + clientSecret: 'your_client_secret', // replace with your client secret + }); -#### linkAddress() +await monerium.getAccess(); +``` -> **linkAddress**(`body`): `Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +#### Defined in -[https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address](https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address) +[client.ts:210](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L210) -##### Parameters +*** -• **body**: [`LinkAddress`](/docs/packages/SDK/interfaces/LinkAddress.md) +### revokeAccess() -##### Returns +> **revokeAccess**(): `Promise`\<`void`\> -`Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +Revokes access -##### Defined in +#### Returns -[client.ts:412](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L412) +`Promise`\<`void`\> -### Authentication +#### Defined in -#### authorize() +[client.ts:736](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L736) -> **authorize**(`client`?): `Promise`\<`void`\> +*** -Construct the url to the authorization code flow and redirects, -Code Verifier needed for the code challenge is stored in local storage -For automatic wallet link, add the following properties: `address`, `signature` & `chain` +### signUp() -##### Parameters +> **signUp**(`body`: [`SignUpPayload`](/docs/packages/sdk/interfaces/SignUpPayload.md)): `Promise`\<[`SignUpResponse`](/docs/packages/sdk/interfaces/SignUpResponse.md)\> -• **client?**: [`AuthFlowOptions`](/docs/packages/SDK/interfaces/AuthFlowOptions.md) +[API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth-signup) -##### Returns +#### Parameters -`Promise`\<`void`\> +| Parameter | Type | +| ------ | ------ | +| `body` | [`SignUpPayload`](/docs/packages/sdk/interfaces/SignUpPayload.md) | -string +#### Returns -##### Link +`Promise`\<[`SignUpResponse`](/docs/packages/sdk/interfaces/SignUpResponse.md)\> -[API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) +#### Defined in -##### Defined in +[client.ts:520](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L520) -[client.ts:148](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L148) +## Addresses -*** +### getAddress() -#### disconnect() +> **getAddress**(`address`: `string`): `Promise`\<[`Address`](/docs/packages/sdk/interfaces/Address.md)\> -> **disconnect**(): `Promise`\<`void`\> +Get details for a single address by using the address public key after the address has been successfully linked to Monerium. -Cleanups the socket and the subscriptions +#### Parameters -##### Returns +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `address` | `string` | The public key of the blockchain account. [API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) | -`Promise`\<`void`\> +#### Returns -##### Defined in +`Promise`\<[`Address`](/docs/packages/sdk/interfaces/Address.md)\> -[client.ts:669](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L669) +#### Example -*** +```ts + monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') +``` -#### getAccess() +#### Defined in -> **getAccess**(`client`?): `Promise`\<`boolean`\> +[client.ts:357](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L357) -Will redirect to the authorization code flow and store the code verifier in the local storage +*** -##### Parameters +### getAddresses() -• **client?**: [`ClientCredentials`](/docs/packages/SDK/interfaces/ClientCredentials.md) \| [`AuthorizationCodeCredentials`](/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md) +> **getAddresses**(`params`: [`AddressesQueryParams`](/docs/packages/sdk/interfaces/AddressesQueryParams.md)): `Promise`\<[`Addresses`](/docs/packages/sdk/interfaces/Addresses.md)\> -the client credentials +[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses) -##### Returns +#### Parameters -`Promise`\<`boolean`\> +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `params` | [`AddressesQueryParams`](/docs/packages/sdk/interfaces/AddressesQueryParams.md) | No required parameters. | -boolean to indicate if access has been granted +#### Returns -##### Example +`Promise`\<[`Addresses`](/docs/packages/sdk/interfaces/Addresses.md)\> -```ts -import { MoneriumClient } from '@monerium/sdk'; - // Initialize the client with credentials - const monerium = new MoneriumClient({ - environment: 'sandbox', - clientId: 'your_client_credentials_uuid', // replace with your client ID - clientSecret: 'your_client_secret', // replace with your client secret - }); +#### Defined in -await monerium.getAccess(); -``` +[client.ts:370](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L370) -##### Defined in +*** -[client.ts:190](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L190) +### getBalances() -*** +> **getBalances**(`profile`: `string`): `Promise`\<[`Balances`](/docs/packages/sdk/interfaces/Balances.md)[]\> -#### revokeAccess() +[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/profile-balances) -> **revokeAccess**(): `Promise`\<`void`\> +#### Parameters -Revokes access +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `profile` | `string` | the id of the profile to fetch balances. | -##### Returns +#### Returns -`Promise`\<`void`\> +`Promise`\<[`Balances`](/docs/packages/sdk/interfaces/Balances.md)[]\> -##### Defined in +#### Defined in -[client.ts:681](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L681) +[client.ts:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L389) *** -#### signUp() +### linkAddress() -> **signUp**(`body`): `Promise`\<[`SignUpResponse`](/docs/packages/SDK/interfaces/SignUpResponse.md)\> +> **linkAddress**(`body`: [`LinkAddress`](/docs/packages/sdk/interfaces/LinkAddress.md)): `Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -[https://monerium.dev/api-docs-v2#tag/auth/operation/auth-signup](https://monerium.dev/api-docs-v2#tag/auth/operation/auth-signup) +Add a new address to the profile +[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address) -##### Parameters +#### Parameters -• **body**: [`SignUpPayload`](/docs/packages/SDK/interfaces/SignUpPayload.md) +| Parameter | Type | +| ------ | ------ | +| `body` | [`LinkAddress`](/docs/packages/sdk/interfaces/LinkAddress.md) | -##### Returns +#### Returns -`Promise`\<[`SignUpResponse`](/docs/packages/SDK/interfaces/SignUpResponse.md)\> +`Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -##### Defined in +#### Defined in -[client.ts:468](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L468) +[client.ts:455](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L455) -### IBANs +## Profiles -#### getIban() +### getProfile() -> **getIban**(`iban`): `Promise`\<[`IBAN`](/docs/packages/SDK/interfaces/IBAN.md)\> +> **getProfile**(`profile`: `string`): `Promise`\<[`Profile`](/docs/packages/sdk/interfaces/Profile.md)\> -"https://monerium.dev/api-docs-v2#tag/ibans/operation/iban" +[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) -##### Parameters +#### Parameters -• **iban**: `string` +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `profile` | `string` | the id of the profile to fetch. | -##### Returns +#### Returns -`Promise`\<[`IBAN`](/docs/packages/SDK/interfaces/IBAN.md)\> +`Promise`\<[`Profile`](/docs/packages/sdk/interfaces/Profile.md)\> -##### Defined in +#### Defined in -[client.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L367) +[client.ts:332](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L332) *** -#### getIbans() +### getProfiles() -> **getIbans**(`queryParameters`?): `Promise`\<[`IBANsResponse`](/docs/packages/SDK/interfaces/IBANsResponse.md)\> +> **getProfiles**(`params`?: [`ProfilesQueryParams`](/docs/packages/sdk/interfaces/ProfilesQueryParams.md)): `Promise`\<[`ProfilesResponse`](/docs/packages/sdk/interfaces/ProfilesResponse.md)\> -"https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans" +[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profiles) -##### Parameters +#### Parameters -• **queryParameters?**: [`IbansQueryParams`](/docs/packages/SDK/interfaces/IbansQueryParams.md) +| Parameter | Type | +| ------ | ------ | +| `params`? | [`ProfilesQueryParams`](/docs/packages/sdk/interfaces/ProfilesQueryParams.md) | -##### Returns +#### Returns -`Promise`\<[`IBANsResponse`](/docs/packages/SDK/interfaces/IBANsResponse.md)\> +`Promise`\<[`ProfilesResponse`](/docs/packages/sdk/interfaces/ProfilesResponse.md)\> -##### Defined in +#### Defined in -[client.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L374) +[client.ts:340](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L340) *** -#### moveIban() - -> **moveIban**(`iban`, `__namedParameters`): `Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> - -[https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban](https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban) - -##### Parameters +### submitProfileDetails() -• **iban**: `string` +> **submitProfileDetails**(`profile`: `string`, `body`: [`SubmitProfileDetailsPayload`](/docs/packages/sdk/type-aliases/SubmitProfileDetailsPayload.md)): `Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -• **\_\_namedParameters**: [`MoveIbanPayload`](/docs/packages/SDK/interfaces/MoveIbanPayload.md) +[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details) -##### Returns +#### Parameters -`Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +| Parameter | Type | +| ------ | ------ | +| `profile` | `string` | +| `body` | [`SubmitProfileDetailsPayload`](/docs/packages/sdk/type-aliases/SubmitProfileDetailsPayload.md) | -##### Defined in +#### Returns -[client.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L438) +`Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -*** +#### Defined in -#### requestIban() +[client.ts:533](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L533) -> **requestIban**(`__namedParameters`): `Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +## IBANs -[https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban](https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban) +### getIban() -##### Parameters +> **getIban**(`iban`: `string`): `Promise`\<[`IBAN`](/docs/packages/sdk/interfaces/IBAN.md)\> -• **\_\_namedParameters**: [`RequestIbanPayload`](/docs/packages/SDK/interfaces/RequestIbanPayload.md) +Fetch details about a single IBAN -##### Returns +[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/iban) -`Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +#### Parameters -##### Defined in +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `iban` | `string` | the IBAN to fetch. | -[client.ts:452](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L452) +#### Returns -### Orders -[Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) +`Promise`\<[`IBAN`](/docs/packages/sdk/interfaces/IBAN.md)\> -#### connectOrderNotifications() +#### Defined in -> **connectOrderNotifications**(`__namedParameters`): `undefined` \| `WebSocket` +[client.ts:403](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L403) -Connects to the order notifications socket +*** -##### Parameters +### getIbans() -• **\_\_namedParameters** = `{}` +> **getIbans**(`queryParameters`?: [`IbansQueryParams`](/docs/packages/sdk/interfaces/IbansQueryParams.md)): `Promise`\<[`IBANsResponse`](/docs/packages/sdk/interfaces/IBANsResponse.md)\> -• **\_\_namedParameters.filter?**: [`OrderNotificationQueryParams`](/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md) +Fetch all IBANs for the profile +[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans) -• **\_\_namedParameters.onError?** +#### Parameters -• **\_\_namedParameters.onMessage?** +| Parameter | Type | +| ------ | ------ | +| `queryParameters`? | [`IbansQueryParams`](/docs/packages/sdk/interfaces/IbansQueryParams.md) | -##### Returns +#### Returns -`undefined` \| `WebSocket` +`Promise`\<[`IBANsResponse`](/docs/packages/sdk/interfaces/IBANsResponse.md)\> -##### Defined in +#### Defined in -[client.ts:589](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L589) +[client.ts:413](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L413) *** -#### disconnectOrderNotifications() - -> **disconnectOrderNotifications**(`queryParameters`?): `void` - -Closes the order notifications sockets - -##### Parameters +### moveIban() -• **queryParameters?**: [`OrderNotificationQueryParams`](/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md) +> **moveIban**(`iban`: `string`, `payload`: [`MoveIbanPayload`](/docs/packages/sdk/interfaces/MoveIbanPayload.md)): `Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -##### Returns +[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban) -`void` +#### Parameters -##### Defined in +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `iban` | `string` | the IBAN to move. | +| `payload` | [`MoveIbanPayload`](/docs/packages/sdk/interfaces/MoveIbanPayload.md) | the payload to move the IBAN. | -[client.ts:644](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L644) +#### Returns -### Profiles +`Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -#### getProfile() +#### Defined in -> **getProfile**(`profile`): `Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\> +[client.ts:485](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L485) -# TELL +*** -##### Parameters +### requestIban() -• **profile**: `string` +> **requestIban**(`payload`: [`RequestIbanPayload`](/docs/packages/sdk/interfaces/RequestIbanPayload.md)): `Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -the id of the profile to fetch. +[API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban) -##### Returns +#### Parameters -`Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\> +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `payload` | [`RequestIbanPayload`](/docs/packages/sdk/interfaces/RequestIbanPayload.md) | the payload to request an IBAN. | -##### Link +#### Returns -[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) +`Promise`\<[`ResponseStatus`](/docs/packages/sdk/type-aliases/ResponseStatus.md)\> -##### Defined in +#### Defined in -[client.ts:312](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L312) +[client.ts:503](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L503) -*** +## Orders -#### getProfiles() +### connectOrderNotifications() -> **getProfiles**(`params`?): `Promise`\<[`ProfilesResponse`](/docs/packages/SDK/interfaces/ProfilesResponse.md)\> +> **connectOrderNotifications**(`__namedParameters`: \{`filter`: [`OrderNotificationQueryParams`](/docs/packages/sdk/interfaces/OrderNotificationQueryParams.md);`onError`: (`err`: `Event`) => `void`;`onMessage`: (`data`: [`Order`](/docs/packages/sdk/interfaces/Order.md)) => `void`; \}): `undefined` \| `WebSocket` -[https://monerium.dev/api-docs-v2#tag/profiles/operation/profiles](https://monerium.dev/api-docs-v2#tag/profiles/operation/profiles) +Connects to the order notifications socket +[Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) -##### Parameters +#### Parameters -• **params?**: [`ProfilesQueryParams`](/docs/packages/SDK/interfaces/ProfilesQueryParams.md) +| Parameter | Type | +| ------ | ------ | +| `__namedParameters` | `object` | +| `__namedParameters.filter`? | [`OrderNotificationQueryParams`](/docs/packages/sdk/interfaces/OrderNotificationQueryParams.md) | +| `__namedParameters.onError`? | (`err`: `Event`) => `void` | +| `__namedParameters.onMessage`? | (`data`: [`Order`](/docs/packages/sdk/interfaces/Order.md)) => `void` | -##### Returns +#### Returns -`Promise`\<[`ProfilesResponse`](/docs/packages/SDK/interfaces/ProfilesResponse.md)\> +`undefined` \| `WebSocket` -##### Defined in +#### Defined in -[client.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L319) +[client.ts:641](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L641) *** -#### submitProfileDetails() - -> **submitProfileDetails**(`profile`, `body`): `Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +### disconnectOrderNotifications() -[https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details) +> **disconnectOrderNotifications**(`queryParameters`?: [`OrderNotificationQueryParams`](/docs/packages/sdk/interfaces/OrderNotificationQueryParams.md)): `void` -##### Parameters +Closes the order notifications sockets +[Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) -• **profile**: `string` +#### Parameters -• **body**: [`SubmitProfileDetailsPayload`](/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md) +| Parameter | Type | +| ------ | ------ | +| `queryParameters`? | [`OrderNotificationQueryParams`](/docs/packages/sdk/interfaces/OrderNotificationQueryParams.md) | -##### Returns +#### Returns -`Promise`\<[`ResponseStatus`](/docs/packages/SDK/type-aliases/ResponseStatus.md)\> +`void` -##### Defined in +#### Defined in -[client.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L480) +[client.ts:697](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L697) -### Orders +*** -#### getOrder() +### getOrder() -> **getOrder**(`orderId`): `Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)\> +> **getOrder**(`orderId`: `string`): `Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)\> -[https://monerium.dev/api-docs-v2#tag/order](https://monerium.dev/api-docs-v2#tag/order) +[API Documentation](https://monerium.dev/api-docs-v2#tag/order) -##### Parameters +#### Parameters -• **orderId**: `string` +| Parameter | Type | +| ------ | ------ | +| `orderId` | `string` | -##### Returns +#### Returns -`Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)\> +`Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)\> -##### Defined in +#### Defined in -[client.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L394) +[client.ts:435](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L435) *** -#### getOrders() +### getOrders() -> **getOrders**(`filter`?): `Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)[]\> +> **getOrders**(`filter`?: [`OrderFilter`](/docs/packages/sdk/interfaces/OrderFilter.md)): `Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)[]\> -[https://monerium.dev/api-docs-v2#tag/orders](https://monerium.dev/api-docs-v2#tag/orders) +[API Documentation](https://monerium.dev/api-docs-v2#tag/orders) -##### Parameters +#### Parameters -• **filter?**: [`OrderFilter`](/docs/packages/SDK/interfaces/OrderFilter.md) +| Parameter | Type | +| ------ | ------ | +| `filter`? | [`OrderFilter`](/docs/packages/sdk/interfaces/OrderFilter.md) | -##### Returns +#### Returns -`Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)[]\> +`Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)[]\> -##### Defined in +#### Defined in -[client.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L387) +[client.ts:427](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L427) *** -#### placeOrder() +### placeOrder() -> **placeOrder**(`order`): `Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)\> +> **placeOrder**(`order`: [`NewOrder`](/docs/packages/sdk/type-aliases/NewOrder.md)): `Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)\> -[https://monerium.dev/api-docs-v2#tag/orders/operation/post-orders](https://monerium.dev/api-docs-v2#tag/orders/operation/post-orders) +[API Documentation](https://monerium.dev/api-docs-v2#tag/orders/operation/post-orders) -##### Parameters +#### Parameters -• **order**: [`NewOrder`](/docs/packages/SDK/type-aliases/NewOrder.md) +| Parameter | Type | +| ------ | ------ | +| `order` | [`NewOrder`](/docs/packages/sdk/type-aliases/NewOrder.md) | -##### Returns +#### Returns -`Promise`\<[`Order`](/docs/packages/SDK/interfaces/Order.md)\> +`Promise`\<[`Order`](/docs/packages/sdk/interfaces/Order.md)\> -##### Defined in +#### Defined in -[client.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L421) +[client.ts:465](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L465) *** -#### uploadSupportingDocument() +### uploadSupportingDocument() -> **uploadSupportingDocument**(`document`): `Promise`\<[`SupportingDoc`](/docs/packages/SDK/interfaces/SupportingDoc.md)\> +> **uploadSupportingDocument**(`document`: `File`): `Promise`\<[`SupportingDoc`](/docs/packages/sdk/interfaces/SupportingDoc.md)\> -[https://monerium.dev/api-docs-v2#tag/orders/operation/supporting-document](https://monerium.dev/api-docs-v2#tag/orders/operation/supporting-document) +[API Documentation](https://monerium.dev/api-docs-v2#tag/orders/operation/supporting-document) -##### Parameters +#### Parameters -• **document**: `File` +| Parameter | Type | +| ------ | ------ | +| `document` | `File` | -##### Returns +#### Returns -`Promise`\<[`SupportingDoc`](/docs/packages/SDK/interfaces/SupportingDoc.md)\> +`Promise`\<[`SupportingDoc`](/docs/packages/sdk/interfaces/SupportingDoc.md)\> -##### Defined in +#### Defined in -[client.ts:495](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L495) +[client.ts:549](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L549) -### Tokens +## Tokens -#### getTokens() +### getTokens() -> **getTokens**(): `Promise`\<[`Token`](/docs/packages/SDK/interfaces/Token.md)[]\> +> **getTokens**(): `Promise`\<[`Token`](/docs/packages/sdk/interfaces/Token.md)[]\> -[https://monerium.dev/api-docs-v2#tag/tokens](https://monerium.dev/api-docs-v2#tag/tokens) +[API Documentation](https://monerium.dev/api-docs-v2#tag/tokens) -##### Returns +#### Returns -`Promise`\<[`Token`](/docs/packages/SDK/interfaces/Token.md)[]\> +`Promise`\<[`Token`](/docs/packages/sdk/interfaces/Token.md)[]\> -##### Defined in +#### Defined in -[client.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L402) +[client.ts:444](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L444) diff --git a/apps/developer/docs/packages/SDK/enumerations/AccountState.md b/apps/developer/docs/packages/SDK/enumerations/AccountState.md index dcf2680a..5c2bcdb9 100644 --- a/apps/developer/docs/packages/SDK/enumerations/AccountState.md +++ b/apps/developer/docs/packages/SDK/enumerations/AccountState.md @@ -2,30 +2,8 @@ ## Enumeration Members -### approved - -> **approved**: `"approved"` - -#### Defined in - -[types.ts:166](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L166) - -*** - -### pending - -> **pending**: `"pending"` - -#### Defined in - -[types.ts:167](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L167) - -*** - -### requested - -> **requested**: `"requested"` - -#### Defined in - -[types.ts:165](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L165) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `approved` | `"approved"` | [types.ts:166](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L166) | +| `pending` | `"pending"` | [types.ts:167](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L167) | +| `requested` | `"requested"` | [types.ts:165](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L165) | diff --git a/apps/developer/docs/packages/SDK/enumerations/Currency.md b/apps/developer/docs/packages/SDK/enumerations/Currency.md index efb09687..65a75ea6 100644 --- a/apps/developer/docs/packages/SDK/enumerations/Currency.md +++ b/apps/developer/docs/packages/SDK/enumerations/Currency.md @@ -2,40 +2,9 @@ ## Enumeration Members -### eur - -> **eur**: `"eur"` - -#### Defined in - -[types.ts:20](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L20) - -*** - -### gbp - -> **gbp**: `"gbp"` - -#### Defined in - -[types.ts:22](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L22) - -*** - -### isk - -> **isk**: `"isk"` - -#### Defined in - -[types.ts:23](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L23) - -*** - -### usd - -> **usd**: `"usd"` - -#### Defined in - -[types.ts:21](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L21) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `eur` | `"eur"` | [types.ts:20](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L20) | +| `gbp` | `"gbp"` | [types.ts:22](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L22) | +| `isk` | `"isk"` | [types.ts:23](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L23) | +| `usd` | `"usd"` | [types.ts:21](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L21) | diff --git a/apps/developer/docs/packages/SDK/enumerations/IdDocumentKind.md b/apps/developer/docs/packages/SDK/enumerations/IdDocumentKind.md index 31d7f2b4..3437b9b8 100644 --- a/apps/developer/docs/packages/SDK/enumerations/IdDocumentKind.md +++ b/apps/developer/docs/packages/SDK/enumerations/IdDocumentKind.md @@ -5,30 +5,8 @@ The ID document must verify the person's name, birthday, and nationality ## Enumeration Members -### drivingLicense - -> **drivingLicense**: `"drivingLicense"` - -#### Defined in - -[types.ts:187](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L187) - -*** - -### nationalIdentityCard - -> **nationalIdentityCard**: `"nationalIdentityCard"` - -#### Defined in - -[types.ts:186](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L186) - -*** - -### passport - -> **passport**: `"passport"` - -#### Defined in - -[types.ts:185](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L185) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `drivingLicense` | `"drivingLicense"` | [types.ts:187](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L187) | +| `nationalIdentityCard` | `"nationalIdentityCard"` | [types.ts:186](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L186) | +| `passport` | `"passport"` | [types.ts:185](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L185) | diff --git a/apps/developer/docs/packages/SDK/enumerations/KYCOutcome.md b/apps/developer/docs/packages/SDK/enumerations/KYCOutcome.md index 5fe67bba..b8c4cdae 100644 --- a/apps/developer/docs/packages/SDK/enumerations/KYCOutcome.md +++ b/apps/developer/docs/packages/SDK/enumerations/KYCOutcome.md @@ -2,30 +2,8 @@ ## Enumeration Members -### approved - -> **approved**: `"approved"` - -#### Defined in - -[types.ts:159](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L159) - -*** - -### rejected - -> **rejected**: `"rejected"` - -#### Defined in - -[types.ts:160](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L160) - -*** - -### unknown - -> **unknown**: `"unknown"` - -#### Defined in - -[types.ts:161](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L161) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `approved` | `"approved"` | [types.ts:159](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L159) | +| `rejected` | `"rejected"` | [types.ts:160](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L160) | +| `unknown` | `"unknown"` | [types.ts:161](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L161) | diff --git a/apps/developer/docs/packages/SDK/enumerations/KYCState.md b/apps/developer/docs/packages/SDK/enumerations/KYCState.md index d62a60b9..577b76b9 100644 --- a/apps/developer/docs/packages/SDK/enumerations/KYCState.md +++ b/apps/developer/docs/packages/SDK/enumerations/KYCState.md @@ -2,40 +2,9 @@ ## Enumeration Members -### absent - -> **absent**: `"absent"` - -#### Defined in - -[types.ts:152](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L152) - -*** - -### confirmed - -> **confirmed**: `"confirmed"` - -#### Defined in - -[types.ts:155](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L155) - -*** - -### pending - -> **pending**: `"pending"` - -#### Defined in - -[types.ts:154](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L154) - -*** - -### submitted - -> **submitted**: `"submitted"` - -#### Defined in - -[types.ts:153](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L153) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `absent` | `"absent"` | [types.ts:152](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L152) | +| `confirmed` | `"confirmed"` | [types.ts:155](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L155) | +| `pending` | `"pending"` | [types.ts:154](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L154) | +| `submitted` | `"submitted"` | [types.ts:153](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L153) | diff --git a/apps/developer/docs/packages/SDK/enumerations/Method.md b/apps/developer/docs/packages/SDK/enumerations/Method.md index 3e76e835..4385f02f 100644 --- a/apps/developer/docs/packages/SDK/enumerations/Method.md +++ b/apps/developer/docs/packages/SDK/enumerations/Method.md @@ -2,40 +2,9 @@ ## Enumeration Members -### apiKey - -> **apiKey**: `"apiKey"` - -#### Defined in - -[types.ts:124](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L124) - -*** - -### jwt - -> **jwt**: `"jwt"` - -#### Defined in - -[types.ts:123](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L123) - -*** - -### password - -> **password**: `"password"` - -#### Defined in - -[types.ts:121](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L121) - -*** - -### resource - -> **resource**: `"resource"` - -#### Defined in - -[types.ts:122](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L122) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `apiKey` | `"apiKey"` | [types.ts:124](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L124) | +| `jwt` | `"jwt"` | [types.ts:123](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L123) | +| `password` | `"password"` | [types.ts:121](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L121) | +| `resource` | `"resource"` | [types.ts:122](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L122) | diff --git a/apps/developer/docs/packages/SDK/enumerations/OrderKind.md b/apps/developer/docs/packages/SDK/enumerations/OrderKind.md index 533c2795..90d1bc58 100644 --- a/apps/developer/docs/packages/SDK/enumerations/OrderKind.md +++ b/apps/developer/docs/packages/SDK/enumerations/OrderKind.md @@ -2,20 +2,7 @@ ## Enumeration Members -### issue - -> **issue**: `"issue"` - -#### Defined in - -[types.ts:309](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L309) - -*** - -### redeem - -> **redeem**: `"redeem"` - -#### Defined in - -[types.ts:308](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L308) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `issue` | `"issue"` | [types.ts:309](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L309) | +| `redeem` | `"redeem"` | [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 da07679c..be4d24fd 100644 --- a/apps/developer/docs/packages/SDK/enumerations/OrderState.md +++ b/apps/developer/docs/packages/SDK/enumerations/OrderState.md @@ -2,40 +2,9 @@ ## Enumeration Members -### pending - -> **pending**: `"pending"` - -#### Defined in - -[types.ts:314](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L314) - -*** - -### placed - -> **placed**: `"placed"` - -#### Defined in - -[types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313) - -*** - -### processed - -> **processed**: `"processed"` - -#### Defined in - -[types.ts:315](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L315) - -*** - -### rejected - -> **rejected**: `"rejected"` - -#### Defined in - -[types.ts:316](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L316) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `pending` | `"pending"` | [types.ts:314](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L314) | +| `placed` | `"placed"` | [types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313) | +| `processed` | `"processed"` | [types.ts:315](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L315) | +| `rejected` | `"rejected"` | [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/enumerations/PaymentStandard.md b/apps/developer/docs/packages/SDK/enumerations/PaymentStandard.md index 9701f1b1..d45712ff 100644 --- a/apps/developer/docs/packages/SDK/enumerations/PaymentStandard.md +++ b/apps/developer/docs/packages/SDK/enumerations/PaymentStandard.md @@ -2,30 +2,8 @@ ## Enumeration Members -### chain - -> **chain**: `"chain"` - -#### Defined in - -[types.ts:178](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L178) - -*** - -### iban - -> **iban**: `"iban"` - -#### Defined in - -[types.ts:176](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L176) - -*** - -### scan - -> **scan**: `"scan"` - -#### Defined in - -[types.ts:177](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L177) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `chain` | `"chain"` | [types.ts:178](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L178) | +| `iban` | `"iban"` | [types.ts:176](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L176) | +| `scan` | `"scan"` | [types.ts:177](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L177) | diff --git a/apps/developer/docs/packages/SDK/enumerations/Permission.md b/apps/developer/docs/packages/SDK/enumerations/Permission.md index 8efde67d..089f5547 100644 --- a/apps/developer/docs/packages/SDK/enumerations/Permission.md +++ b/apps/developer/docs/packages/SDK/enumerations/Permission.md @@ -2,20 +2,7 @@ ## Enumeration Members -### read - -> **read**: `"read"` - -#### Defined in - -[types.ts:133](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L133) - -*** - -### write - -> **write**: `"write"` - -#### Defined in - -[types.ts:134](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L134) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `read` | `"read"` | [types.ts:133](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L133) | +| `write` | `"write"` | [types.ts:134](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L134) | diff --git a/apps/developer/docs/packages/SDK/enumerations/ProfileState.md b/apps/developer/docs/packages/SDK/enumerations/ProfileState.md index 9927bcee..0cee680c 100644 --- a/apps/developer/docs/packages/SDK/enumerations/ProfileState.md +++ b/apps/developer/docs/packages/SDK/enumerations/ProfileState.md @@ -2,60 +2,10 @@ ## Enumeration Members -### approved - -> **approved**: `"approved"` - -The profile is active and all Monerium services are supported. - -#### Defined in - -[types.ts:144](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L144) - -*** - -### blocked - -> **blocked**: `"blocked"` - -Monerium is unable to offer the applicant services because of compliance reasons. Details cannot be re-submitted. - -#### Defined in - -[types.ts:148](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L148) - -*** - -### created - -> **created**: `"created"` - -The profile has been created but no details have been submitted. - -#### Defined in - -[types.ts:140](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L140) - -*** - -### pending - -> **pending**: `"pending"` - -The details have been submitted and are being processed. - -#### Defined in - -[types.ts:142](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L142) - -*** - -### rejected - -> **rejected**: `"rejected"` - -The applicant details did not meet the compliance requirements of Monerium. Details can be fixed and re-submitted for processing. - -#### Defined in - -[types.ts:146](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L146) +| Enumeration Member | Value | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `approved` | `"approved"` | The profile is active and all Monerium services are supported. | [types.ts:144](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L144) | +| `blocked` | `"blocked"` | Monerium is unable to offer the applicant services because of compliance reasons. Details cannot be re-submitted. | [types.ts:148](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L148) | +| `created` | `"created"` | The profile has been created but no details have been submitted. | [types.ts:140](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L140) | +| `pending` | `"pending"` | The details have been submitted and are being processed. | [types.ts:142](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L142) | +| `rejected` | `"rejected"` | The applicant details did not meet the compliance requirements of Monerium. Details can be fixed and re-submitted for processing. | [types.ts:146](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L146) | diff --git a/apps/developer/docs/packages/SDK/enumerations/ProfileType.md b/apps/developer/docs/packages/SDK/enumerations/ProfileType.md index a41490d0..f5f4c3ce 100644 --- a/apps/developer/docs/packages/SDK/enumerations/ProfileType.md +++ b/apps/developer/docs/packages/SDK/enumerations/ProfileType.md @@ -2,20 +2,7 @@ ## Enumeration Members -### corporate - -> **corporate**: `"corporate"` - -#### Defined in - -[types.ts:128](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L128) - -*** - -### personal - -> **personal**: `"personal"` - -#### Defined in - -[types.ts:129](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L129) +| Enumeration Member | Value | Defined in | +| ------ | ------ | ------ | +| `corporate` | `"corporate"` | [types.ts:128](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L128) | +| `personal` | `"personal"` | [types.ts:129](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L129) | diff --git a/apps/developer/docs/packages/SDK/functions/getChain.md b/apps/developer/docs/packages/SDK/functions/getChain.md index 7906fdea..0c69b6ba 100644 --- a/apps/developer/docs/packages/SDK/functions/getChain.md +++ b/apps/developer/docs/packages/SDK/functions/getChain.md @@ -1,17 +1,34 @@ # Function: getChain() -> **getChain**(`chainId`): [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) +> **getChain**(`chainId`: `number`): [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) + +This will resolve the chainId number to the corresponding chain name. ## Parameters -• **chainId**: `number` +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `chainId` | `number` | The chainId of the network | ## Returns -[`Chain`](/docs/packages/SDK/type-aliases/Chain.md) +[`Chain`](/docs/packages/sdk/type-aliases/Chain.md) + +chain name + +## Example + +```ts +getChain(1) // 'ethereum' +getChain(11155111) // 'ethereum' + +getChain(100) // 'gnosis' +getChain(10200) // 'gnosis' -The Chain +getChain(137) // 'polygon' +getChain(80002) // 'polygon' +``` ## Defined in -[utils.ts:93](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L93) +[utils.ts:124](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L124) diff --git a/apps/developer/docs/packages/SDK/functions/placeOrderMessage.md b/apps/developer/docs/packages/SDK/functions/placeOrderMessage.md index f82ea464..85ec1ecf 100644 --- a/apps/developer/docs/packages/SDK/functions/placeOrderMessage.md +++ b/apps/developer/docs/packages/SDK/functions/placeOrderMessage.md @@ -1,31 +1,42 @@ # Function: placeOrderMessage() -> **placeOrderMessage**(`amount`, `currency`, `receiver`, `chain`?): `string` +> **placeOrderMessage**(`amount`: `string` \| `number`, `currency`: [`Currency`](/docs/packages/sdk/enumerations/Currency.md), `receiver`: `string`, `chain`?: `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md)): `string` -## Parameters - -• **amount**: `string` \| `number` +The message to be signed when placing an order. -The amount to be sent - -• **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) +## Parameters -The currency to be sent +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `amount` | `string` \| `number` | The amount to be sent | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | The currency to be sent | +| `receiver` | `string` | The receiver of the funds | +| `chain`? | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | The chainId of the network if it's a cross-chain transaction | -• **receiver**: `string` +## Returns -The receiver of the funds +`string` -• **chain?**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) +cross-chain: +```ts + Send {CURRENCY} {AMOUNT} to {RECEIVER} on {CHAIN} at {DATE}` +``` -The chainId of the network if it's a cross-chain transaction +off-ramp: +```ts + Send {CURRENCY} {AMOUNT} to {RECEIVER} at {DATE} +``` -## Returns +## Examples -`string` +```ts +`Send EUR 1 to 0x1234123412341234123412341234123412341234 on ethereum at 2023-04-30T12:00:00+01:00` +``` -string +```ts +`Send EUR 1 to IS1234123412341234 at 2023-04-30T12:00:00+01:00` +``` ## Defined in -[utils.ts:56](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L56) +[utils.ts:75](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L75) diff --git a/apps/developer/docs/packages/SDK/functions/rfc3339.md b/apps/developer/docs/packages/SDK/functions/rfc3339.md index 75d5ecd2..a7d9a684 100644 --- a/apps/developer/docs/packages/SDK/functions/rfc3339.md +++ b/apps/developer/docs/packages/SDK/functions/rfc3339.md @@ -1,15 +1,29 @@ # Function: rfc3339() -> **rfc3339**(`d`): `string` +> **rfc3339**(`d`: `Date`): `string` ## Parameters -• **d**: `Date` +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `d` | `Date` | Date to be formatted | ## Returns `string` +RFC3339 date format. + +## Examples + +```ts +2023-04-30T12:00:00+01:00 +``` + +```ts +2023-04-30T02:08:15Z +``` + ## Defined in -[utils.ts:3](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L3) +[utils.ts:10](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/utils.ts#L10) diff --git a/apps/developer/docs/packages/SDK/index.md b/apps/developer/docs/packages/SDK/index.md index 7b0a0c77..63a3de72 100644 --- a/apps/developer/docs/packages/SDK/index.md +++ b/apps/developer/docs/packages/SDK/index.md @@ -1,111 +1,111 @@ -# SDK +# @monerium/sdk ## References ### default -Renames and re-exports [MoneriumClient](/docs/packages/SDK/classes/MoneriumClient.md) +Renames and re-exports [MoneriumClient](/docs/packages/sdk/classes/MoneriumClient.md) ## Classes -- [MoneriumClient](/docs/packages/SDK/classes/MoneriumClient.md) +- [MoneriumClient](/docs/packages/sdk/classes/MoneriumClient.md) -## Variables +## Functions -- [constants](/docs/packages/SDK/variables/constants.md) +- [getChain](/docs/packages/sdk/functions/getChain.md) +- [placeOrderMessage](/docs/packages/sdk/functions/placeOrderMessage.md) +- [rfc3339](/docs/packages/sdk/functions/rfc3339.md) -## Functions +## Variables -- [getChain](/docs/packages/SDK/functions/getChain.md) -- [placeOrderMessage](/docs/packages/SDK/functions/placeOrderMessage.md) -- [rfc3339](/docs/packages/SDK/functions/rfc3339.md) +- [constants](/docs/packages/sdk/variables/constants.md) ## Interfaces -- [Address](/docs/packages/SDK/interfaces/Address.md) -- [Addresses](/docs/packages/SDK/interfaces/Addresses.md) -- [AddressesQueryParams](/docs/packages/SDK/interfaces/AddressesQueryParams.md) -- [AuthCodePayload](/docs/packages/SDK/interfaces/AuthCodePayload.md) -- [AuthFlowOptions](/docs/packages/SDK/interfaces/AuthFlowOptions.md) -- [AuthorizationCodeCredentials](/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md) -- [Balances](/docs/packages/SDK/interfaces/Balances.md) -- [BearerProfile](/docs/packages/SDK/interfaces/BearerProfile.md) -- [ClientCredentials](/docs/packages/SDK/interfaces/ClientCredentials.md) -- [ClientCredentialsPayload](/docs/packages/SDK/interfaces/ClientCredentialsPayload.md) -- [CorporateProfileDetails](/docs/packages/SDK/interfaces/CorporateProfileDetails.md) -- [CorporateProfileDetailsRequest](/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md) -- [Corporation](/docs/packages/SDK/interfaces/Corporation.md) -- [Counterpart](/docs/packages/SDK/interfaces/Counterpart.md) -- [CrossChainIdentifier](/docs/packages/SDK/interfaces/CrossChainIdentifier.md) -- [CurrencyBalance](/docs/packages/SDK/interfaces/CurrencyBalance.md) -- [Fee](/docs/packages/SDK/interfaces/Fee.md) -- [IBAN](/docs/packages/SDK/interfaces/IBAN.md) -- [IBANIdentifier](/docs/packages/SDK/interfaces/IBANIdentifier.md) -- [IBANsResponse](/docs/packages/SDK/interfaces/IBANsResponse.md) -- [IbansQueryParams](/docs/packages/SDK/interfaces/IbansQueryParams.md) -- [Identifier](/docs/packages/SDK/interfaces/Identifier.md) -- [Individual](/docs/packages/SDK/interfaces/Individual.md) -- [KYC](/docs/packages/SDK/interfaces/KYC.md) -- [LinkAddress](/docs/packages/SDK/interfaces/LinkAddress.md) -- [MoveIbanPayload](/docs/packages/SDK/interfaces/MoveIbanPayload.md) -- [NewOrderByAccountId](/docs/packages/SDK/interfaces/NewOrderByAccountId.md) -- [NewOrderByAddress](/docs/packages/SDK/interfaces/NewOrderByAddress.md) -- [NewOrderCommon](/docs/packages/SDK/interfaces/NewOrderCommon.md) -- [Order](/docs/packages/SDK/interfaces/Order.md) -- [OrderFilter](/docs/packages/SDK/interfaces/OrderFilter.md) -- [OrderMetadata](/docs/packages/SDK/interfaces/OrderMetadata.md) -- [OrderNotificationQueryParams](/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md) -- [PersonalProfileDetails](/docs/packages/SDK/interfaces/PersonalProfileDetails.md) -- [PersonalProfileDetailsRequest](/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md) -- [Profile](/docs/packages/SDK/interfaces/Profile.md) -- [ProfilePermissions](/docs/packages/SDK/interfaces/ProfilePermissions.md) -- [ProfilesQueryParams](/docs/packages/SDK/interfaces/ProfilesQueryParams.md) -- [ProfilesResponse](/docs/packages/SDK/interfaces/ProfilesResponse.md) -- [RefreshTokenPayload](/docs/packages/SDK/interfaces/RefreshTokenPayload.md) -- [RequestIbanPayload](/docs/packages/SDK/interfaces/RequestIbanPayload.md) -- [SCANIdentifier](/docs/packages/SDK/interfaces/SCANIdentifier.md) -- [SignUpPayload](/docs/packages/SDK/interfaces/SignUpPayload.md) -- [SignUpResponse](/docs/packages/SDK/interfaces/SignUpResponse.md) -- [SupportingDoc](/docs/packages/SDK/interfaces/SupportingDoc.md) -- [SupportingDocMetadata](/docs/packages/SDK/interfaces/SupportingDocMetadata.md) -- [Token](/docs/packages/SDK/interfaces/Token.md) +- [Address](/docs/packages/sdk/interfaces/Address.md) +- [Addresses](/docs/packages/sdk/interfaces/Addresses.md) +- [AddressesQueryParams](/docs/packages/sdk/interfaces/AddressesQueryParams.md) +- [AuthCodePayload](/docs/packages/sdk/interfaces/AuthCodePayload.md) +- [AuthFlowOptions](/docs/packages/sdk/interfaces/AuthFlowOptions.md) +- [AuthorizationCodeCredentials](/docs/packages/sdk/interfaces/AuthorizationCodeCredentials.md) +- [Balances](/docs/packages/sdk/interfaces/Balances.md) +- [BearerProfile](/docs/packages/sdk/interfaces/BearerProfile.md) +- [ClientCredentials](/docs/packages/sdk/interfaces/ClientCredentials.md) +- [ClientCredentialsPayload](/docs/packages/sdk/interfaces/ClientCredentialsPayload.md) +- [CorporateProfileDetails](/docs/packages/sdk/interfaces/CorporateProfileDetails.md) +- [CorporateProfileDetailsRequest](/docs/packages/sdk/interfaces/CorporateProfileDetailsRequest.md) +- [Corporation](/docs/packages/sdk/interfaces/Corporation.md) +- [Counterpart](/docs/packages/sdk/interfaces/Counterpart.md) +- [CrossChainIdentifier](/docs/packages/sdk/interfaces/CrossChainIdentifier.md) +- [CurrencyBalance](/docs/packages/sdk/interfaces/CurrencyBalance.md) +- [Fee](/docs/packages/sdk/interfaces/Fee.md) +- [IBAN](/docs/packages/sdk/interfaces/IBAN.md) +- [IBANIdentifier](/docs/packages/sdk/interfaces/IBANIdentifier.md) +- [IBANsResponse](/docs/packages/sdk/interfaces/IBANsResponse.md) +- [IbansQueryParams](/docs/packages/sdk/interfaces/IbansQueryParams.md) +- [Identifier](/docs/packages/sdk/interfaces/Identifier.md) +- [Individual](/docs/packages/sdk/interfaces/Individual.md) +- [KYC](/docs/packages/sdk/interfaces/KYC.md) +- [LinkAddress](/docs/packages/sdk/interfaces/LinkAddress.md) +- [MoveIbanPayload](/docs/packages/sdk/interfaces/MoveIbanPayload.md) +- [NewOrderByAccountId](/docs/packages/sdk/interfaces/NewOrderByAccountId.md) +- [NewOrderByAddress](/docs/packages/sdk/interfaces/NewOrderByAddress.md) +- [NewOrderCommon](/docs/packages/sdk/interfaces/NewOrderCommon.md) +- [Order](/docs/packages/sdk/interfaces/Order.md) +- [OrderFilter](/docs/packages/sdk/interfaces/OrderFilter.md) +- [OrderMetadata](/docs/packages/sdk/interfaces/OrderMetadata.md) +- [OrderNotificationQueryParams](/docs/packages/sdk/interfaces/OrderNotificationQueryParams.md) +- [PersonalProfileDetails](/docs/packages/sdk/interfaces/PersonalProfileDetails.md) +- [PersonalProfileDetailsRequest](/docs/packages/sdk/interfaces/PersonalProfileDetailsRequest.md) +- [Profile](/docs/packages/sdk/interfaces/Profile.md) +- [ProfilePermissions](/docs/packages/sdk/interfaces/ProfilePermissions.md) +- [ProfilesQueryParams](/docs/packages/sdk/interfaces/ProfilesQueryParams.md) +- [ProfilesResponse](/docs/packages/sdk/interfaces/ProfilesResponse.md) +- [RefreshTokenPayload](/docs/packages/sdk/interfaces/RefreshTokenPayload.md) +- [RequestIbanPayload](/docs/packages/sdk/interfaces/RequestIbanPayload.md) +- [SCANIdentifier](/docs/packages/sdk/interfaces/SCANIdentifier.md) +- [SignUpPayload](/docs/packages/sdk/interfaces/SignUpPayload.md) +- [SignUpResponse](/docs/packages/sdk/interfaces/SignUpResponse.md) +- [SupportingDoc](/docs/packages/sdk/interfaces/SupportingDoc.md) +- [SupportingDocMetadata](/docs/packages/sdk/interfaces/SupportingDocMetadata.md) +- [Token](/docs/packages/sdk/interfaces/Token.md) ## Type Aliases -- [AuthArgs](/docs/packages/SDK/type-aliases/AuthArgs.md) -- [BearerTokenCredentials](/docs/packages/SDK/type-aliases/BearerTokenCredentials.md) -- [Beneficiary](/docs/packages/SDK/type-aliases/Beneficiary.md) -- [Chain](/docs/packages/SDK/type-aliases/Chain.md) -- [ChainId](/docs/packages/SDK/type-aliases/ChainId.md) -- [ClassOptions](/docs/packages/SDK/type-aliases/ClassOptions.md) -- [Config](/docs/packages/SDK/type-aliases/Config.md) -- [Director](/docs/packages/SDK/type-aliases/Director.md) -- [ENV](/docs/packages/SDK/type-aliases/ENV.md) -- [Environment](/docs/packages/SDK/type-aliases/Environment.md) -- [EthereumTestnet](/docs/packages/SDK/type-aliases/EthereumTestnet.md) -- [GnosisTestnet](/docs/packages/SDK/type-aliases/GnosisTestnet.md) -- [NewOrder](/docs/packages/SDK/type-aliases/NewOrder.md) -- [OpenArgs](/docs/packages/SDK/type-aliases/OpenArgs.md) -- [PKCERequest](/docs/packages/SDK/type-aliases/PKCERequest.md) -- [PKCERequestArgs](/docs/packages/SDK/type-aliases/PKCERequestArgs.md) -- [PolygonTestnet](/docs/packages/SDK/type-aliases/PolygonTestnet.md) -- [Representative](/docs/packages/SDK/type-aliases/Representative.md) -- [ResponseStatus](/docs/packages/SDK/type-aliases/ResponseStatus.md) -- [SubmitProfileDetailsPayload](/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md) -- [Ticker](/docs/packages/SDK/type-aliases/Ticker.md) -- [TokenSymbol](/docs/packages/SDK/type-aliases/TokenSymbol.md) +- [AuthArgs](/docs/packages/sdk/type-aliases/AuthArgs.md) +- [BearerTokenCredentials](/docs/packages/sdk/type-aliases/BearerTokenCredentials.md) +- [Beneficiary](/docs/packages/sdk/type-aliases/Beneficiary.md) +- [Chain](/docs/packages/sdk/type-aliases/Chain.md) +- [ChainId](/docs/packages/sdk/type-aliases/ChainId.md) +- [ClassOptions](/docs/packages/sdk/type-aliases/ClassOptions.md) +- [Config](/docs/packages/sdk/type-aliases/Config.md) +- [Director](/docs/packages/sdk/type-aliases/Director.md) +- [ENV](/docs/packages/sdk/type-aliases/ENV.md) +- [Environment](/docs/packages/sdk/type-aliases/Environment.md) +- [EthereumTestnet](/docs/packages/sdk/type-aliases/EthereumTestnet.md) +- [GnosisTestnet](/docs/packages/sdk/type-aliases/GnosisTestnet.md) +- [NewOrder](/docs/packages/sdk/type-aliases/NewOrder.md) +- [OpenArgs](/docs/packages/sdk/type-aliases/OpenArgs.md) +- [PKCERequest](/docs/packages/sdk/type-aliases/PKCERequest.md) +- [PKCERequestArgs](/docs/packages/sdk/type-aliases/PKCERequestArgs.md) +- [PolygonTestnet](/docs/packages/sdk/type-aliases/PolygonTestnet.md) +- [Representative](/docs/packages/sdk/type-aliases/Representative.md) +- [ResponseStatus](/docs/packages/sdk/type-aliases/ResponseStatus.md) +- [SubmitProfileDetailsPayload](/docs/packages/sdk/type-aliases/SubmitProfileDetailsPayload.md) +- [Ticker](/docs/packages/sdk/type-aliases/Ticker.md) +- [TokenSymbol](/docs/packages/sdk/type-aliases/TokenSymbol.md) ## Enumerations -- [AccountState](/docs/packages/SDK/enumerations/AccountState.md) -- [Currency](/docs/packages/SDK/enumerations/Currency.md) -- [IdDocumentKind](/docs/packages/SDK/enumerations/IdDocumentKind.md) -- [KYCOutcome](/docs/packages/SDK/enumerations/KYCOutcome.md) -- [KYCState](/docs/packages/SDK/enumerations/KYCState.md) -- [Method](/docs/packages/SDK/enumerations/Method.md) -- [OrderKind](/docs/packages/SDK/enumerations/OrderKind.md) -- [OrderState](/docs/packages/SDK/enumerations/OrderState.md) -- [PaymentStandard](/docs/packages/SDK/enumerations/PaymentStandard.md) -- [Permission](/docs/packages/SDK/enumerations/Permission.md) -- [ProfileState](/docs/packages/SDK/enumerations/ProfileState.md) -- [ProfileType](/docs/packages/SDK/enumerations/ProfileType.md) +- [AccountState](/docs/packages/sdk/enumerations/AccountState.md) +- [Currency](/docs/packages/sdk/enumerations/Currency.md) +- [IdDocumentKind](/docs/packages/sdk/enumerations/IdDocumentKind.md) +- [KYCOutcome](/docs/packages/sdk/enumerations/KYCOutcome.md) +- [KYCState](/docs/packages/sdk/enumerations/KYCState.md) +- [Method](/docs/packages/sdk/enumerations/Method.md) +- [OrderKind](/docs/packages/sdk/enumerations/OrderKind.md) +- [OrderState](/docs/packages/sdk/enumerations/OrderState.md) +- [PaymentStandard](/docs/packages/sdk/enumerations/PaymentStandard.md) +- [Permission](/docs/packages/sdk/enumerations/Permission.md) +- [ProfileState](/docs/packages/sdk/enumerations/ProfileState.md) +- [ProfileType](/docs/packages/sdk/enumerations/ProfileType.md) diff --git a/apps/developer/docs/packages/SDK/interfaces/Address.md b/apps/developer/docs/packages/SDK/interfaces/Address.md index 1a26b52d..435829d1 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Address.md +++ b/apps/developer/docs/packages/SDK/interfaces/Address.md @@ -2,34 +2,8 @@ ## Properties -### address - -> **address**: `string` - -The address - -#### Defined in - -[types.ts:284](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L284) - -*** - -### chains - -> **chains**: [`Chain`](/docs/packages/SDK/type-aliases/Chain.md)[] - -#### Defined in - -[types.ts:285](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L285) - -*** - -### profile - -> **profile**: `string` - -The id of the profile. - -#### Defined in - -[types.ts:281](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L281) +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `address` | `string` | The address | [types.ts:284](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L284) | +| `chains` | [`Chain`](/docs/packages/sdk/type-aliases/Chain.md)[] | - | [types.ts:285](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L285) | +| `profile` | `string` | The id of the profile. | [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 a8533b15..46583645 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Addresses.md +++ b/apps/developer/docs/packages/SDK/interfaces/Addresses.md @@ -2,10 +2,6 @@ ## Properties -### addresses - -> **addresses**: [`Address`](/docs/packages/SDK/interfaces/Address.md)[] - -#### Defined in - -[types.ts:289](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L289) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `addresses` | [`Address`](/docs/packages/sdk/interfaces/Address.md)[] | [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/AddressesQueryParams.md b/apps/developer/docs/packages/SDK/interfaces/AddressesQueryParams.md index 62142ed0..f31ad3e7 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AddressesQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/AddressesQueryParams.md @@ -2,24 +2,7 @@ ## Properties -### chain? - -> `optional` **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -Filter the list on the chain - -#### Defined in - -[types.ts:272](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L272) - -*** - -### profile? - -> `optional` **profile**: `string` - -Filter the list on profile ID - -#### Defined in - -[types.ts:270](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L270) +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `chain?` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | Filter the list on the chain | [types.ts:272](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L272) | +| `profile?` | `string` | Filter the list on profile ID | [types.ts:270](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L270) | diff --git a/apps/developer/docs/packages/SDK/interfaces/AuthCodePayload.md b/apps/developer/docs/packages/SDK/interfaces/AuthCodePayload.md index eb9cac22..f26f9fc7 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AuthCodePayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/AuthCodePayload.md @@ -1,55 +1,15 @@ # Interface: AuthCodePayload -One of the options for the [AuthArgs](/docs/packages/SDK/type-aliases/AuthArgs.md). +One of the options for the [AuthArgs](/docs/packages/sdk/type-aliases/AuthArgs.md). [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth). ## Properties -### client\_id - -> **client\_id**: `string` - -#### Defined in - -[types.ts:48](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L48) - -*** - -### code - -> **code**: `string` - -#### Defined in - -[types.ts:49](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L49) - -*** - -### code\_verifier - -> **code\_verifier**: `string` - -#### Defined in - -[types.ts:50](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L50) - -*** - -### grant\_type - -> **grant\_type**: `"authorization_code"` - -#### Defined in - -[types.ts:47](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L47) - -*** - -### redirect\_uri - -> **redirect\_uri**: `string` - -#### Defined in - -[types.ts:51](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L51) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `client_id` | `string` | [types.ts:48](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L48) | +| `code` | `string` | [types.ts:49](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L49) | +| `code_verifier` | `string` | [types.ts:50](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L50) | +| `grant_type` | `"authorization_code"` | [types.ts:47](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L47) | +| `redirect_uri` | `string` | [types.ts:51](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L51) | diff --git a/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md b/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md index 78401468..0042ed44 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md +++ b/apps/developer/docs/packages/SDK/interfaces/AuthFlowOptions.md @@ -2,70 +2,12 @@ ## Properties -### address? - -> `optional` **address**: `string` - -#### Defined in - -[types.ts:527](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L527) - -*** - -### chain? - -> `optional` **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:529](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L529) - -*** - -### clientId? - -> `optional` **clientId**: `string` - -#### Defined in - -[types.ts:525](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L525) - -*** - -### redirectUri? - -> `optional` **redirectUri**: `string` - -#### Defined in - -[types.ts:526](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L526) - -*** - -### signature? - -> `optional` **signature**: `string` - -#### Defined in - -[types.ts:528](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L528) - -*** - -### skipCreateAccount? - -> `optional` **skipCreateAccount**: `boolean` - -#### Defined in - -[types.ts:531](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L531) - -*** - -### state? - -> `optional` **state**: `string` - -#### Defined in - -[types.ts:530](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L530) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address?` | `string` | [types.ts:527](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L527) | +| `chain?` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [types.ts:529](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L529) | +| `clientId?` | `string` | [types.ts:525](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L525) | +| `redirectUri?` | `string` | [types.ts:526](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L526) | +| `signature?` | `string` | [types.ts:528](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L528) | +| `skipCreateAccount?` | `boolean` | [types.ts:531](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L531) | +| `state?` | `string` | [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 6fdc1497..d8602ce3 100644 --- a/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md +++ b/apps/developer/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md @@ -2,20 +2,7 @@ ## Properties -### clientId - -> **clientId**: `string` - -#### Defined in - -[types.ts:540](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L540) - -*** - -### redirectUri - -> **redirectUri**: `string` - -#### Defined in - -[types.ts:541](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L541) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `clientId` | `string` | [types.ts:540](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L540) | +| `redirectUri` | `string` | [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 2e4b76bd..9b7699ba 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Balances.md +++ b/apps/developer/docs/packages/SDK/interfaces/Balances.md @@ -2,40 +2,9 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:300](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L300) - -*** - -### balances - -> **balances**: [`CurrencyBalance`](/docs/packages/SDK/interfaces/CurrencyBalance.md)[] - -#### Defined in - -[types.ts:302](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L302) - -*** - -### chain - -> **chain**: [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:301](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L301) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[types.ts:299](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L299) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address` | `string` | [types.ts:300](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L300) | +| `balances` | [`CurrencyBalance`](/docs/packages/sdk/interfaces/CurrencyBalance.md)[] | [types.ts:302](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L302) | +| `chain` | [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [types.ts:301](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L301) | +| `id` | `string` | [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/BearerProfile.md b/apps/developer/docs/packages/SDK/interfaces/BearerProfile.md index c531a5e3..18ef4fef 100644 --- a/apps/developer/docs/packages/SDK/interfaces/BearerProfile.md +++ b/apps/developer/docs/packages/SDK/interfaces/BearerProfile.md @@ -2,60 +2,11 @@ ## Properties -### access\_token - -> **access\_token**: `string` - -#### Defined in - -[types.ts:75](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L75) - -*** - -### expires\_in - -> **expires\_in**: `number` - -#### Defined in - -[types.ts:77](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L77) - -*** - -### profile - -> **profile**: `string` - -#### Defined in - -[types.ts:79](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L79) - -*** - -### refresh\_token - -> **refresh\_token**: `string` - -#### Defined in - -[types.ts:78](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L78) - -*** - -### token\_type - -> **token\_type**: `string` - -#### Defined in - -[types.ts:76](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L76) - -*** - -### userId - -> **userId**: `string` - -#### Defined in - -[types.ts:80](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L80) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `access_token` | `string` | [types.ts:75](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L75) | +| `expires_in` | `number` | [types.ts:77](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L77) | +| `profile` | `string` | [types.ts:79](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L79) | +| `refresh_token` | `string` | [types.ts:78](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L78) | +| `token_type` | `string` | [types.ts:76](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L76) | +| `userId` | `string` | [types.ts:80](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L80) | diff --git a/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md b/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md index a73a2765..ae458014 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md +++ b/apps/developer/docs/packages/SDK/interfaces/ClientCredentials.md @@ -2,20 +2,7 @@ ## Properties -### clientId - -> **clientId**: `string` - -#### Defined in - -[types.ts:535](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L535) - -*** - -### clientSecret - -> **clientSecret**: `string` - -#### Defined in - -[types.ts:536](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L536) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `clientId` | `string` | [types.ts:535](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L535) | +| `clientSecret` | `string` | [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/ClientCredentialsPayload.md b/apps/developer/docs/packages/SDK/interfaces/ClientCredentialsPayload.md index a75d3e4f..f20603d1 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ClientCredentialsPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/ClientCredentialsPayload.md @@ -1,35 +1,13 @@ # Interface: ClientCredentialsPayload -One of the options for the [AuthArgs](/docs/packages/SDK/type-aliases/AuthArgs.md). +One of the options for the [AuthArgs](/docs/packages/sdk/type-aliases/AuthArgs.md). [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth). ## Properties -### client\_id - -> **client\_id**: `string` - -#### Defined in - -[types.ts:70](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L70) - -*** - -### client\_secret - -> **client\_secret**: `string` - -#### Defined in - -[types.ts:71](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L71) - -*** - -### grant\_type - -> **grant\_type**: `"client_credentials"` - -#### Defined in - -[types.ts:69](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L69) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `client_id` | `string` | [types.ts:70](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L70) | +| `client_secret` | `string` | [types.ts:71](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L71) | +| `grant_type` | `"client_credentials"` | [types.ts:69](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L69) | diff --git a/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetails.md b/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetails.md index 2b45ebc0..d5e41e32 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetails.md +++ b/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetails.md @@ -2,106 +2,15 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:247](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L247) - -*** - -### city - -> **city**: `string` - -#### Defined in - -[types.ts:249](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L249) - -*** - -### country - -> **country**: `string` - -#### Defined in - -[types.ts:250](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L250) - -*** - -### countryState - -> **countryState**: `string` - -#### Defined in - -[types.ts:251](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L251) - -*** - -### directors - -> **directors**: [`Director`](/docs/packages/SDK/type-aliases/Director.md)[] - -List of Individual who has powers to legally bind the company (power of procuration). - -#### Defined in - -[types.ts:257](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L257) - -*** - -### finalBeneficiaries - -> **finalBeneficiaries**: [`Beneficiary`](/docs/packages/SDK/type-aliases/Beneficiary.md)[] - -List of beneficial owner that owns 25% or more in a corporation. - -#### Defined in - -[types.ts:255](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L255) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[types.ts:245](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L245) - -*** - -### postalCode - -> **postalCode**: `string` - -#### Defined in - -[types.ts:248](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L248) - -*** - -### registrationNumber - -> **registrationNumber**: `string` - -#### Defined in - -[types.ts:246](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L246) - -*** - -### representatives - -> **representatives**: [`PersonalProfileDetails`](/docs/packages/SDK/interfaces/PersonalProfileDetails.md)[] - -List of individuals representing the company and authorized to act on it's behalf. - -#### Defined in - -[types.ts:253](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L253) +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `address` | `string` | - | [types.ts:247](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L247) | +| `city` | `string` | - | [types.ts:249](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L249) | +| `country` | `string` | - | [types.ts:250](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L250) | +| `countryState` | `string` | - | [types.ts:251](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L251) | +| `directors` | [`Director`](/docs/packages/sdk/type-aliases/Director.md)[] | List of Individual who has powers to legally bind the company (power of procuration). | [types.ts:257](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L257) | +| `finalBeneficiaries` | [`Beneficiary`](/docs/packages/sdk/type-aliases/Beneficiary.md)[] | List of beneficial owner that owns 25% or more in a corporation. | [types.ts:255](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L255) | +| `name` | `string` | - | [types.ts:245](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L245) | +| `postalCode` | `string` | - | [types.ts:248](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L248) | +| `registrationNumber` | `string` | - | [types.ts:246](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L246) | +| `representatives` | [`PersonalProfileDetails`](/docs/packages/sdk/interfaces/PersonalProfileDetails.md)[] | List of individuals representing the company and authorized to act on it's behalf. | [types.ts:253](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L253) | diff --git a/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md b/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md index 3c53802e..ca37c344 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md +++ b/apps/developer/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md @@ -2,10 +2,6 @@ ## Properties -### corporate - -> **corporate**: [`CorporateProfileDetails`](/docs/packages/SDK/interfaces/CorporateProfileDetails.md) - -#### Defined in - -[types.ts:260](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L260) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `corporate` | [`CorporateProfileDetails`](/docs/packages/sdk/interfaces/CorporateProfileDetails.md) | [types.ts:260](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L260) | diff --git a/apps/developer/docs/packages/SDK/interfaces/Corporation.md b/apps/developer/docs/packages/SDK/interfaces/Corporation.md index d91ac3c6..63fefd9a 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Corporation.md +++ b/apps/developer/docs/packages/SDK/interfaces/Corporation.md @@ -2,20 +2,7 @@ ## Properties -### companyName - -> **companyName**: `string` - -#### Defined in - -[types.ts:351](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L351) - -*** - -### country - -> **country**: `string` - -#### Defined in - -[types.ts:352](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L352) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `companyName` | `string` | [types.ts:351](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L351) | +| `country` | `string` | [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 2f897dfa..efed8704 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Counterpart.md +++ b/apps/developer/docs/packages/SDK/interfaces/Counterpart.md @@ -2,20 +2,7 @@ ## Properties -### details - -> **details**: [`Individual`](/docs/packages/SDK/interfaces/Individual.md) \| [`Corporation`](/docs/packages/SDK/interfaces/Corporation.md) - -#### Defined in - -[types.ts:357](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L357) - -*** - -### identifier - -> **identifier**: [`IBANIdentifier`](/docs/packages/SDK/interfaces/IBANIdentifier.md) \| [`CrossChainIdentifier`](/docs/packages/SDK/interfaces/CrossChainIdentifier.md) \| [`SCANIdentifier`](/docs/packages/SDK/interfaces/SCANIdentifier.md) - -#### Defined in - -[types.ts:356](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L356) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `details` | [`Individual`](/docs/packages/sdk/interfaces/Individual.md) \| [`Corporation`](/docs/packages/sdk/interfaces/Corporation.md) | [types.ts:357](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L357) | +| `identifier` | [`IBANIdentifier`](/docs/packages/sdk/interfaces/IBANIdentifier.md) \| [`CrossChainIdentifier`](/docs/packages/sdk/interfaces/CrossChainIdentifier.md) \| [`SCANIdentifier`](/docs/packages/sdk/interfaces/SCANIdentifier.md) | [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 e1e23d01..8b955c1f 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/CrossChainIdentifier.md @@ -2,56 +2,13 @@ ## Extends -- [`Identifier`](/docs/packages/SDK/interfaces/Identifier.md) +- [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md) ## Properties -### address - -> **address**: `string` - -The receivers address - -#### Defined in - -[types.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L333) - -*** - -### bic? - -> `optional` **bic**: `string` - -#### Inherited from - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`bic`](/docs/packages/SDK/interfaces/Identifier.md#bic) - -#### Defined in - -[types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) - -*** - -### chain - -> **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -The receivers network - -#### Defined in - -[types.ts:335](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L335) - -*** - -### standard - -> **standard**: [`chain`](/docs/packages/SDK/enumerations/PaymentStandard.md#chain) - -#### Overrides - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`standard`](/docs/packages/SDK/interfaces/Identifier.md#standard) - -#### Defined in - -[types.ts:331](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L331) +| Property | Type | Description | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `address` | `string` | The receivers address | - | - | [types.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L333) | +| `bic?` | `string` | - | - | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`bic` | [types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) | +| `chain` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | The receivers network | - | - | [types.ts:335](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L335) | +| `standard` | `chain` | - | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`standard` | - | [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 e688cd2c..f9739a0e 100644 --- a/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md +++ b/apps/developer/docs/packages/SDK/interfaces/CurrencyBalance.md @@ -2,20 +2,7 @@ ## Properties -### amount - -> **amount**: `string` - -#### Defined in - -[types.ts:295](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L295) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Defined in - -[types.ts:294](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L294) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `amount` | `string` | [types.ts:295](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L295) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | [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 2ce810a5..81138d12 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Fee.md +++ b/apps/developer/docs/packages/SDK/interfaces/Fee.md @@ -2,30 +2,8 @@ ## Properties -### amount - -> **amount**: `string` - -#### Defined in - -[types.ts:322](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L322) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Defined in - -[types.ts:321](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L321) - -*** - -### provider - -> **provider**: `"satchel"` - -#### Defined in - -[types.ts:320](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L320) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `amount` | `string` | [types.ts:322](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L322) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | [types.ts:321](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L321) | +| `provider` | `"satchel"` | [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 59042baf..50cc6783 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBAN.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBAN.md @@ -2,50 +2,10 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:500](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L500) - -*** - -### bic - -> **bic**: `string` - -#### Defined in - -[types.ts:498](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L498) - -*** - -### chain - -> **chain**: [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:501](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L501) - -*** - -### iban - -> **iban**: `string` - -#### Defined in - -[types.ts:497](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L497) - -*** - -### profile - -> **profile**: `string` - -#### Defined in - -[types.ts:499](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L499) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address` | `string` | [types.ts:500](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L500) | +| `bic` | `string` | [types.ts:498](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L498) | +| `chain` | [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [types.ts:501](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L501) | +| `iban` | `string` | [types.ts:497](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L497) | +| `profile` | `string` | [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 c96e2a02..cd502f7a 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBANIdentifier.md @@ -2,42 +2,12 @@ ## Extends -- [`Identifier`](/docs/packages/SDK/interfaces/Identifier.md) +- [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md) ## Properties -### bic? - -> `optional` **bic**: `string` - -#### Inherited from - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`bic`](/docs/packages/SDK/interfaces/Identifier.md#bic) - -#### Defined in - -[types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) - -*** - -### iban - -> **iban**: `string` - -#### Defined in - -[types.ts:327](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L327) - -*** - -### standard - -> **standard**: [`iban`](/docs/packages/SDK/enumerations/PaymentStandard.md#iban) - -#### Overrides - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`standard`](/docs/packages/SDK/interfaces/Identifier.md#standard) - -#### Defined in - -[types.ts:326](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L326) +| Property | Type | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `bic?` | `string` | - | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`bic` | [types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) | +| `iban` | `string` | - | - | [types.ts:327](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L327) | +| `standard` | `iban` | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`standard` | - | [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 e4b4cc74..8b3500c4 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md +++ b/apps/developer/docs/packages/SDK/interfaces/IBANsResponse.md @@ -2,10 +2,6 @@ ## Properties -### ibans - -> **ibans**: [`IBAN`](/docs/packages/SDK/interfaces/IBAN.md)[] - -#### Defined in - -[types.ts:505](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L505) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `ibans` | [`IBAN`](/docs/packages/sdk/interfaces/IBAN.md)[] | [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 fc53f464..c8ed7b1d 100644 --- a/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/IbansQueryParams.md @@ -2,20 +2,7 @@ ## Properties -### chain? - -> `optional` **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:493](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L493) - -*** - -### profile? - -> `optional` **profile**: `string` - -#### Defined in - -[types.ts:492](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L492) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `chain?` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [types.ts:493](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L493) | +| `profile?` | `string` | [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/Identifier.md b/apps/developer/docs/packages/SDK/interfaces/Identifier.md index 0871a3af..29a82ea5 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Identifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/Identifier.md @@ -2,26 +2,13 @@ ## Extended by -- [`IBANIdentifier`](/docs/packages/SDK/interfaces/IBANIdentifier.md) -- [`CrossChainIdentifier`](/docs/packages/SDK/interfaces/CrossChainIdentifier.md) -- [`SCANIdentifier`](/docs/packages/SDK/interfaces/SCANIdentifier.md) +- [`IBANIdentifier`](/docs/packages/sdk/interfaces/IBANIdentifier.md) +- [`CrossChainIdentifier`](/docs/packages/sdk/interfaces/CrossChainIdentifier.md) +- [`SCANIdentifier`](/docs/packages/sdk/interfaces/SCANIdentifier.md) ## Properties -### bic? - -> `optional` **bic**: `string` - -#### Defined in - -[types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) - -*** - -### standard - -> **standard**: [`PaymentStandard`](/docs/packages/SDK/enumerations/PaymentStandard.md) - -#### Defined in - -[types.ts:191](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L191) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `bic?` | `string` | [types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) | +| `standard` | [`PaymentStandard`](/docs/packages/sdk/enumerations/PaymentStandard.md) | [types.ts:191](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L191) | diff --git a/apps/developer/docs/packages/SDK/interfaces/Individual.md b/apps/developer/docs/packages/SDK/interfaces/Individual.md index 2b1bd2bc..5d5fcb4f 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Individual.md +++ b/apps/developer/docs/packages/SDK/interfaces/Individual.md @@ -2,30 +2,8 @@ ## Properties -### country? - -> `optional` **country**: `string` - -#### Defined in - -[types.ts:347](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L347) - -*** - -### firstName - -> **firstName**: `string` - -#### Defined in - -[types.ts:345](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L345) - -*** - -### lastName - -> **lastName**: `string` - -#### Defined in - -[types.ts:346](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L346) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `country?` | `string` | [types.ts:347](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L347) | +| `firstName` | `string` | [types.ts:345](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L345) | +| `lastName` | `string` | [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/KYC.md b/apps/developer/docs/packages/SDK/interfaces/KYC.md index 6d44c72f..1d8c99af 100644 --- a/apps/developer/docs/packages/SDK/interfaces/KYC.md +++ b/apps/developer/docs/packages/SDK/interfaces/KYC.md @@ -2,20 +2,7 @@ ## Properties -### outcome - -> **outcome**: [`KYCOutcome`](/docs/packages/SDK/enumerations/KYCOutcome.md) - -#### Defined in - -[types.ts:172](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L172) - -*** - -### state - -> **state**: [`KYCState`](/docs/packages/SDK/enumerations/KYCState.md) - -#### Defined in - -[types.ts:171](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L171) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `outcome` | [`KYCOutcome`](/docs/packages/sdk/enumerations/KYCOutcome.md) | [types.ts:172](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L172) | +| `state` | [`KYCState`](/docs/packages/sdk/enumerations/KYCState.md) | [types.ts:171](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L171) | diff --git a/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md b/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md index 35a7136d..67cdf50e 100644 --- a/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md +++ b/apps/developer/docs/packages/SDK/interfaces/LinkAddress.md @@ -2,62 +2,10 @@ ## Properties -### address - -> **address**: `string` - -The public key of the blockchain account. - -#### Defined in - -[types.ts:467](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L467) - -*** - -### chain - -> **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L480) - -*** - -### message - -> **message**: `string` - -Fixed message to be signed with the private key corresponding to the given address. - -`I hereby declare that I am the address owner.` - -#### Defined in - -[types.ts:473](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L473) - -*** - -### profile? - -> `optional` **profile**: `string` - -Profile ID that owns the address. - -#### Defined in - -[types.ts:465](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L465) - -*** - -### signature - -> **signature**: `string` - -The signature hash of signing the `message` with the private key associated with the given address. -For signing on-chain with ERC1271 contracts, use `0x`, visit the documentation for further details. -https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address - -#### Defined in - -[types.ts:479](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L479) +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `address` | `string` | The public key of the blockchain account. | [types.ts:467](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L467) | +| `chain` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | - | [types.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L480) | +| `message` | `string` | Fixed message to be signed with the private key corresponding to the given address. `I hereby declare that I am the address owner.` | [types.ts:473](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L473) | +| `profile?` | `string` | Profile ID that owns the address. | [types.ts:465](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L465) | +| `signature` | `string` | The signature hash of signing the `message` with the private key associated with the given address. For signing on-chain with ERC1271 contracts, use `0x`, visit the documentation for further details. https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address | [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 8720b97d..01021bcd 100644 --- a/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/MoveIbanPayload.md @@ -2,20 +2,7 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:509](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L509) - -*** - -### chain - -> **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L510) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address` | `string` | [types.ts:509](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L509) | +| `chain` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [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 1011a62b..37fe9ad9 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAccountId.md @@ -2,112 +2,17 @@ ## Extends -- [`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md) +- [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md) ## Properties -### accountId - -> **accountId**: `string` - -#### Defined in - -[types.ts:431](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L431) - -*** - -### amount - -> **amount**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`amount`](/docs/packages/SDK/interfaces/NewOrderCommon.md#amount) - -#### Defined in - -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) - -*** - -### counterpart - -> **counterpart**: [`Counterpart`](/docs/packages/SDK/interfaces/Counterpart.md) - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`counterpart`](/docs/packages/SDK/interfaces/NewOrderCommon.md#counterpart) - -#### Defined in - -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`currency`](/docs/packages/SDK/interfaces/NewOrderCommon.md#currency) - -#### Defined in - -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) - -*** - -### memo? - -> `optional` **memo**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`memo`](/docs/packages/SDK/interfaces/NewOrderCommon.md#memo) - -#### Defined in - -[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) - -*** - -### message - -> **message**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`message`](/docs/packages/SDK/interfaces/NewOrderCommon.md#message) - -#### Defined in - -[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) - -*** - -### signature - -> **signature**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`signature`](/docs/packages/SDK/interfaces/NewOrderCommon.md#signature) - -#### Defined in - -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) - -*** - -### supportingDocumentId? - -> `optional` **supportingDocumentId**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`supportingDocumentId`](/docs/packages/SDK/interfaces/NewOrderCommon.md#supportingdocumentid) - -#### Defined in - -[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) +| Property | Type | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | +| `accountId` | `string` | - | [types.ts:431](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L431) | +| `amount` | `string` | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`amount` | [types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) | +| `counterpart` | [`Counterpart`](/docs/packages/sdk/interfaces/Counterpart.md) | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`counterpart` | [types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`currency` | [types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) | +| `memo?` | `string` | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`memo` | [types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) | +| `message` | `string` | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`message` | [types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) | +| `signature` | `string` | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`signature` | [types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) | +| `supportingDocumentId?` | `string` | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`supportingDocumentId` | [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 83bd3fe8..50caeb73 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderByAddress.md @@ -2,124 +2,18 @@ ## Extends -- [`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md) +- [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md) ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:426](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L426) - -*** - -### amount - -> **amount**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`amount`](/docs/packages/SDK/interfaces/NewOrderCommon.md#amount) - -#### Defined in - -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) - -*** - -### chain - -> **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -The senders network - -#### Defined in - -[types.ts:428](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L428) - -*** - -### counterpart - -> **counterpart**: [`Counterpart`](/docs/packages/SDK/interfaces/Counterpart.md) - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`counterpart`](/docs/packages/SDK/interfaces/NewOrderCommon.md#counterpart) - -#### Defined in - -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`currency`](/docs/packages/SDK/interfaces/NewOrderCommon.md#currency) - -#### Defined in - -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) - -*** - -### memo? - -> `optional` **memo**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`memo`](/docs/packages/SDK/interfaces/NewOrderCommon.md#memo) - -#### Defined in - -[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) - -*** - -### message - -> **message**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`message`](/docs/packages/SDK/interfaces/NewOrderCommon.md#message) - -#### Defined in - -[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) - -*** - -### signature - -> **signature**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`signature`](/docs/packages/SDK/interfaces/NewOrderCommon.md#signature) - -#### Defined in - -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) - -*** - -### supportingDocumentId? - -> `optional` **supportingDocumentId**: `string` - -#### Inherited from - -[`NewOrderCommon`](/docs/packages/SDK/interfaces/NewOrderCommon.md).[`supportingDocumentId`](/docs/packages/SDK/interfaces/NewOrderCommon.md#supportingdocumentid) - -#### Defined in - -[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) +| Property | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `address` | `string` | - | - | [types.ts:426](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L426) | +| `amount` | `string` | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`amount` | [types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) | +| `chain` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | The senders network | - | [types.ts:428](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L428) | +| `counterpart` | [`Counterpart`](/docs/packages/sdk/interfaces/Counterpart.md) | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`counterpart` | [types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`currency` | [types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) | +| `memo?` | `string` | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`memo` | [types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) | +| `message` | `string` | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`message` | [types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) | +| `signature` | `string` | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`signature` | [types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) | +| `supportingDocumentId?` | `string` | - | [`NewOrderCommon`](/docs/packages/sdk/interfaces/NewOrderCommon.md).`supportingDocumentId` | [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 1c3f2dde..e994ece5 100644 --- a/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md +++ b/apps/developer/docs/packages/SDK/interfaces/NewOrderCommon.md @@ -2,75 +2,17 @@ ## Extended by -- [`NewOrderByAddress`](/docs/packages/SDK/interfaces/NewOrderByAddress.md) -- [`NewOrderByAccountId`](/docs/packages/SDK/interfaces/NewOrderByAccountId.md) +- [`NewOrderByAddress`](/docs/packages/sdk/interfaces/NewOrderByAddress.md) +- [`NewOrderByAccountId`](/docs/packages/sdk/interfaces/NewOrderByAccountId.md) ## Properties -### amount - -> **amount**: `string` - -#### Defined in - -[types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) - -*** - -### counterpart - -> **counterpart**: [`Counterpart`](/docs/packages/SDK/interfaces/Counterpart.md) - -#### Defined in - -[types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Defined in - -[types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) - -*** - -### memo? - -> `optional` **memo**: `string` - -#### Defined in - -[types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) - -*** - -### message - -> **message**: `string` - -#### Defined in - -[types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) - -*** - -### signature - -> **signature**: `string` - -#### Defined in - -[types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) - -*** - -### supportingDocumentId? - -> `optional` **supportingDocumentId**: `string` - -#### Defined in - -[types.ts:423](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L423) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `amount` | `string` | [types.ts:417](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L417) | +| `counterpart` | [`Counterpart`](/docs/packages/sdk/interfaces/Counterpart.md) | [types.ts:420](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L420) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | [types.ts:419](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L419) | +| `memo?` | `string` | [types.ts:422](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L422) | +| `message` | `string` | [types.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L421) | +| `signature` | `string` | [types.ts:418](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L418) | +| `supportingDocumentId?` | `string` | [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 c736e896..26469b4c 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Order.md +++ b/apps/developer/docs/packages/SDK/interfaces/Order.md @@ -2,140 +2,19 @@ ## Properties -### accountId - -> **accountId**: `string` - -#### Defined in - -[types.ts:383](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L383) - -*** - -### address - -> **address**: `string` - -#### Defined in - -[types.ts:384](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L384) - -*** - -### amount - -> **amount**: `string` - -#### Defined in - -[types.ts:386](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L386) - -*** - -### counterpart - -> **counterpart**: [`Counterpart`](/docs/packages/SDK/interfaces/Counterpart.md) - -#### Defined in - -[types.ts:390](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L390) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Defined in - -[types.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L387) - -*** - -### fees - -> **fees**: [`Fee`](/docs/packages/SDK/interfaces/Fee.md)[] - -#### Defined in - -[types.ts:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L389) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[types.ts:381](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L381) - -*** - -### kind - -> **kind**: [`OrderKind`](/docs/packages/SDK/enumerations/OrderKind.md) - -#### Defined in - -[types.ts:385](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L385) - -*** - -### memo - -> **memo**: `string` - -#### Defined in - -[types.ts:391](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L391) - -*** - -### meta - -> **meta**: [`OrderMetadata`](/docs/packages/SDK/interfaces/OrderMetadata.md) - -#### Defined in - -[types.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L394) - -*** - -### profile - -> **profile**: `string` - -#### Defined in - -[types.ts:382](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L382) - -*** - -### rejectedReason - -> **rejectedReason**: `string` - -#### Defined in - -[types.ts:392](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L392) - -*** - -### supportingDocumentId - -> **supportingDocumentId**: `string` - -#### Defined in - -[types.ts:393](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L393) - -*** - -### totalFee - -> **totalFee**: `string` - -#### Defined in - -[types.ts:388](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L388) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `accountId` | `string` | [types.ts:383](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L383) | +| `address` | `string` | [types.ts:384](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L384) | +| `amount` | `string` | [types.ts:386](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L386) | +| `counterpart` | [`Counterpart`](/docs/packages/sdk/interfaces/Counterpart.md) | [types.ts:390](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L390) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | [types.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L387) | +| `fees` | [`Fee`](/docs/packages/sdk/interfaces/Fee.md)[] | [types.ts:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L389) | +| `id` | `string` | [types.ts:381](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L381) | +| `kind` | [`OrderKind`](/docs/packages/sdk/enumerations/OrderKind.md) | [types.ts:385](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L385) | +| `memo` | `string` | [types.ts:391](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L391) | +| `meta` | [`OrderMetadata`](/docs/packages/sdk/interfaces/OrderMetadata.md) | [types.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L394) | +| `profile` | `string` | [types.ts:382](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L382) | +| `rejectedReason` | `string` | [types.ts:392](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L392) | +| `supportingDocumentId` | `string` | [types.ts:393](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L393) | +| `totalFee` | `string` | [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 b3be5836..60c57dd9 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderFilter.md @@ -2,60 +2,11 @@ ## Properties -### accountId? - -> `optional` **accountId**: `string` - -#### Defined in - -[types.ts:376](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L376) - -*** - -### address? - -> `optional` **address**: `string` - -#### Defined in - -[types.ts:372](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L372) - -*** - -### memo? - -> `optional` **memo**: `string` - -#### Defined in - -[types.ts:375](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L375) - -*** - -### profile? - -> `optional` **profile**: `string` - -#### Defined in - -[types.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L374) - -*** - -### state? - -> `optional` **state**: [`OrderState`](/docs/packages/SDK/enumerations/OrderState.md) - -#### Defined in - -[types.ts:377](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L377) - -*** - -### txHash? - -> `optional` **txHash**: `string` - -#### Defined in - -[types.ts:373](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L373) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `accountId?` | `string` | [types.ts:376](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L376) | +| `address?` | `string` | [types.ts:372](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L372) | +| `memo?` | `string` | [types.ts:375](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L375) | +| `profile?` | `string` | [types.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L374) | +| `state?` | [`OrderState`](/docs/packages/sdk/enumerations/OrderState.md) | [types.ts:377](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L377) | +| `txHash?` | `string` | [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 88ac763f..2790a0ca 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderMetadata.md @@ -2,80 +2,13 @@ ## Properties -### approvedAt - -> **approvedAt**: `string` - -#### Defined in - -[types.ts:361](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L361) - -*** - -### placedAt - -> **placedAt**: `string` - -#### Defined in - -[types.ts:366](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L366) - -*** - -### placedBy - -> **placedBy**: `string` - -#### Defined in - -[types.ts:365](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L365) - -*** - -### processedAt - -> **processedAt**: `string` - -#### Defined in - -[types.ts:362](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L362) - -*** - -### receivedAmount - -> **receivedAmount**: `string` - -#### Defined in - -[types.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L367) - -*** - -### rejectedAt - -> **rejectedAt**: `string` - -#### Defined in - -[types.ts:363](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L363) - -*** - -### sentAmount - -> **sentAmount**: `string` - -#### Defined in - -[types.ts:368](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L368) - -*** - -### state - -> **state**: [`OrderState`](/docs/packages/SDK/enumerations/OrderState.md) - -#### Defined in - -[types.ts:364](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L364) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `approvedAt` | `string` | [types.ts:361](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L361) | +| `placedAt` | `string` | [types.ts:366](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L366) | +| `placedBy` | `string` | [types.ts:365](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L365) | +| `processedAt` | `string` | [types.ts:362](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L362) | +| `receivedAmount` | `string` | [types.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L367) | +| `rejectedAt` | `string` | [types.ts:363](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L363) | +| `sentAmount` | `string` | [types.ts:368](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L368) | +| `state` | [`OrderState`](/docs/packages/sdk/enumerations/OrderState.md) | [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 71f8a9ae..4a08a452 100644 --- a/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/OrderNotificationQueryParams.md @@ -2,20 +2,7 @@ ## Properties -### profile? - -> `optional` **profile**: `string` - -#### Defined in - -[types.ts:517](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L517) - -*** - -### state? - -> `optional` **state**: [`OrderState`](/docs/packages/SDK/enumerations/OrderState.md) - -#### Defined in - -[types.ts:516](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L516) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `profile?` | `string` | [types.ts:517](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L517) | +| `state?` | [`OrderState`](/docs/packages/sdk/enumerations/OrderState.md) | [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/PersonalProfileDetails.md b/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetails.md index 3666347f..2c03f4bb 100644 --- a/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetails.md +++ b/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetails.md @@ -2,108 +2,17 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:224](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L224) - -*** - -### birthday - -> **birthday**: `string` - -#### Defined in - -[types.ts:230](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L230) - -*** - -### city - -> **city**: `string` - -#### Defined in - -[types.ts:226](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L226) - -*** - -### country - -> **country**: `string` - -#### Defined in - -[types.ts:227](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L227) - -*** - -### countryState? - -> `optional` **countryState**: `string` - -#### Defined in - -[types.ts:228](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L228) - -*** - -### firstName - -> **firstName**: `string` - -#### Defined in - -[types.ts:222](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L222) - -*** - -### idDocument - -> **idDocument**: `object` - -#### kind - -> **kind**: [`IdDocumentKind`](/docs/packages/SDK/enumerations/IdDocumentKind.md) - -#### number - -> **number**: `string` - -#### Defined in - -[types.ts:218](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L218) - -*** - -### lastName - -> **lastName**: `string` - -#### Defined in - -[types.ts:223](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L223) - -*** - -### nationality - -> **nationality**: `string` - -#### Defined in - -[types.ts:229](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L229) - -*** - -### postalCode - -> **postalCode**: `string` - -#### Defined in - -[types.ts:225](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L225) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address` | `string` | [types.ts:224](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L224) | +| `birthday` | `string` | [types.ts:230](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L230) | +| `city` | `string` | [types.ts:226](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L226) | +| `country` | `string` | [types.ts:227](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L227) | +| `countryState?` | `string` | [types.ts:228](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L228) | +| `firstName` | `string` | [types.ts:222](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L222) | +| `idDocument` | \{`kind`: [`IdDocumentKind`](/docs/packages/sdk/enumerations/IdDocumentKind.md);`number`: `string`; \} | [types.ts:218](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L218) | +| `idDocument.kind` | [`IdDocumentKind`](/docs/packages/sdk/enumerations/IdDocumentKind.md) | [types.ts:220](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L220) | +| `idDocument.number` | `string` | [types.ts:219](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L219) | +| `lastName` | `string` | [types.ts:223](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L223) | +| `nationality` | `string` | [types.ts:229](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L229) | +| `postalCode` | `string` | [types.ts:225](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L225) | diff --git a/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md b/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md index 10c5e322..e24aa89e 100644 --- a/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md +++ b/apps/developer/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md @@ -2,10 +2,6 @@ ## Properties -### personal - -> **personal**: [`PersonalProfileDetails`](/docs/packages/SDK/interfaces/PersonalProfileDetails.md) - -#### Defined in - -[types.ts:234](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L234) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `personal` | [`PersonalProfileDetails`](/docs/packages/sdk/interfaces/PersonalProfileDetails.md) | [types.ts:234](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L234) | diff --git a/apps/developer/docs/packages/SDK/interfaces/Profile.md b/apps/developer/docs/packages/SDK/interfaces/Profile.md index c6241990..23ec5e4c 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Profile.md +++ b/apps/developer/docs/packages/SDK/interfaces/Profile.md @@ -2,50 +2,10 @@ ## Properties -### id - -> **id**: `string` - -#### Defined in - -[types.ts:205](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L205) - -*** - -### kind - -> **kind**: [`ProfileType`](/docs/packages/SDK/enumerations/ProfileType.md) - -#### Defined in - -[types.ts:207](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L207) - -*** - -### kyc - -> **kyc**: [`KYC`](/docs/packages/SDK/interfaces/KYC.md) - -#### Defined in - -[types.ts:209](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L209) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[types.ts:206](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L206) - -*** - -### state - -> **state**: [`ProfileState`](/docs/packages/SDK/enumerations/ProfileState.md) - -#### Defined in - -[types.ts:208](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L208) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `id` | `string` | [types.ts:205](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L205) | +| `kind` | [`ProfileType`](/docs/packages/sdk/enumerations/ProfileType.md) | [types.ts:207](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L207) | +| `kyc` | [`KYC`](/docs/packages/sdk/interfaces/KYC.md) | [types.ts:209](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L209) | +| `name` | `string` | [types.ts:206](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L206) | +| `state` | [`ProfileState`](/docs/packages/sdk/enumerations/ProfileState.md) | [types.ts:208](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L208) | diff --git a/apps/developer/docs/packages/SDK/interfaces/ProfilePermissions.md b/apps/developer/docs/packages/SDK/interfaces/ProfilePermissions.md index b7b09e05..66e8fd1c 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ProfilePermissions.md +++ b/apps/developer/docs/packages/SDK/interfaces/ProfilePermissions.md @@ -2,40 +2,9 @@ ## Properties -### id - -> **id**: `string` - -#### Defined in - -[types.ts:196](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L196) - -*** - -### kind - -> **kind**: [`ProfileType`](/docs/packages/SDK/enumerations/ProfileType.md) - -#### Defined in - -[types.ts:197](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L197) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[types.ts:198](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L198) - -*** - -### perms - -> **perms**: [`Permission`](/docs/packages/SDK/enumerations/Permission.md)[] - -#### Defined in - -[types.ts:199](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L199) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `id` | `string` | [types.ts:196](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L196) | +| `kind` | [`ProfileType`](/docs/packages/sdk/enumerations/ProfileType.md) | [types.ts:197](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L197) | +| `name` | `string` | [types.ts:198](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L198) | +| `perms` | [`Permission`](/docs/packages/sdk/enumerations/Permission.md)[] | [types.ts:199](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L199) | diff --git a/apps/developer/docs/packages/SDK/interfaces/ProfilesQueryParams.md b/apps/developer/docs/packages/SDK/interfaces/ProfilesQueryParams.md index 1016afbc..5d7e0613 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ProfilesQueryParams.md +++ b/apps/developer/docs/packages/SDK/interfaces/ProfilesQueryParams.md @@ -2,20 +2,7 @@ ## Properties -### kind? - -> `optional` **kind**: [`ProfileType`](/docs/packages/SDK/enumerations/ProfileType.md) - -#### Defined in - -[types.ts:214](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L214) - -*** - -### state? - -> `optional` **state**: [`ProfileState`](/docs/packages/SDK/enumerations/ProfileState.md) - -#### Defined in - -[types.ts:213](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L213) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `kind?` | [`ProfileType`](/docs/packages/sdk/enumerations/ProfileType.md) | [types.ts:214](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L214) | +| `state?` | [`ProfileState`](/docs/packages/sdk/enumerations/ProfileState.md) | [types.ts:213](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L213) | diff --git a/apps/developer/docs/packages/SDK/interfaces/ProfilesResponse.md b/apps/developer/docs/packages/SDK/interfaces/ProfilesResponse.md index ce386c6f..b745b833 100644 --- a/apps/developer/docs/packages/SDK/interfaces/ProfilesResponse.md +++ b/apps/developer/docs/packages/SDK/interfaces/ProfilesResponse.md @@ -2,10 +2,6 @@ ## Properties -### profiles - -> **profiles**: [`ProfilePermissions`](/docs/packages/SDK/interfaces/ProfilePermissions.md)[] - -#### Defined in - -[types.ts:202](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L202) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `profiles` | [`ProfilePermissions`](/docs/packages/sdk/interfaces/ProfilePermissions.md)[] | [types.ts:202](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L202) | diff --git a/apps/developer/docs/packages/SDK/interfaces/RefreshTokenPayload.md b/apps/developer/docs/packages/SDK/interfaces/RefreshTokenPayload.md index ebfde326..160c6255 100644 --- a/apps/developer/docs/packages/SDK/interfaces/RefreshTokenPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/RefreshTokenPayload.md @@ -1,35 +1,13 @@ # Interface: RefreshTokenPayload -One of the options for the [AuthArgs](/docs/packages/SDK/type-aliases/AuthArgs.md). +One of the options for the [AuthArgs](/docs/packages/sdk/type-aliases/AuthArgs.md). [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth). ## Properties -### client\_id - -> **client\_id**: `string` - -#### Defined in - -[types.ts:60](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L60) - -*** - -### grant\_type - -> **grant\_type**: `"refresh_token"` - -#### Defined in - -[types.ts:59](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L59) - -*** - -### refresh\_token - -> **refresh\_token**: `string` - -#### Defined in - -[types.ts:61](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L61) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `client_id` | `string` | [types.ts:60](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L60) | +| `grant_type` | `"refresh_token"` | [types.ts:59](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L59) | +| `refresh_token` | `string` | [types.ts:61](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L61) | diff --git a/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md b/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md index 7eaa9968..a00b154b 100644 --- a/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/RequestIbanPayload.md @@ -2,30 +2,8 @@ ## Properties -### address - -> **address**: `string` - -#### Defined in - -[types.ts:486](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L486) - -*** - -### chain - -> **chain**: `number` \| [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:487](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L487) - -*** - -### emailNotifications - -> **emailNotifications**: `boolean` - -#### Defined in - -[types.ts:488](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L488) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `address` | `string` | [types.ts:486](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L486) | +| `chain` | `number` \| [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | [types.ts:487](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L487) | +| `emailNotifications` | `boolean` | [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 49278486..23d9c61c 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md +++ b/apps/developer/docs/packages/SDK/interfaces/SCANIdentifier.md @@ -2,52 +2,13 @@ ## Extends -- [`Identifier`](/docs/packages/SDK/interfaces/Identifier.md) +- [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md) ## Properties -### accountNumber - -> **accountNumber**: `string` - -#### Defined in - -[types.ts:341](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L341) - -*** - -### bic? - -> `optional` **bic**: `string` - -#### Inherited from - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`bic`](/docs/packages/SDK/interfaces/Identifier.md#bic) - -#### Defined in - -[types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) - -*** - -### sortCode - -> **sortCode**: `string` - -#### Defined in - -[types.ts:340](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L340) - -*** - -### standard - -> **standard**: [`scan`](/docs/packages/SDK/enumerations/PaymentStandard.md#scan) - -#### Overrides - -[`Identifier`](/docs/packages/SDK/interfaces/Identifier.md).[`standard`](/docs/packages/SDK/interfaces/Identifier.md#standard) - -#### Defined in - -[types.ts:339](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L339) +| Property | Type | Overrides | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `accountNumber` | `string` | - | - | [types.ts:341](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L341) | +| `bic?` | `string` | - | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`bic` | [types.ts:192](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L192) | +| `sortCode` | `string` | - | - | [types.ts:340](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L340) | +| `standard` | `scan` | [`Identifier`](/docs/packages/sdk/interfaces/Identifier.md).`standard` | - | [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 e8137f65..c9b28954 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md +++ b/apps/developer/docs/packages/SDK/interfaces/SignUpPayload.md @@ -2,10 +2,6 @@ ## Properties -### email - -> **email**: `string` - -#### Defined in - -[types.ts:454](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L454) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `email` | `string` | [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 90db95cc..bfdbb550 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md +++ b/apps/developer/docs/packages/SDK/interfaces/SignUpResponse.md @@ -2,20 +2,7 @@ ## Properties -### email - -> **email**: `string` - -#### Defined in - -[types.ts:457](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L457) - -*** - -### profile - -> **profile**: `string` - -#### Defined in - -[types.ts:458](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L458) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `email` | `string` | [types.ts:457](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L457) | +| `profile` | `string` | [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 4a0b0b06..44eb72d8 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md +++ b/apps/developer/docs/packages/SDK/interfaces/SupportingDoc.md @@ -2,60 +2,11 @@ ## Properties -### hash - -> **hash**: `string` - -#### Defined in - -[types.ts:447](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L447) - -*** - -### id - -> **id**: `string` - -#### Defined in - -[types.ts:443](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L443) - -*** - -### meta - -> **meta**: [`SupportingDocMetadata`](/docs/packages/SDK/interfaces/SupportingDocMetadata.md) - -#### Defined in - -[types.ts:448](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L448) - -*** - -### name - -> **name**: `string` - -#### Defined in - -[types.ts:444](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L444) - -*** - -### size - -> **size**: `number` - -#### Defined in - -[types.ts:446](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L446) - -*** - -### type - -> **type**: `string` - -#### Defined in - -[types.ts:445](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L445) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `hash` | `string` | [types.ts:447](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L447) | +| `id` | `string` | [types.ts:443](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L443) | +| `meta` | [`SupportingDocMetadata`](/docs/packages/sdk/interfaces/SupportingDocMetadata.md) | [types.ts:448](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L448) | +| `name` | `string` | [types.ts:444](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L444) | +| `size` | `number` | [types.ts:446](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L446) | +| `type` | `string` | [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 78183cad..f6698cb4 100644 --- a/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md +++ b/apps/developer/docs/packages/SDK/interfaces/SupportingDocMetadata.md @@ -2,30 +2,8 @@ ## Properties -### createdAt - -> **createdAt**: `string` - -#### Defined in - -[types.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L438) - -*** - -### updatedAt - -> **updatedAt**: `string` - -#### Defined in - -[types.ts:439](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L439) - -*** - -### uploadedBy - -> **uploadedBy**: `string` - -#### Defined in - -[types.ts:437](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L437) +| Property | Type | Defined in | +| ------ | ------ | ------ | +| `createdAt` | `string` | [types.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L438) | +| `updatedAt` | `string` | [types.ts:439](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L439) | +| `uploadedBy` | `string` | [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 8774b3b7..cc8b1c2d 100644 --- a/apps/developer/docs/packages/SDK/interfaces/Token.md +++ b/apps/developer/docs/packages/SDK/interfaces/Token.md @@ -4,64 +4,11 @@ Information about the EURe token on different networks. ## Properties -### address - -> **address**: `string` - -The address of the EURe contract on this network - -#### Defined in - -[types.ts:407](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L407) - -*** - -### chain - -> **chain**: [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) - -#### Defined in - -[types.ts:405](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L405) - -*** - -### currency - -> **currency**: [`Currency`](/docs/packages/SDK/enumerations/Currency.md) - -#### Defined in - -[types.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L402) - -*** - -### decimals - -> **decimals**: `number` - -How many decimals this token supports - -#### Defined in - -[types.ts:409](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L409) - -*** - -### symbol - -> **symbol**: [`TokenSymbol`](/docs/packages/SDK/type-aliases/TokenSymbol.md) - -#### Defined in - -[types.ts:404](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L404) - -*** - -### ticker - -> **ticker**: [`Ticker`](/docs/packages/SDK/type-aliases/Ticker.md) - -#### Defined in - -[types.ts:403](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L403) +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `address` | `string` | The address of the EURe contract on this network | [types.ts:407](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L407) | +| `chain` | [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) | - | [types.ts:405](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L405) | +| `currency` | [`Currency`](/docs/packages/sdk/enumerations/Currency.md) | - | [types.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L402) | +| `decimals` | `number` | How many decimals this token supports | [types.ts:409](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L409) | +| `symbol` | [`TokenSymbol`](/docs/packages/sdk/type-aliases/TokenSymbol.md) | - | [types.ts:404](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L404) | +| `ticker` | [`Ticker`](/docs/packages/sdk/type-aliases/Ticker.md) | - | [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/AuthArgs.md b/apps/developer/docs/packages/SDK/type-aliases/AuthArgs.md index dd5bcbdd..a7f20df8 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/AuthArgs.md +++ b/apps/developer/docs/packages/SDK/type-aliases/AuthArgs.md @@ -1,6 +1,6 @@ # Type Alias: AuthArgs -> **AuthArgs**: `Omit`\<[`AuthCodePayload`](/docs/packages/SDK/interfaces/AuthCodePayload.md), `"grant_type"`\> \| `Omit`\<[`RefreshTokenPayload`](/docs/packages/SDK/interfaces/RefreshTokenPayload.md), `"grant_type"`\> \| `Omit`\<[`ClientCredentialsPayload`](/docs/packages/SDK/interfaces/ClientCredentialsPayload.md), `"grant_type"`\> +> **AuthArgs**: `Omit`\<[`AuthCodePayload`](/docs/packages/sdk/interfaces/AuthCodePayload.md), `"grant_type"`\> \| `Omit`\<[`RefreshTokenPayload`](/docs/packages/sdk/interfaces/RefreshTokenPayload.md), `"grant_type"`\> \| `Omit`\<[`ClientCredentialsPayload`](/docs/packages/sdk/interfaces/ClientCredentialsPayload.md), `"grant_type"`\> ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md b/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md index 24ba68f5..6e86a22d 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md +++ b/apps/developer/docs/packages/SDK/type-aliases/BearerTokenCredentials.md @@ -1,6 +1,6 @@ # Type Alias: BearerTokenCredentials -> **BearerTokenCredentials**: [`ClientCredentials`](/docs/packages/SDK/interfaces/ClientCredentials.md) \| [`AuthorizationCodeCredentials`](/docs/packages/SDK/interfaces/AuthorizationCodeCredentials.md) +> **BearerTokenCredentials**: [`ClientCredentials`](/docs/packages/sdk/interfaces/ClientCredentials.md) \| [`AuthorizationCodeCredentials`](/docs/packages/sdk/interfaces/AuthorizationCodeCredentials.md) ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/Beneficiary.md b/apps/developer/docs/packages/SDK/type-aliases/Beneficiary.md index 921acf7e..60e4d3a7 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/Beneficiary.md +++ b/apps/developer/docs/packages/SDK/type-aliases/Beneficiary.md @@ -1,14 +1,12 @@ # Type Alias: Beneficiary -> **Beneficiary**: `Omit`\<[`PersonalProfileDetails`](/docs/packages/SDK/interfaces/PersonalProfileDetails.md), `"idDocument"`\> & `object` +> **Beneficiary**: `Omit`\<[`PersonalProfileDetails`](/docs/packages/sdk/interfaces/PersonalProfileDetails.md), `"idDocument"`\> & \{`ownershipPercentage`: `number`; \} ## Type declaration -### ownershipPercentage - -> **ownershipPercentage**: `number` - -Ownership in % that is between 25% and 100%. +| Name | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `ownershipPercentage` | `number` | Ownership in % that is between 25% and 100%. | [types.ts:240](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L240) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md b/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md index 8596412f..ed944e39 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md +++ b/apps/developer/docs/packages/SDK/type-aliases/ClassOptions.md @@ -1,12 +1,12 @@ # Type Alias: ClassOptions -> **ClassOptions**: `object` & [`BearerTokenCredentials`](/docs/packages/SDK/type-aliases/BearerTokenCredentials.md) +> **ClassOptions**: \{`environment`: [`ENV`](/docs/packages/sdk/type-aliases/ENV.md); \} & [`BearerTokenCredentials`](/docs/packages/sdk/type-aliases/BearerTokenCredentials.md) ## Type declaration -### environment? - -> `optional` **environment**: [`ENV`](/docs/packages/SDK/type-aliases/ENV.md) +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `environment` | [`ENV`](/docs/packages/sdk/type-aliases/ENV.md) | [types.ts:521](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L521) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/Config.md b/apps/developer/docs/packages/SDK/type-aliases/Config.md index 3a85ac79..158a8804 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/Config.md +++ b/apps/developer/docs/packages/SDK/type-aliases/Config.md @@ -1,20 +1,14 @@ # Type Alias: Config -> **Config**: `object` +> **Config**: \{`environments`: \{`production`: [`Environment`](/docs/packages/sdk/type-aliases/Environment.md);`sandbox`: [`Environment`](/docs/packages/sdk/type-aliases/Environment.md); \}; \} ## Type declaration -### environments - -> **environments**: `object` - -### environments.production - -> **environments.production**: [`Environment`](/docs/packages/SDK/type-aliases/Environment.md) - -### environments.sandbox - -> **environments.sandbox**: [`Environment`](/docs/packages/SDK/type-aliases/Environment.md) +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `environments` | \{`production`: [`Environment`](/docs/packages/sdk/type-aliases/Environment.md);`sandbox`: [`Environment`](/docs/packages/sdk/type-aliases/Environment.md); \} | [types.ts:6](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L6) | +| `environments.production` | [`Environment`](/docs/packages/sdk/type-aliases/Environment.md) | [types.ts:6](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L6) | +| `environments.sandbox` | [`Environment`](/docs/packages/sdk/type-aliases/Environment.md) | [types.ts:6](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L6) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/Director.md b/apps/developer/docs/packages/SDK/type-aliases/Director.md index ee6e5802..1a225f6d 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/Director.md +++ b/apps/developer/docs/packages/SDK/type-aliases/Director.md @@ -1,6 +1,6 @@ # Type Alias: Director -> **Director**: `Omit`\<[`PersonalProfileDetails`](/docs/packages/SDK/interfaces/PersonalProfileDetails.md), `"idDocument"`\> +> **Director**: `Omit`\<[`PersonalProfileDetails`](/docs/packages/sdk/interfaces/PersonalProfileDetails.md), `"idDocument"`\> ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/Environment.md b/apps/developer/docs/packages/SDK/type-aliases/Environment.md index 4ccf7f11..0dcb0993 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/Environment.md +++ b/apps/developer/docs/packages/SDK/type-aliases/Environment.md @@ -1,20 +1,14 @@ # Type Alias: Environment -> **Environment**: `object` +> **Environment**: \{`api`: `string`;`web`: `string`;`wss`: `string`; \} ## Type declaration -### api - -> **api**: `string` - -### web - -> **web**: `string` - -### wss - -> **wss**: `string` +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `api` | `string` | [types.ts:3](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L3) | +| `web` | `string` | [types.ts:3](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L3) | +| `wss` | `string` | [types.ts:3](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L3) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md b/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md index fd77257c..705a7cca 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md +++ b/apps/developer/docs/packages/SDK/type-aliases/NewOrder.md @@ -1,6 +1,6 @@ # Type Alias: NewOrder -> **NewOrder**: [`NewOrderByAddress`](/docs/packages/SDK/interfaces/NewOrderByAddress.md) \| [`NewOrderByAccountId`](/docs/packages/SDK/interfaces/NewOrderByAccountId.md) +> **NewOrder**: [`NewOrderByAddress`](/docs/packages/sdk/interfaces/NewOrderByAddress.md) \| [`NewOrderByAccountId`](/docs/packages/sdk/interfaces/NewOrderByAccountId.md) ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/OpenArgs.md b/apps/developer/docs/packages/SDK/type-aliases/OpenArgs.md index 815ee1d9..41bc2af6 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/OpenArgs.md +++ b/apps/developer/docs/packages/SDK/type-aliases/OpenArgs.md @@ -1,6 +1,6 @@ # Type Alias: OpenArgs -> **OpenArgs**: `Omit`\<[`AuthCodePayload`](/docs/packages/SDK/interfaces/AuthCodePayload.md), `"grant_type"` \| `"code"` \| `"code_verifier"`\> \| `Omit`\<[`RefreshTokenPayload`](/docs/packages/SDK/interfaces/RefreshTokenPayload.md), `"grant_type"`\> \| `Omit`\<[`ClientCredentialsPayload`](/docs/packages/SDK/interfaces/ClientCredentialsPayload.md), `"grant_type"`\> \| [`PKCERequestArgs`](/docs/packages/SDK/type-aliases/PKCERequestArgs.md) +> **OpenArgs**: `Omit`\<[`AuthCodePayload`](/docs/packages/sdk/interfaces/AuthCodePayload.md), `"grant_type"` \| `"code"` \| `"code_verifier"`\> \| `Omit`\<[`RefreshTokenPayload`](/docs/packages/sdk/interfaces/RefreshTokenPayload.md), `"grant_type"`\> \| `Omit`\<[`ClientCredentialsPayload`](/docs/packages/sdk/interfaces/ClientCredentialsPayload.md), `"grant_type"`\> \| [`PKCERequestArgs`](/docs/packages/sdk/type-aliases/PKCERequestArgs.md) ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/PKCERequest.md b/apps/developer/docs/packages/SDK/type-aliases/PKCERequest.md index 8f8b822a..ac64f684 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/PKCERequest.md +++ b/apps/developer/docs/packages/SDK/type-aliases/PKCERequest.md @@ -1,74 +1,22 @@ # Type Alias: PKCERequest -> **PKCERequest**: `object` +> **PKCERequest**: \{`address`: `string`;`chain`: [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) \| [`ChainId`](/docs/packages/sdk/type-aliases/ChainId.md);`client_id`: `string`;`code_challenge`: `string`;`code_challenge_method`: `"S256"`;`redirect_uri`: `string`;`response_type`: `"code"`;`scope`: `string`;`signature`: `string`;`skipCreateAccount`: `boolean`;`state`: `string`; \} ## Type declaration -### address? - -> `optional` **address**: `string` - -the address of the wallet to automatically link - -### chain? - -> `optional` **chain**: [`Chain`](/docs/packages/SDK/type-aliases/Chain.md) \| [`ChainId`](/docs/packages/SDK/type-aliases/ChainId.md) - -The network of the wallet to automatically link - -### client\_id - -> **client\_id**: `string` - -the authentication flow client id of the application - -### code\_challenge - -> **code\_challenge**: `string` - -the code challenge automatically generated by the SDK - -### code\_challenge\_method - -> **code\_challenge\_method**: `"S256"` - -the code challenge method for the authentication flow , handled by the SDK - -### redirect\_uri - -> **redirect\_uri**: `string` - -the redirect uri of the application - -### response\_type - -> **response\_type**: `"code"` - -the response type of the authentication flow, handled by the SDK - -### scope? - -> `optional` **scope**: `string` - -the scope of the application - -### signature? - -> `optional` **signature**: `string` - -the signature of the wallet to automatically link - -### skipCreateAccount? - -> `optional` **skipCreateAccount**: `boolean` - -You can skip the connect wallet and request IBAN steps in the Authorization Flow and use the Link Address and Request IBAN API endpoints after you have gotten the authorization - -### state? - -> `optional` **state**: `string` - -the state of the application +| Name | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `address` | `string` | the address of the wallet to automatically link | [types.ts:109](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L109) | +| `chain` | [`Chain`](/docs/packages/sdk/type-aliases/Chain.md) \| [`ChainId`](/docs/packages/sdk/type-aliases/ChainId.md) | The network of the wallet to automatically link | [types.ts:113](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L113) | +| `client_id` | `string` | the authentication flow client id of the application | [types.ts:95](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L95) | +| `code_challenge` | `string` | the code challenge automatically generated by the SDK | [types.ts:97](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L97) | +| `code_challenge_method` | `"S256"` | the code challenge method for the authentication flow , handled by the SDK | [types.ts:99](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L99) | +| `redirect_uri` | `string` | the redirect uri of the application | [types.ts:105](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L105) | +| `response_type` | `"code"` | the response type of the authentication flow, handled by the SDK | [types.ts:101](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L101) | +| `scope` | `string` | the scope of the application | [types.ts:107](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L107) | +| `signature` | `string` | the signature of the wallet to automatically link | [types.ts:111](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L111) | +| `skipCreateAccount` | `boolean` | You can skip the connect wallet and request IBAN steps in the Authorization Flow and use the Link Address and Request IBAN API endpoints after you have gotten the authorization | [types.ts:115](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L115) | +| `state` | `string` | the state of the application | [types.ts:103](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L103) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/PKCERequestArgs.md b/apps/developer/docs/packages/SDK/type-aliases/PKCERequestArgs.md index f275f3d6..bf2f2c99 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/PKCERequestArgs.md +++ b/apps/developer/docs/packages/SDK/type-aliases/PKCERequestArgs.md @@ -1,6 +1,6 @@ # Type Alias: PKCERequestArgs -> **PKCERequestArgs**: `Omit`\<[`PKCERequest`](/docs/packages/SDK/type-aliases/PKCERequest.md), `"code_challenge"` \| `"code_challenge_method"` \| `"response_type"`\> +> **PKCERequestArgs**: `Omit`\<[`PKCERequest`](/docs/packages/sdk/type-aliases/PKCERequest.md), `"code_challenge"` \| `"code_challenge_method"` \| `"response_type"`\> ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/Representative.md b/apps/developer/docs/packages/SDK/type-aliases/Representative.md index 9a129590..f3af146f 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/Representative.md +++ b/apps/developer/docs/packages/SDK/type-aliases/Representative.md @@ -1,6 +1,6 @@ # Type Alias: Representative -> **Representative**: [`PersonalProfileDetails`](/docs/packages/SDK/interfaces/PersonalProfileDetails.md) +> **Representative**: [`PersonalProfileDetails`](/docs/packages/sdk/interfaces/PersonalProfileDetails.md) ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md b/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md index 74c6e5a3..984bdf22 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md +++ b/apps/developer/docs/packages/SDK/type-aliases/ResponseStatus.md @@ -1,16 +1,13 @@ # Type Alias: ResponseStatus -> **ResponseStatus**: `object` +> **ResponseStatus**: \{`status`: `number`;`statusText`: `string`; \} ## Type declaration -### status - -> **status**: `number` - -### statusText - -> **statusText**: `string` +| Name | Type | Defined in | +| ------ | ------ | ------ | +| `status` | `number` | [types.ts:549](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L549) | +| `statusText` | `string` | [types.ts:550](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L550) | ## Defined in diff --git a/apps/developer/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md b/apps/developer/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md index ec051be8..ef83d0b0 100644 --- a/apps/developer/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md +++ b/apps/developer/docs/packages/SDK/type-aliases/SubmitProfileDetailsPayload.md @@ -1,6 +1,6 @@ # Type Alias: SubmitProfileDetailsPayload -> **SubmitProfileDetailsPayload**: [`PersonalProfileDetailsRequest`](/docs/packages/SDK/interfaces/PersonalProfileDetailsRequest.md) \| [`CorporateProfileDetailsRequest`](/docs/packages/SDK/interfaces/CorporateProfileDetailsRequest.md) +> **SubmitProfileDetailsPayload**: [`PersonalProfileDetailsRequest`](/docs/packages/sdk/interfaces/PersonalProfileDetailsRequest.md) \| [`CorporateProfileDetailsRequest`](/docs/packages/sdk/interfaces/CorporateProfileDetailsRequest.md) ## Defined in diff --git a/apps/developer/docs/packages/SDK/variables/constants.md b/apps/developer/docs/packages/SDK/variables/constants.md index 7e844ec3..d820a759 100644 --- a/apps/developer/docs/packages/SDK/variables/constants.md +++ b/apps/developer/docs/packages/SDK/variables/constants.md @@ -1,26 +1,14 @@ # Variable: constants -> **constants**: `object` +> **constants**: \{`LINK_MESSAGE`: `'I hereby declare that I am the address owner.'`;`STORAGE_CODE_VERIFIER`: `'monerium.sdk.code_verifier'`;`STORAGE_REFRESH_TOKEN`: `'monerium.sdk.refresh_token'`; \} ## Type declaration -### LINK\_MESSAGE - -> **LINK\_MESSAGE**: `string` = `'I hereby declare that I am the address owner.'` - -The message used to link addresses. - -### STORAGE\_CODE\_VERIFIER - -> **STORAGE\_CODE\_VERIFIER**: `string` = `'monerium.sdk.code_verifier'` - -The key used to store the code verifier in the local storage. - -### STORAGE\_REFRESH\_TOKEN - -> **STORAGE\_REFRESH\_TOKEN**: `string` = `'monerium.sdk.refresh_token'` - -The key used to store the refresh token in the local storage. +| Name | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `LINK_MESSAGE` | `string` | 'I hereby declare that I am the address owner.' | The message used to link addresses. | [constants.ts:5](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/constants.ts#L5) | +| `STORAGE_CODE_VERIFIER` | `string` | 'monerium.sdk.code\_verifier' | The key used to store the code verifier in the local storage. | [constants.ts:9](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/constants.ts#L9) | +| `STORAGE_REFRESH_TOKEN` | `string` | 'monerium.sdk.refresh\_token' | The key used to store the refresh token in the local storage. | [constants.ts:13](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/constants.ts#L13) | ## Defined in diff --git a/apps/developer/docs/packages/index.md b/apps/developer/docs/packages/index.md deleted file mode 100644 index cff4e787..00000000 --- a/apps/developer/docs/packages/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Packages - -## Packages - -- [SDK](/docs/packages/SDK/index.md) -- [SDK React Provider](/docs/packages/SDK%20React%20Provider/index.md) diff --git a/apps/developer/docs/packages/typedoc-sidebar.cjs b/apps/developer/docs/packages/typedoc-sidebar.cjs deleted file mode 100644 index e9d0da3f..00000000 --- a/apps/developer/docs/packages/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"SDK","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"packages/SDK/classes/MoneriumClient","label":"MoneriumClient"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"packages/SDK/variables/constants","label":"constants"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"packages/SDK/functions/getChain","label":"getChain"},{"type":"doc","id":"packages/SDK/functions/placeOrderMessage","label":"placeOrderMessage"},{"type":"doc","id":"packages/SDK/functions/rfc3339","label":"rfc3339"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"packages/SDK/interfaces/Address","label":"Address"},{"type":"doc","id":"packages/SDK/interfaces/Addresses","label":"Addresses"},{"type":"doc","id":"packages/SDK/interfaces/AddressesQueryParams","label":"AddressesQueryParams"},{"type":"doc","id":"packages/SDK/interfaces/AuthCodePayload","label":"AuthCodePayload"},{"type":"doc","id":"packages/SDK/interfaces/AuthFlowOptions","label":"AuthFlowOptions"},{"type":"doc","id":"packages/SDK/interfaces/AuthorizationCodeCredentials","label":"AuthorizationCodeCredentials"},{"type":"doc","id":"packages/SDK/interfaces/Balances","label":"Balances"},{"type":"doc","id":"packages/SDK/interfaces/BearerProfile","label":"BearerProfile"},{"type":"doc","id":"packages/SDK/interfaces/ClientCredentials","label":"ClientCredentials"},{"type":"doc","id":"packages/SDK/interfaces/ClientCredentialsPayload","label":"ClientCredentialsPayload"},{"type":"doc","id":"packages/SDK/interfaces/CorporateProfileDetails","label":"CorporateProfileDetails"},{"type":"doc","id":"packages/SDK/interfaces/CorporateProfileDetailsRequest","label":"CorporateProfileDetailsRequest"},{"type":"doc","id":"packages/SDK/interfaces/Corporation","label":"Corporation"},{"type":"doc","id":"packages/SDK/interfaces/Counterpart","label":"Counterpart"},{"type":"doc","id":"packages/SDK/interfaces/CrossChainIdentifier","label":"CrossChainIdentifier"},{"type":"doc","id":"packages/SDK/interfaces/CurrencyBalance","label":"CurrencyBalance"},{"type":"doc","id":"packages/SDK/interfaces/Fee","label":"Fee"},{"type":"doc","id":"packages/SDK/interfaces/IBAN","label":"IBAN"},{"type":"doc","id":"packages/SDK/interfaces/IBANIdentifier","label":"IBANIdentifier"},{"type":"doc","id":"packages/SDK/interfaces/IBANsResponse","label":"IBANsResponse"},{"type":"doc","id":"packages/SDK/interfaces/IbansQueryParams","label":"IbansQueryParams"},{"type":"doc","id":"packages/SDK/interfaces/Identifier","label":"Identifier"},{"type":"doc","id":"packages/SDK/interfaces/Individual","label":"Individual"},{"type":"doc","id":"packages/SDK/interfaces/KYC","label":"KYC"},{"type":"doc","id":"packages/SDK/interfaces/LinkAddress","label":"LinkAddress"},{"type":"doc","id":"packages/SDK/interfaces/MoveIbanPayload","label":"MoveIbanPayload"},{"type":"doc","id":"packages/SDK/interfaces/NewOrderByAccountId","label":"NewOrderByAccountId"},{"type":"doc","id":"packages/SDK/interfaces/NewOrderByAddress","label":"NewOrderByAddress"},{"type":"doc","id":"packages/SDK/interfaces/NewOrderCommon","label":"NewOrderCommon"},{"type":"doc","id":"packages/SDK/interfaces/Order","label":"Order"},{"type":"doc","id":"packages/SDK/interfaces/OrderFilter","label":"OrderFilter"},{"type":"doc","id":"packages/SDK/interfaces/OrderMetadata","label":"OrderMetadata"},{"type":"doc","id":"packages/SDK/interfaces/OrderNotificationQueryParams","label":"OrderNotificationQueryParams"},{"type":"doc","id":"packages/SDK/interfaces/PersonalProfileDetails","label":"PersonalProfileDetails"},{"type":"doc","id":"packages/SDK/interfaces/PersonalProfileDetailsRequest","label":"PersonalProfileDetailsRequest"},{"type":"doc","id":"packages/SDK/interfaces/Profile","label":"Profile"},{"type":"doc","id":"packages/SDK/interfaces/ProfilePermissions","label":"ProfilePermissions"},{"type":"doc","id":"packages/SDK/interfaces/ProfilesQueryParams","label":"ProfilesQueryParams"},{"type":"doc","id":"packages/SDK/interfaces/ProfilesResponse","label":"ProfilesResponse"},{"type":"doc","id":"packages/SDK/interfaces/RefreshTokenPayload","label":"RefreshTokenPayload"},{"type":"doc","id":"packages/SDK/interfaces/RequestIbanPayload","label":"RequestIbanPayload"},{"type":"doc","id":"packages/SDK/interfaces/SCANIdentifier","label":"SCANIdentifier"},{"type":"doc","id":"packages/SDK/interfaces/SignUpPayload","label":"SignUpPayload"},{"type":"doc","id":"packages/SDK/interfaces/SignUpResponse","label":"SignUpResponse"},{"type":"doc","id":"packages/SDK/interfaces/SupportingDoc","label":"SupportingDoc"},{"type":"doc","id":"packages/SDK/interfaces/SupportingDocMetadata","label":"SupportingDocMetadata"},{"type":"doc","id":"packages/SDK/interfaces/Token","label":"Token"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"packages/SDK/type-aliases/AuthArgs","label":"AuthArgs"},{"type":"doc","id":"packages/SDK/type-aliases/BearerTokenCredentials","label":"BearerTokenCredentials"},{"type":"doc","id":"packages/SDK/type-aliases/Beneficiary","label":"Beneficiary"},{"type":"doc","id":"packages/SDK/type-aliases/Chain","label":"Chain"},{"type":"doc","id":"packages/SDK/type-aliases/ChainId","label":"ChainId"},{"type":"doc","id":"packages/SDK/type-aliases/ClassOptions","label":"ClassOptions"},{"type":"doc","id":"packages/SDK/type-aliases/Config","label":"Config"},{"type":"doc","id":"packages/SDK/type-aliases/Director","label":"Director"},{"type":"doc","id":"packages/SDK/type-aliases/ENV","label":"ENV"},{"type":"doc","id":"packages/SDK/type-aliases/Environment","label":"Environment"},{"type":"doc","id":"packages/SDK/type-aliases/EthereumTestnet","label":"EthereumTestnet"},{"type":"doc","id":"packages/SDK/type-aliases/GnosisTestnet","label":"GnosisTestnet"},{"type":"doc","id":"packages/SDK/type-aliases/NewOrder","label":"NewOrder"},{"type":"doc","id":"packages/SDK/type-aliases/OpenArgs","label":"OpenArgs"},{"type":"doc","id":"packages/SDK/type-aliases/PKCERequest","label":"PKCERequest"},{"type":"doc","id":"packages/SDK/type-aliases/PKCERequestArgs","label":"PKCERequestArgs"},{"type":"doc","id":"packages/SDK/type-aliases/PolygonTestnet","label":"PolygonTestnet"},{"type":"doc","id":"packages/SDK/type-aliases/Representative","label":"Representative"},{"type":"doc","id":"packages/SDK/type-aliases/ResponseStatus","label":"ResponseStatus"},{"type":"doc","id":"packages/SDK/type-aliases/SubmitProfileDetailsPayload","label":"SubmitProfileDetailsPayload"},{"type":"doc","id":"packages/SDK/type-aliases/Ticker","label":"Ticker"},{"type":"doc","id":"packages/SDK/type-aliases/TokenSymbol","label":"TokenSymbol"}]},{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"packages/SDK/enumerations/AccountState","label":"AccountState"},{"type":"doc","id":"packages/SDK/enumerations/Currency","label":"Currency"},{"type":"doc","id":"packages/SDK/enumerations/IdDocumentKind","label":"IdDocumentKind"},{"type":"doc","id":"packages/SDK/enumerations/KYCOutcome","label":"KYCOutcome"},{"type":"doc","id":"packages/SDK/enumerations/KYCState","label":"KYCState"},{"type":"doc","id":"packages/SDK/enumerations/Method","label":"Method"},{"type":"doc","id":"packages/SDK/enumerations/OrderKind","label":"OrderKind"},{"type":"doc","id":"packages/SDK/enumerations/OrderState","label":"OrderState"},{"type":"doc","id":"packages/SDK/enumerations/PaymentStandard","label":"PaymentStandard"},{"type":"doc","id":"packages/SDK/enumerations/Permission","label":"Permission"},{"type":"doc","id":"packages/SDK/enumerations/ProfileState","label":"ProfileState"},{"type":"doc","id":"packages/SDK/enumerations/ProfileType","label":"ProfileType"}]}],"link":{"type":"doc","id":"packages/SDK/index"}},{"type":"category","label":"SDK React Provider","items":[{"type":"category","label":"Provider","items":[{"type":"doc","id":"packages/SDK React Provider/functions/MoneriumProvider","label":"MoneriumProvider"}]},{"type":"category","label":"Hooks","items":[{"type":"category","label":"Addresses","items":[]},{"type":"category","label":"Authentication","items":[]},{"type":"category","label":"IBANs","items":[]},{"type":"category","label":"Orders","items":[]},{"type":"category","label":"Profiles","items":[]},{"type":"category","label":"Other","items":[]}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"packages/SDK React Provider/variables/MoneriumContext","label":"MoneriumContext"},{"type":"doc","id":"packages/SDK React Provider/variables/keys","label":"keys"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"packages/SDK React Provider/type-aliases/AuthorizeParams","label":"AuthorizeParams"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/MutationOptions","label":"MutationOptions"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/MutationResult","label":"MutationResult"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/QueryOptions","label":"QueryOptions"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/QueryResult","label":"QueryResult"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/SdkInstance","label":"SdkInstance"},{"type":"doc","id":"packages/SDK React Provider/type-aliases/UseAuthReturn","label":"UseAuthReturn"}]}],"link":{"type":"doc","id":"packages/SDK React Provider/index"}}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/apps/developer/docusaurus.config.ts b/apps/developer/docusaurus.config.ts index cf944eeb..8d8be9d3 100644 --- a/apps/developer/docusaurus.config.ts +++ b/apps/developer/docusaurus.config.ts @@ -1,7 +1,94 @@ import { themes as prismThemes } from 'prism-react-renderer'; import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; +import { TypeDocOptions } from 'typedoc'; +import { PluginOptions } from 'typedoc-plugin-markdown'; +// https://typedoc-plugin-markdown.org/schema.json +const typedocConfig: PluginOptions | Partial = { + cleanOutputDir: true, + entryPointStrategy: 'Expand', + gitRevision: 'main', + + readme: 'none', + + // skipErrorChecking: true, + expandObjects: true, + expandParameters: true, + + hideParameterTypesInTitle: true, + hidePageHeader: true, + hideGenerator: true, + + categorizeByGroup: true, + + navigationModel: { + excludeFolders: true, + excludeGroups: false, + excludeCategories: false, + }, + + parametersFormat: 'table', + interfacePropertiesFormat: 'table', + enumMembersFormat: 'table', + classPropertiesFormat: 'table', + typeDeclarationFormat: 'table', + propertyMembersFormat: 'table', + + kindSortOrder: [ + 'Class', + 'Property', + 'Function', + 'Variable', + 'Interface', + 'TypeAlias', + 'Enum', + 'EnumMember', + ], + groupOrder: [ + 'Provider', + 'Hooks', + 'Constructors', + 'Properties', + 'Authentication', + 'Addresses', + 'Profiles', + 'IBANs', + 'Orders', + 'Tokens', + 'Classes', + 'Constants', + 'Functions', + 'Variables', + 'Methods', + 'Utils', + 'Interfaces', + 'Type Aliases', + 'Documents', + '*', + ], + + categoryOrder: [ + 'Provider', + 'Constructors', + 'Properties', + 'Classes', + 'Functions', + 'Variables', + 'Methods', + 'Interfaces', + 'Type Aliases', + 'Hooks', + 'Documents', + '*', + 'Authorize', + 'Accounts', + 'Profiles', + 'Orders', + 'Tokens', + 'Other', + ], +}; const config: Config = { title: 'Monerium', tagline: 'Onchain fiat', @@ -15,21 +102,30 @@ const config: Config = { // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: 'monerium', // Usually your GitHub org/user name. - projectName: 'docusaurus', // Usually your repo name. + projectName: 'js-monerium', // Usually your repo name. plugins: [ [ 'docusaurus-plugin-typedoc', { - entryPointStrategy: 'Packages', - entryPoints: [ - '../../packages/sdk/', - '../../packages/sdk-react-provider/', - ], - out: 'docs/packages', - publicPath: '/docs/packages', + ...typedocConfig, + id: 'sdk', + entryPoints: ['../../packages/sdk/src/index.ts'], + tsconfig: '../../packages/sdk/tsconfig.json', + out: 'docs/packages/sdk', + publicPath: '/docs/packages/sdk', + watch: process.env.TYPEDOC_WATCH, + }, + ], + [ + 'docusaurus-plugin-typedoc', + { + ...typedocConfig, + id: '@monerium/sdk-react-provider', + entryPoints: ['../../packages/sdk-react-provider/src/index.ts'], + tsconfig: '../../packages/sdk-react-provider/tsconfig.json', + out: 'docs/packages/sdk-react-provider', + publicPath: '/docs/packages/sdk-react-provider', watch: process.env.TYPEDOC_WATCH, - readme: 'none', - name: 'Packages', }, ], ], diff --git a/apps/developer/package.json b/apps/developer/package.json index e8878104..1c3af041 100644 --- a/apps/developer/package.json +++ b/apps/developer/package.json @@ -3,8 +3,7 @@ "version": "0.0.0", "private": true, "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start --port 3333", + "dev": "TYPEDOC_WATCH=true docusaurus start --port 3333 --poll 5000", "build": "docusaurus build", "generate-docs": "docusaurus build", "swizzle": "docusaurus swizzle", diff --git a/apps/developer/sidebars.ts b/apps/developer/sidebars.ts index acc7685a..ae437fc5 100644 --- a/apps/developer/sidebars.ts +++ b/apps/developer/sidebars.ts @@ -1,4 +1,4 @@ -import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; /** * Creating a sidebar enables you to: @@ -12,7 +12,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], // But you can create a sidebar manually /* @@ -26,6 +26,35 @@ const sidebars: SidebarsConfig = { }, ], */ + typedocSidebar: [ + { + type: 'category', + label: 'Welcome', + link: { + type: 'doc', + id: 'index', + }, + items: ['index'], + }, + { + type: 'category', + label: 'SDK', + link: { + type: 'doc', + id: 'packages/sdk/index', + }, + items: require('./docs/packages/sdk/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: 'SDK React Provider', + link: { + type: 'doc', + id: 'packages/sdk-react-provider/index', + }, + items: require('./docs/packages/sdk-react-provider/typedoc-sidebar.cjs'), + }, + ], }; export default sidebars; diff --git a/apps/developer/src/pages/index.tsx b/apps/developer/src/pages/index.tsx index 3fd642fd..8a95b390 100644 --- a/apps/developer/src/pages/index.tsx +++ b/apps/developer/src/pages/index.tsx @@ -18,7 +18,7 @@ function HomepageHeader() {

{siteConfig.tagline}

- Visit the documentation + Let's go!
diff --git a/package.json b/package.json index 1a878cc7..7d82f0fa 100644 --- a/package.json +++ b/package.json @@ -36,9 +36,9 @@ "prettier": "^3.2.5", "ts-jest": "^29.1.4", "tsup": "^8.1.0", - "turbo": "latest", + "turbo": "^2.0.14", "typedoc": "^0.26.4", - "typedoc-plugin-markdown": "^4.2.1" + "typedoc-plugin-markdown": "^4.2.5" }, "packageManager": "pnpm@9.4.0", "engines": { diff --git a/packages/sdk-react-provider/package.json b/packages/sdk-react-provider/package.json index 71fd3fbe..f5050a6a 100644 --- a/packages/sdk-react-provider/package.json +++ b/packages/sdk-react-provider/package.json @@ -29,6 +29,7 @@ "scripts": { "build": "tsup", "dev": "tsup --watch --onSuccess 'pnpm type-map'", + "dev:docs": "echo 'No docs to build'", "typedoc": "typedoc", "lint": "eslint . --fix", "pub:pre": "pnpm publish --no-git-checks --dry-run", diff --git a/packages/sdk-react-provider/src/lib/hooks.tsx b/packages/sdk-react-provider/src/lib/hooks.tsx index 007df110..12c34558 100644 --- a/packages/sdk-react-provider/src/lib/hooks.tsx +++ b/packages/sdk-react-provider/src/lib/hooks.tsx @@ -92,7 +92,7 @@ function useSdk(): MoneriumClient | undefined { * * authorize(); // Redirects to the Monerium auth flow. * - * // To opt-in to automated wallet linking, pass the address, signature and chain. + * // Opt-in to automated wallet linking with these parameters. * authorize({ address, signature, chain }). * ``` * @@ -144,7 +144,7 @@ export function useAuth(): UseAuthReturn { * @see * [API Documentation](https://monerium.dev/api-docs#operation/profile) * - * [Profile interface](/docs/packages/SDK/interfaces/Profile.md) + * [Profile interface](/docs/packages/sdk/interfaces/Profile.md) */ export function useProfile({ profile, @@ -206,7 +206,7 @@ export function useProfile({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/profiles) * - * [Profile interface](/docs/packages/SDK/interfaces/Profile.md) + * [Profile interface](/docs/packages/sdk/interfaces/Profile.md) */ export function useProfiles({ query, @@ -257,7 +257,7 @@ export function useProfiles({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/tokens) * - * [Token interface](/docs/packages/SDK/interfaces/Token.md) + * [Token interface](/docs/packages/sdk/interfaces/Token.md) */ export function useTokens({ query, @@ -420,7 +420,7 @@ export function useAddresses({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/profile-balances) * - * [Balances interface](/docs/packages/SDK/interfaces/Balances.md) + * [Balances interface](/docs/packages/sdk/interfaces/Balances.md) */ export function useBalances({ profile, @@ -460,7 +460,7 @@ export function useBalances({ * @group Hooks * @category IBANs * @param {Object} params - * @param {QueryOptions} param.iban Fetch a specific IBAN + * @param {QueryOptions} params.iban Fetch a specific IBAN * @param {QueryOptions} [params.query] {@inheritDoc QueryOptions} * @example @@ -591,7 +591,7 @@ export function useIBANs({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/order) * - * [Order interface](/docs/packages/SDK/interfaces/Order.md) + * [Order interface](/docs/packages/sdk/interfaces/Order.md) */ export function useOrder({ orderId, @@ -652,7 +652,7 @@ export function useOrder({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/orders) * - * [Order interface](/docs/packages/SDK/interfaces/Order.md) + * [Order interface](/docs/packages/sdk/interfaces/Order.md) */ export function useOrders({ query = {}, @@ -697,7 +697,7 @@ export function useOrders({ * @category Profiles * @param param * @param {string} param.profile The id of the profile to submit to. - * @param {Object} param.mutation {@inheritDoc MutationOptions} + * @param {Object} [param.mutation] {@inheritDoc MutationOptions} * * @example * ```ts @@ -932,7 +932,7 @@ export function useMoveIban({ * @category Orders * @param param * @param {File} param.supportingDocument Supporting document file. - * @param {Object} param.mutation {@inheritDoc MutationOptions} + * @param {Object} [param.mutation] {@inheritDoc MutationOptions} * * @example * ```ts @@ -948,7 +948,7 @@ export function useMoveIban({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/post-orders) * - * [NewOrder type](/docs/packages/SDK/type-aliases/NewOrder.md) + * [NewOrder type](/docs/packages/sdk/type-aliases/NewOrder.md) */ export function usePlaceOrder({ @@ -1012,13 +1012,12 @@ export function usePlaceOrder({ } /** * # Add address to profile. - * When the address has been linked, the relevant profile query will be invalidated and re-fetched. * * @group Hooks * @category Profiles * @param param * @param {File} param.profileId Which profile to link the address. - * @param {Object} param.mutation {@inheritDoc MutationOptions} + * @param {Object} [param.mutation] {@inheritDoc MutationOptions} * * @example * ```ts @@ -1034,7 +1033,7 @@ export function usePlaceOrder({ * @see * [API Documentation](https://monerium.dev/api-docs#operation/profile-addresses) * - * [LinkAddress interface](/docs/packages/SDK/interfaces/LinkAddress.md) + * [LinkAddress interface](/docs/packages/sdk/interfaces/LinkAddress.md) */ export function useLinkAddress({ diff --git a/packages/sdk-react-provider/src/lib/provider.test.tsx b/packages/sdk-react-provider/src/lib/provider.test.tsx index dccfeedb..74c40da9 100644 --- a/packages/sdk-react-provider/src/lib/provider.test.tsx +++ b/packages/sdk-react-provider/src/lib/provider.test.tsx @@ -1,10 +1,8 @@ -import { createElement } from 'react'; import '@testing-library/jest-dom'; import { QueryClient, QueryClientProvider } from '@tanstack/react-query'; // eslint-disable-next-line no-redeclare import { screen } from '@testing-library/dom'; import { render, waitFor } from '@testing-library/react'; -import { wrap } from 'module'; import { useAuth, useProfile } from './hooks'; import { MoneriumProvider } from './provider'; diff --git a/packages/sdk-react-provider/src/lib/provider.tsx b/packages/sdk-react-provider/src/lib/provider.tsx index f9355075..41104509 100644 --- a/packages/sdk-react-provider/src/lib/provider.tsx +++ b/packages/sdk-react-provider/src/lib/provider.tsx @@ -19,7 +19,6 @@ import { AuthorizeParams } from './types'; export const MoneriumProvider = ({ children, clientId, - redirectUrl, redirectUri, environment = 'sandbox', }: { diff --git a/packages/sdk-react-provider/src/lib/types.ts b/packages/sdk-react-provider/src/lib/types.ts index 5310f20f..70ffe67d 100644 --- a/packages/sdk-react-provider/src/lib/types.ts +++ b/packages/sdk-react-provider/src/lib/types.ts @@ -42,13 +42,20 @@ export type UseAuthReturn = { * See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. * @see # [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) * @template {Object} TData - The data returned. - * - * @options - * > `queryKey` and `queryFn` are used internally and therefore not included in the options. + * @example + * ```ts + * useQueryHook({ + * query: { + * enabled: isReady, + * staleTime: 1000, + * placeHolderData: { foo: 'bar' }, + * } + * }) + * ``` + * ## Options + * > `queryKey` and `queryFn` are used internally and therefore not included as an options. * ```diff * query: { - * - queryKey, - * - queryFn, * gcTime, * enabled, * networkMode, @@ -72,26 +79,6 @@ export type UseAuthReturn = { * throwOnError * } * ``` - * @example - * ```ts - * useQueryHook({ - * query: { - * enabled: isReady, - * staleTime: 1000, - * placeHolderData: { foo: 'bar' }, - * } - * }) - * ``` - * @usedBy - * {@link useAuthContext} - * - * {@link useBalances} - * - * {@link useOrders} - * - * {@link useProfile} - * - * {@link useTokens} */ export type QueryOptions = Omit< UseQueryOptions, @@ -134,16 +121,6 @@ export type QueryOptions = Omit< * status, *} * ``` - * @usedBy - * {@link useAuthContext} - * - * {@link useBalances} - * - * {@link useOrders} - * - * {@link useProfile} - * - * {@link useTokens} * */ export type QueryResult = Omit< @@ -161,14 +138,26 @@ export type QueryResult = Omit< * @template {Object} TError - The error returned. * @template {Object} TVariables - The variables used in the mutation. * - * @options - * > `mutationKey` and `mutationFn` are used internally and therefore not included in the options. + * @example + * ```ts + * useMutationHook({ + * mutation: { + * onSuccess: (data, variables) => { + * console.log('onSuccess callback', data, variables); + * }, + * onError: (error) => { + * console.log('onError callback', error); + * }, + * }, + * }) + * + * ``` + * ## Options + * > `mutationKey` and `mutationFn` are used internally and therefore not included as an options. * ```diff * mutation: { * gcTime, * meta, - * - mutationFn, - * - mutationKey, * networkMode, * onError, * onMutate, @@ -180,24 +169,6 @@ export type QueryResult = Omit< * throwOnError, * } * ``` - * @example - * ```ts - * useMutationHook({ - * mutation: { - * onSuccess: (data, variables) => { - * console.log('onSuccess callback', data, variables); - * }, - * onError: (error) => { - * console.log('onError callback', error); - * }, - * }, - * }) - * ``` - * - * @usedBy - * {@link useLinkAddress} - * - * {@link usePlaceOrder} */ export type MutationOptions< TData = unknown, @@ -239,10 +210,6 @@ export type MutationOptions< * variables, * } = useMutationHook(); * ``` - * @usedBy - * {@link useLinkAddress} - * - * {@link usePlaceOrder} */ export type MutationResult< TFuncName extends string, diff --git a/packages/sdk-react-provider/tsconfig.json b/packages/sdk-react-provider/tsconfig.json index b6a94a24..617990d5 100644 --- a/packages/sdk-react-provider/tsconfig.json +++ b/packages/sdk-react-provider/tsconfig.json @@ -2,7 +2,8 @@ "extends": "@repo/typescript-config/react-library.json", "compilerOptions": { "outDir": "dist", - "rootDir": "src" + "rootDir": "src", + "types": ["@monerium/sdk"] }, "include": ["src"], "exclude": ["node_modules", "jest.config.js"] diff --git a/packages/sdk-react-provider/typedoc.config.js b/packages/sdk-react-provider/typedoc.config.js deleted file mode 100644 index 5da26a62..00000000 --- a/packages/sdk-react-provider/typedoc.config.js +++ /dev/null @@ -1,92 +0,0 @@ -// typedoc.config.js - -// @ts-check -/** - * @type {import('typedoc').TypeDocOptions} - * @see https://typedoc-plugin-markdown.org/schema.json - */ -module.exports = { - $schema: 'https://typedoc-plugin-markdown.org/schema.json', - - // See: apps/docs/docusaurus.config.js - out: '../../apps/developer/docs/packages/SDK React Provider', - - /** - * # Debugging - * When running `turbo generate-docs` the entryPointStrategy:'Packages' is used, - * which does not support watch. If you need instant feedback while - * writing documentation, run `pnpm typedoc --watch` in that packages directory. - * This will create a `docs` folder in that packages directory that you can view. - */ - - gitRevision: 'main', - plugin: ['typedoc-plugin-markdown'], - - name: 'SDK React Provider', - entryFileName: 'index', - entryPoints: ['src/index.ts'], - tsconfig: 'tsconfig.json', - - excludePrivate: true, - - readme: 'none', - - cleanOutputDir: true, - - kindSortOrder: [ - 'Class', - 'Property', - 'Function', - 'Variable', - 'Interface', - 'TypeAlias', - 'Enum', - 'EnumMember', - 'Document', - ], - groupOrder: [ - 'Provider', - 'Hooks', - 'Constructors', - 'Properties', - 'Classes', - 'Constants', - 'Functions', - 'Variables', - 'Methods', - 'Utils', - 'Interfaces', - 'Type Aliases', - 'Documents', - '*', - ], - categorizeByGroup: true, - categoryOrder: [ - 'Provider', - 'Constructors', - 'Properties', - 'Classes', - 'Variables', - 'Functions', - 'Methods', - 'Interfaces', - 'Type Aliases', - 'Hooks', - 'Documents', - '*', - 'Other', - ], - expandObjects: true, - hideParameterTypesInTitle: true, - expandParameters: true, - - // indexFormat: 'table', - parametersFormat: 'table', - typeDeclarationFormat: 'table', - interfacePropertiesFormat: 'table', - classPropertiesFormat: 'table', - enumMembersFormat: 'table', - propertyMembersFormat: 'table', - - hidePageHeader: true, -}; diff --git a/packages/sdk/src/client.ts b/packages/sdk/src/client.ts index ef25d8d6..109e3534 100644 --- a/packages/sdk/src/client.ts +++ b/packages/sdk/src/client.ts @@ -55,6 +55,31 @@ const { STORAGE_CODE_VERIFIER, STORAGE_REFRESH_TOKEN } = constants; const isServer = typeof window === 'undefined'; +/** + * In the [Monerium UI](https://monerium.app/), create an application to get the `clientId` and register your `redirectUri`. + * ```ts + * import { MoneriumClient } from '@monerium/sdk'; + * + * const monerium = new MoneriumClient() // defaults to `sandbox` + * + * // or + * new MoneriumClient('production') + * + * // or + * new MoneriumClient({ + * environment: 'sandbox', + * clientId: 'your-client-id', + * redirectUri: 'http://your-redirect-url.com/monerium' + * }); + * + * // or - server only + * new MoneriumClient({ + * environment: 'sandbox', + * clientId: 'your-client-id', + * clientSecret: 'your-client-secret' + * }) + *``` + */ export class MoneriumClient { #env: Environment; @@ -73,7 +98,9 @@ export class MoneriumClient { * Sockets will be available after subscribing to an event * */ #sockets?: Map = new Map(); - + /** + * The client is authorized if the bearer profile is available + */ isAuthorized = !!this.bearerProfile; #client?: BearerTokenCredentials; @@ -84,23 +111,6 @@ export class MoneriumClient { /** * @defaultValue `sandbox` - * @example - * const monerium = new MoneriumClient() // defaults to `sandbox` - * // or - * new MoneriumClient('production') - * - * new MoneriumClient({ - * environment: 'sandbox', - * 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 @@ -138,12 +148,15 @@ export class MoneriumClient { } /** + * [API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) + * * Construct the url to the authorization code flow and redirects, * Code Verifier needed for the code challenge is stored in local storage * For automatic wallet link, add the following properties: `address`, `signature` & `chain` + * + * @group Authentication * @returns string - * @category Authentication - * @link [API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth) + * */ async authorize(client?: AuthFlowOptions) { const clientId = @@ -172,11 +185,16 @@ export class MoneriumClient { } /** + * + * * Will redirect to the authorization code flow and store the code verifier in the local storage + * * @param {AuthorizationCodeCredentials | ClientCredentials} client - the client credentials + * * @returns boolean to indicate if access has been granted - * @category Authentication + * * @example + * ```ts * import { MoneriumClient } from '@monerium/sdk'; * // Initialize the client with credentials * const monerium = new MoneriumClient({ @@ -186,6 +204,8 @@ export class MoneriumClient { * }); * * await monerium.getAccess(); + * ``` + * @group Authentication */ async getAccess( client?: AuthorizationCodeCredentials | ClientCredentials @@ -243,7 +263,7 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/auth/operation/auth-token} + * https://monerium.dev/api-docs-v2#tag/auth/operation/auth-token */ async #grantAccess(args: AuthArgs): Promise { let params: @@ -302,32 +322,36 @@ export class MoneriumClient { return this.bearerProfile as BearerProfile; } - // -- Read Methods /** - * # TELL + * [API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile) + * + * @group Profiles * @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}`); } /** - * {@link https://monerium.dev/api-docs-v2#tag/profiles/operation/profiles} - * @category Profiles + * [API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profiles) + * + * @group Profiles */ getProfiles(params?: ProfilesQueryParams): Promise { return this.#api('get', `profiles${queryParams(params)}`); } /** - * # 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. + * + * @group Addresses * @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 + * + * [API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address) + * * @example - * ``` - * monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') + * ```ts + * monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678') * ``` */ getAddress(address: string): Promise
{ @@ -335,10 +359,13 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses} - * @param {string} profile - the id of the profile to filter. - * @param {Chain | ChainId} chain - the chain to filter. - * @category Addresses + * + * [API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses) + * + * @group Addresses + * @param {AddressesQueryParams} params - No required parameters. + * @param {string} params.profile - the id of the profile to filter. + * @param {Chain | ChainId} params.chain - the chain to filter. */ getAddresses({ profile, @@ -352,24 +379,36 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/profile-balances} - * @param {string} profileId - the id of the profile to fetch balances. - * @category Addresses + * + * [API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/profile-balances) + * + * @group Addresses + * @param {string} profile - the id of the profile to fetch balances. + * */ getBalances(profile: string): Promise { return this.#api('get', `profiles/${profile}/balances`); } /** - * {@link "https://monerium.dev/api-docs-v2#tag/ibans/operation/iban"} - * @category IBANs + * Fetch details about a single IBAN + * + * [API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/iban) + * + * @group IBANs + * + * @param {string} iban - the IBAN to fetch. + * */ getIban(iban: string): Promise { return this.#api('get', `ibans/${encodeURI(iban)}`); } /** - * {@link "https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans"} - * @category IBANs + * Fetch all IBANs for the profile + * [API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans) + * + * @group IBANs + * */ getIbans(queryParameters?: IbansQueryParams): Promise { const { profile, chain } = queryParameters || {}; @@ -381,33 +420,37 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/orders} - * @category Orders + * [API Documentation](https://monerium.dev/api-docs-v2#tag/orders) + * + * @group Orders */ getOrders(filter?: OrderFilter): Promise { return this.#api('get', `orders${queryParams(filter)}`); } /** - * {@link https://monerium.dev/api-docs-v2#tag/order} - * @category Orders + * [API Documentation](https://monerium.dev/api-docs-v2#tag/order) + * + * @group Orders */ getOrder(orderId: string): Promise { return this.#api('get', `orders/${orderId}`); } /** - * {@link https://monerium.dev/api-docs-v2#tag/tokens} - * @category Tokens + * [API Documentation](https://monerium.dev/api-docs-v2#tag/tokens) + * + * @group Tokens */ getTokens(): Promise { return this.#api('get', 'tokens'); } - // -- Write Methods - /** - * {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address} - * @category Addresses + * Add a new address to the profile + * [API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/link-address) + * + * @group Addresses + * */ linkAddress(body: LinkAddress): Promise { body = mapChainIdToChain(body); @@ -415,8 +458,9 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/orders/operation/post-orders} - * @category Orders + * [API Documentation](https://monerium.dev/api-docs-v2#tag/orders/operation/post-orders) + * + * @group Orders */ placeOrder(order: NewOrder): Promise { const body = { @@ -432,8 +476,11 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban} - * @category IBANs + * [API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/move-iban) + * + * @group IBANs + * @param {string} iban - the IBAN to move. + * @param {MoveIbanPayload} payload - the payload to move the IBAN. */ moveIban( iban: string, @@ -446,8 +493,12 @@ export class MoneriumClient { ); } /** - * {@link https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban} - * @category IBANs + * [API Documentation](https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban) + * + * @group IBANs + * @param {RequestIbanPayload} payload - the payload to request an IBAN. + * @param {string} payload.address - the address to request the IBAN. + * @param {Chain | ChainId} payload.chain - the chain to request the IBAN. */ requestIban({ address, @@ -462,8 +513,9 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/auth/operation/auth-signup} - * @category Authentication + * [API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth-signup) + * + * @group Authentication */ signUp(body: SignUpPayload): Promise { return this.#api( @@ -474,8 +526,9 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details} - * @category Profiles + * [API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details) + * + * @group Profiles */ submitProfileDetails( profile: string, @@ -489,8 +542,9 @@ export class MoneriumClient { } /** - * {@link https://monerium.dev/api-docs-v2#tag/orders/operation/supporting-document} - * @category Orders + * [API Documentation](https://monerium.dev/api-docs-v2#tag/orders/operation/supporting-document) + * + * @group Orders */ uploadSupportingDocument(document: File): Promise { const formData = new FormData(); @@ -502,8 +556,6 @@ export class MoneriumClient { }); } - // -- Helper Methods - async #api( method: string, resource: string, @@ -580,11 +632,11 @@ export class MoneriumClient { }); }; - // -- Notifications /** * Connects to the order notifications socket - * @category Orders * [Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) + * + * @group Orders */ connectOrderNotifications({ filter, @@ -638,8 +690,9 @@ export class MoneriumClient { /** * Closes the order notifications sockets - * @category Orders * [Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications) + * + * @group Orders */ disconnectOrderNotifications(queryParameters?: OrderNotificationQueryParams) { if (queryParameters) { @@ -664,7 +717,8 @@ export class MoneriumClient { /** * Cleanups the socket and the subscriptions - * @category Authentication + * + * @group Authentication */ async disconnect() { if (!isServer) { @@ -676,7 +730,8 @@ export class MoneriumClient { } /** * Revokes access - * @category Authentication + * + * @group Authentication */ async revokeAccess() { if (!isServer) { @@ -685,12 +740,13 @@ export class MoneriumClient { this.disconnect(); } - // -- Getters (mainly for testing) /** + * * @hidden */ getEnvironment = (): Environment => this.#env; /** + * * @hidden */ getAuthFlowURI = (args: PKCERequestArgs): string => { diff --git a/packages/sdk/src/utils.ts b/packages/sdk/src/utils.ts index 3efd72d1..98a8c048 100644 --- a/packages/sdk/src/utils.ts +++ b/packages/sdk/src/utils.ts @@ -1,5 +1,12 @@ import { Balances, Chain, ChainId, Currency } from './types'; +/** + * + * @param d Date to be formatted + * @returns RFC3339 date format. + * @example 2023-04-30T12:00:00+01:00 + * @example 2023-04-30T02:08:15Z + */ export const rfc3339 = (d: Date) => { if (d.toString() === 'Invalid Date') { throw d; @@ -51,7 +58,19 @@ export const parseChain = (chain: Chain | ChainId) => { * @param currency The currency to be sent * @param receiver The receiver of the funds * @param chain The chainId of the network if it's a cross-chain transaction - * @returns string + * @returns + * cross-chain: + * ```ts + * Send {CURRENCY} {AMOUNT} to {RECEIVER} on {CHAIN} at {DATE}` + * ``` + * + * off-ramp: + * ```ts + * Send {CURRENCY} {AMOUNT} to {RECEIVER} at {DATE} + * ``` + * @example `Send EUR 1 to 0x1234123412341234123412341234123412341234 on ethereum at 2023-04-30T12:00:00+01:00` + * + * @example `Send EUR 1 to IS1234123412341234 at 2023-04-30T12:00:00+01:00` */ export const placeOrderMessage = ( amount: string | number, @@ -87,8 +106,20 @@ export const urlEncoded = ( }; /** - * Get the corresponding Monerium SDK Chain from the current chain id - * @returns The Chain + * This will resolve the chainId number to the corresponding chain name. + * @param chainId The chainId of the network + * @returns chain name + * @example + * ```ts + * getChain(1) // 'ethereum' + * getChain(11155111) // 'ethereum' + * + * getChain(100) // 'gnosis' + * getChain(10200) // 'gnosis' + * + * getChain(137) // 'polygon' + * getChain(80002) // 'polygon' + * ``` */ export const getChain = (chainId: number): Chain => { switch (chainId) { @@ -106,21 +137,6 @@ export const getChain = (chainId: number): Chain => { } }; -// export const getIban = ( -// profile: Profile, -// address: string, -// chain: Chain | ChainId -// ) => { -// return ( -// profile.accounts.find( -// (account) => -// account.address === address && -// account.iban && -// account.chain === parseChain(chain) -// )?.iban ?? '' -// ); -// }; - export const getAmount = ( balances?: Balances[], address?: string, diff --git a/packages/sdk/typedoc.config.js b/packages/sdk/typedoc.config.js deleted file mode 100644 index 09d215c5..00000000 --- a/packages/sdk/typedoc.config.js +++ /dev/null @@ -1,77 +0,0 @@ -// typedoc.config.js - -// @ts-check -/** - * @type {import('typedoc').TypeDocOptions} - * @see https://typedoc-plugin-markdown.org/schema.json - */ -module.exports = { - $schema: 'https://typedoc-plugin-markdown.org/schema.json', - - // See: apps/docs/docusaurus.config.js - out: '../../apps/developer/docs/packages/SDK', - - /** - * # Debugging - * When running `turbo generate-docs` the entryPointStrategy is used, - * which does not support watch. If you need instant feedback while - * writing documentation, run `pnpm typedoc --watch` in that packages directory. - * This will create a `docs` folder in that packages directory that you can view. - */ - - gitRevision: 'main', - plugin: ['typedoc-plugin-markdown'], - - name: 'SDK', - entryFileName: 'index', - entryPoints: ['src/index.ts'], - tsconfig: 'tsconfig.json', - - excludePrivate: true, - - readme: 'none', - - cleanOutputDir: true, - - kindSortOrder: [ - 'Class', - 'Property', - 'Variable', - 'Function', - 'Interface', - 'TypeAlias', - 'Enum', - 'EnumMember', - ], - groupOrder: [ - 'Constructors', - 'Properties', - 'Classes', - 'Constants', - 'Variables', - 'Functions', - 'Methods', - 'Utils', - 'Interfaces', - 'Type Aliases', - '*', - ], - categorizeByGroup: true, - categoryOrder: [ - 'Constructors', - 'Properties', - 'Classes', - 'Variables', - 'Functions', - 'Methods', - 'Interfaces', - 'Type Aliases', - '*', - 'Authorize', - 'Accounts', - 'Profiles', - 'Orders', - 'Tokens', - 'Other', - ], -}; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4a6557ae..0cc83a94 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -58,14 +58,14 @@ importers: specifier: ^8.1.0 version: 8.2.2(jiti@1.21.6)(postcss@8.4.39)(typescript@5.5.3)(yaml@2.4.5) turbo: - specifier: latest - version: 2.0.9 + specifier: ^2.0.14 + version: 2.0.14 typedoc: specifier: ^0.26.4 version: 0.26.5(typescript@5.5.3) typedoc-plugin-markdown: - specifier: ^4.2.1 - version: 4.2.1(typedoc@0.26.5(typescript@5.5.3)) + specifier: ^4.2.5 + version: 4.2.5(typedoc@0.26.5(typescript@5.5.3)) apps/customer: dependencies: @@ -208,7 +208,7 @@ importers: version: 3.4.0(esbuild@0.23.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) docusaurus-plugin-typedoc: specifier: ^1.0.4 - version: 1.0.4(typedoc-plugin-markdown@4.2.1(typedoc@0.26.5(typescript@5.2.2))) + version: 1.0.4(typedoc-plugin-markdown@4.2.5(typedoc@0.26.5(typescript@5.2.2))) typescript: specifier: ~5.2.2 version: 5.2.2 @@ -9812,38 +9812,38 @@ packages: peerDependencies: typescript: '>=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta' - turbo-darwin-64@2.0.9: - resolution: {integrity: sha512-owlGsOaExuVGBUfrnJwjkL1BWlvefjSKczEAcpLx4BI7Oh6ttakOi+JyomkPkFlYElRpjbvlR2gP8WIn6M/+xQ==} + turbo-darwin-64@2.0.14: + resolution: {integrity: sha512-kwfDmjNwlNfvtrvT29+ZBg5n1Wvxl891bFHchMJyzMoR0HOE9N1NSNdSZb9wG3e7sYNIu4uDkNk+VBEqJW0HzQ==} cpu: [x64] os: [darwin] - turbo-darwin-arm64@2.0.9: - resolution: {integrity: sha512-XAXkKkePth5ZPPE/9G9tTnPQx0C8UTkGWmNGYkpmGgRr8NedW+HrPsi9N0HcjzzIH9A4TpNYvtiV+WcwdaEjKA==} + turbo-darwin-arm64@2.0.14: + resolution: {integrity: sha512-m3LXYEshCx3wc4ZClM6gb01KYpFmtjQ9IBF3A7ofjb6ahux3xlYZJZ3uFCLAGHuvGLuJ3htfiPbwlDPTdknqqw==} cpu: [arm64] os: [darwin] - turbo-linux-64@2.0.9: - resolution: {integrity: sha512-l9wSgEjrCFM1aG16zItBsZ206ZlhSSx1owB8Cgskfv0XyIXRGHRkluihiaxkp+UeU5WoEfz4EN5toc+ICA0q0w==} + turbo-linux-64@2.0.14: + resolution: {integrity: sha512-7vBzCPdoTtR92SNn2JMgj1FlMmyonGmpMaQdgAB1OVYtuQ6NVGoh7/lODfaILqXjpvmFSVbpBIDrKOT6EvcprQ==} cpu: [x64] os: [linux] - turbo-linux-arm64@2.0.9: - resolution: {integrity: sha512-gRnjxXRne18B27SwxXMqL3fJu7jw/8kBrOBTBNRSmZZiG1Uu3nbnP7b4lgrA/bCku6C0Wligwqurvtpq6+nFHA==} + turbo-linux-arm64@2.0.14: + resolution: {integrity: sha512-jwH+c0bfjpBf26K/tdEFatmnYyXwGROjbr6bZmNcL8R+IkGAc/cglL+OToqJnQZTgZvH7uDGbeSyUo7IsHyjuA==} cpu: [arm64] os: [linux] - turbo-windows-64@2.0.9: - resolution: {integrity: sha512-ZVo0apxUvaRq4Vm1qhsfqKKhtRgReYlBVf9MQvVU1O9AoyydEQvLDO1ryqpXDZWpcHoFxHAQc9msjAMtE5K2lA==} + turbo-windows-64@2.0.14: + resolution: {integrity: sha512-w9/XwkHSzvLjmioo6cl3S1yRfI6swxsV1j1eJwtl66JM4/pn0H2rBa855R0n7hZnmI6H5ywLt/nLt6Ae8RTDmw==} cpu: [x64] os: [win32] - turbo-windows-arm64@2.0.9: - resolution: {integrity: sha512-sGRz7c5Pey6y7y9OKi8ypbWNuIRPF9y8xcMqL56OZifSUSo+X2EOsOleR9MKxQXVaqHPGOUKWsE6y8hxBi9pag==} + turbo-windows-arm64@2.0.14: + resolution: {integrity: sha512-XaQlyYk+Rf4xS5XWCo8XCMIpssgGGy8blzLfolN6YBp4baElIWMlkLZHDbGyiFmCbNf9I9gJI64XGRG+LVyyjA==} cpu: [arm64] os: [win32] - turbo@2.0.9: - resolution: {integrity: sha512-QaLaUL1CqblSKKPgLrFW3lZWkWG4pGBQNW+q1ScJB5v1D/nFWtsrD/yZljW/bdawg90ihi4/ftQJ3h6fz1FamA==} + turbo@2.0.14: + resolution: {integrity: sha512-00JjdCMD/cpsjP0Izkjcm8Oaor5yUCfDwODtaLb+WyblyadkaDEisGhy3Dbd5az9n+5iLSPiUgf+WjPbns6MRg==} hasBin: true type-check@0.4.0: @@ -9905,8 +9905,8 @@ packages: typedarray-to-buffer@3.1.5: resolution: {integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==} - typedoc-plugin-markdown@4.2.1: - resolution: {integrity: sha512-7hQt/1WaW/VI4+x3sxwcCGsEylP1E1GvF6OTTELK5sfTEp6AeK+83jkCOgZGp1pI2DiOammMYQMnxxOny9TKsQ==} + typedoc-plugin-markdown@4.2.5: + resolution: {integrity: sha512-ZWIfc0OqwEtQfuaqbmM1kesMi/Fhc++W+5f3TDEm1Tsi28pHSoZk4WCOm4lNuN30WtEImwAHhhXC4DIWki1DiA==} engines: {node: '>= 18'} peerDependencies: typedoc: 0.26.x @@ -16794,9 +16794,9 @@ snapshots: dependencies: esutils: 2.0.3 - docusaurus-plugin-typedoc@1.0.4(typedoc-plugin-markdown@4.2.1(typedoc@0.26.5(typescript@5.2.2))): + docusaurus-plugin-typedoc@1.0.4(typedoc-plugin-markdown@4.2.5(typedoc@0.26.5(typescript@5.2.2))): dependencies: - typedoc-plugin-markdown: 4.2.1(typedoc@0.26.5(typescript@5.2.2)) + typedoc-plugin-markdown: 4.2.5(typedoc@0.26.5(typescript@5.2.2)) dom-accessibility-api@0.5.16: {} @@ -23095,32 +23095,32 @@ snapshots: tslib: 1.14.1 typescript: 5.5.3 - turbo-darwin-64@2.0.9: + turbo-darwin-64@2.0.14: optional: true - turbo-darwin-arm64@2.0.9: + turbo-darwin-arm64@2.0.14: optional: true - turbo-linux-64@2.0.9: + turbo-linux-64@2.0.14: optional: true - turbo-linux-arm64@2.0.9: + turbo-linux-arm64@2.0.14: optional: true - turbo-windows-64@2.0.9: + turbo-windows-64@2.0.14: optional: true - turbo-windows-arm64@2.0.9: + turbo-windows-arm64@2.0.14: optional: true - turbo@2.0.9: + turbo@2.0.14: optionalDependencies: - turbo-darwin-64: 2.0.9 - turbo-darwin-arm64: 2.0.9 - turbo-linux-64: 2.0.9 - turbo-linux-arm64: 2.0.9 - turbo-windows-64: 2.0.9 - turbo-windows-arm64: 2.0.9 + turbo-darwin-64: 2.0.14 + turbo-darwin-arm64: 2.0.14 + turbo-linux-64: 2.0.14 + turbo-linux-arm64: 2.0.14 + turbo-windows-64: 2.0.14 + turbo-windows-arm64: 2.0.14 type-check@0.4.0: dependencies: @@ -23183,11 +23183,11 @@ snapshots: dependencies: is-typedarray: 1.0.0 - typedoc-plugin-markdown@4.2.1(typedoc@0.26.5(typescript@5.2.2)): + typedoc-plugin-markdown@4.2.5(typedoc@0.26.5(typescript@5.2.2)): dependencies: typedoc: 0.26.5(typescript@5.2.2) - typedoc-plugin-markdown@4.2.1(typedoc@0.26.5(typescript@5.5.3)): + typedoc-plugin-markdown@4.2.5(typedoc@0.26.5(typescript@5.5.3)): dependencies: typedoc: 0.26.5(typescript@5.5.3) diff --git a/turbo.json b/turbo.json index 900f2bdf..6ee0b5eb 100644 --- a/turbo.json +++ b/turbo.json @@ -11,20 +11,12 @@ "outputs": [".next/**", "!.next/cache/**", "dist/**"], "env": ["STANDALONE", "false"] }, - "@monerium/sdk#docs": { - "dependsOn": ["@monerium/sdk#build"], - "outputs": ["docs/generated/**"] - }, - "@monerium/sdk#docs:watch": { - "dependsOn": ["@monerium/sdk#build"], - "outputs": ["docs/generated/**"] - }, "@monerium/sdk-react-provider#dev": { "dependsOn": ["@monerium/sdk#type-map"] }, "generate-docs": { "dependsOn": ["build"], - "outputs": ["apps/developer/docs/packages/**"] + "outputs": ["docs/packages/**"] }, "lint": {}, "lint:style": {},