-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
128 changed files
with
1,944 additions
and
1,439 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 0 additions & 12 deletions
12
packages/sdk-react-provider/docs/generated/enumerations/OrderState.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
packages/sdk-react-provider/docs/generated/functions/useAddress.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| [Monerium SDK React Provider](../README.md) / useAddress | ||
|
|
||
| # Function: useAddress() | ||
|
|
||
| > **useAddress**(`params`: \{`address`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"address"`, `Address`\> | ||
| # Get address | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | ---------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | ||
| | `params` | `object` | | | ||
| | `params.address` | `string` | Fetch a specific address. | | ||
| | `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`Address`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. | | ||
|
|
||
| ## Returns | ||
|
|
||
| [`QueryResult`](../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) |
43 changes: 43 additions & 0 deletions
43
packages/sdk-react-provider/docs/generated/functions/useAddresses.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| [Monerium SDK React Provider](../README.md) / useAddresses | ||
|
|
||
| # Function: useAddresses() | ||
|
|
||
| > **useAddresses**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\> | ||
| # Get addresses | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | ||
| | `params`? | `object` | 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`](../type-aliases/QueryOptions.md)\<`Address`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. | | ||
|
|
||
| ## Returns | ||
|
|
||
| [`QueryResult`](../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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 0 additions & 41 deletions
41
packages/sdk-react-provider/docs/generated/functions/useAuthContext.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
packages/sdk-react-provider/docs/generated/functions/useIBAN.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| [Monerium SDK React Provider](../README.md) / useIBAN | ||
|
|
||
| # Function: useIBAN() | ||
|
|
||
| > **useIBAN**(`params`: \{`iban`: `string`;`query`: [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\>; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\> | ||
| # Get IBAN | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | --------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | ||
| | `params` | `object` | | | ||
| | `params.iban` | `string` | - | | ||
| | `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. | | ||
|
|
||
| ## Returns | ||
|
|
||
| [`QueryResult`](../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) |
43 changes: 43 additions & 0 deletions
43
packages/sdk-react-provider/docs/generated/functions/useIBANs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| [Monerium SDK React Provider](../README.md) / useIBANs | ||
|
|
||
| # Function: useIBANs() | ||
|
|
||
| > **useIBANs**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\> | ||
| # Get IBANs | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | ----------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | ||
| | `params`? | `object` | 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`](../type-aliases/QueryOptions.md)\<`IBAN`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. | | ||
|
|
||
| ## Returns | ||
|
|
||
| [`QueryResult`](../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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.