Skip to content

Commit

Permalink
docs: wip
Browse files Browse the repository at this point in the history
  • Loading branch information
einaralex committed Aug 23, 2024
1 parent eead166 commit e884ddc
Show file tree
Hide file tree
Showing 42 changed files with 218 additions and 175 deletions.
80 changes: 51 additions & 29 deletions apps/developer/docs/packages/SDK/classes/MoneriumClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,27 @@
#### Example

```ts
new MoneriumClient() // defaults to `sandbox`

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'
})
```

#### Defined in

[client.ts:98](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L98)
[client.ts:105](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L105)

## Properties

Expand Down Expand Up @@ -78,21 +85,29 @@ The state parameter is used to maintain state between the request and the callba

> **getAddress**(`address`): `Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\>
[https://monerium.dev/api-docs-v2#tag/addresses/operation/address](https://monerium.dev/api-docs-v2#tag/addresses/operation/address)
# Get a single address
Get details for a single address by using the address public key after the address has been successfully linked to Monerium.

##### Parameters

**address**: `string`

The public key of the blockchain account.
[API Documentation](https://monerium.dev/api-docs-v2#tag/addresses/operation/address)

##### Returns

`Promise`\<[`Address`](/docs/packages/SDK/interfaces/Address.md)\>

##### Example

```
monerium.getAddress('0x1234567890abcdef1234567890abcdef12345678')
```

##### Defined in

[client.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L319)
[client.ts:333](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L333)

***

Expand All @@ -112,7 +127,7 @@ The public key of the blockchain account.

##### Defined in

[client.ts:329](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L329)
[client.ts:343](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L343)

***

Expand All @@ -132,7 +147,7 @@ The public key of the blockchain account.

##### Defined in

[client.ts:345](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L345)
[client.ts:359](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L359)

***

Expand All @@ -152,7 +167,7 @@ The public key of the blockchain account.

##### Defined in

[client.ts:398](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L398)
[client.ts:412](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L412)

### Authentication

Expand All @@ -173,11 +188,14 @@ For automatic wallet link, add the following properties: `address`, `signature`
`Promise`\<`void`\>

string
[https://monerium.dev/api-docs-v2#tag/auth/operation/auth](https://monerium.dev/api-docs-v2#tag/auth/operation/auth)

##### Link

[API Documentation](https://monerium.dev/api-docs-v2#tag/auth/operation/auth)

##### Defined in

[client.ts:141](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L141)
[client.ts:148](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L148)

***

Expand All @@ -193,7 +211,7 @@ Cleanups the socket and the subscriptions

##### Defined in

[client.ts:655](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L655)
[client.ts:669](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L669)

***

Expand Down Expand Up @@ -231,7 +249,7 @@ await monerium.getAccess();

##### Defined in

[client.ts:183](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L183)
[client.ts:190](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L190)

***

Expand All @@ -247,7 +265,7 @@ Revokes access

##### Defined in

[client.ts:667](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L667)
[client.ts:681](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L681)

***

Expand All @@ -267,7 +285,7 @@ Revokes access

##### Defined in

[client.ts:454](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L454)
[client.ts:468](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L468)

### IBANs

Expand All @@ -287,7 +305,7 @@ Revokes access

##### Defined in

[client.ts:353](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L353)
[client.ts:367](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L367)

***

Expand All @@ -307,7 +325,7 @@ Revokes access

##### Defined in

[client.ts:360](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L360)
[client.ts:374](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L374)

***

Expand All @@ -329,7 +347,7 @@ Revokes access

##### Defined in

[client.ts:424](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L424)
[client.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L438)

***

Expand All @@ -349,7 +367,7 @@ Revokes access

##### Defined in

[client.ts:438](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L438)
[client.ts:452](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L452)

### Orders
[Websocket](https://monerium.dev/api-docs-v2#tag/orders/operation/orders-notifications)
Expand All @@ -376,7 +394,7 @@ Connects to the order notifications socket

##### Defined in

[client.ts:575](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L575)
[client.ts:589](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L589)

***

Expand All @@ -396,15 +414,15 @@ Closes the order notifications sockets

##### Defined in

[client.ts:630](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L630)
[client.ts:644](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L644)

### Profiles

#### getProfile()

> **getProfile**(`profile`): `Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\>
[https://monerium.dev/api-docs-v2#tag/profiles/operation/profile](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile)
# TELL

##### Parameters

Expand All @@ -416,9 +434,13 @@ the id of the profile to fetch.

`Promise`\<[`Profile`](/docs/packages/SDK/interfaces/Profile.md)\>

##### Link

[API Documentation](https://monerium.dev/api-docs-v2#tag/profiles/operation/profile)

##### Defined in

[client.ts:304](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L304)
[client.ts:312](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L312)

***

Expand All @@ -438,7 +460,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:311](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L311)
[client.ts:319](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L319)

***

Expand All @@ -460,7 +482,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:466](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L466)
[client.ts:480](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L480)

### Orders

Expand All @@ -480,7 +502,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:380](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L380)
[client.ts:394](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L394)

***

Expand All @@ -500,7 +522,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:373](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L373)
[client.ts:387](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L387)

***

Expand All @@ -520,7 +542,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:407](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L407)
[client.ts:421](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L421)

***

Expand All @@ -540,7 +562,7 @@ the id of the profile to fetch.

##### Defined in

[client.ts:481](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L481)
[client.ts:495](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L495)

### Tokens

Expand All @@ -556,4 +578,4 @@ the id of the profile to fetch.

##### Defined in

[client.ts:388](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L388)
[client.ts:402](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/client.ts#L402)
4 changes: 2 additions & 2 deletions apps/developer/docs/packages/SDK/enumerations/OrderKind.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#### Defined in

[types.ts:306](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L306)
[types.ts:309](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L309)

***

Expand All @@ -18,4 +18,4 @@
#### Defined in

[types.ts:305](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L305)
[types.ts:308](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L308)
8 changes: 4 additions & 4 deletions apps/developer/docs/packages/SDK/enumerations/OrderState.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#### Defined in

[types.ts:311](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L311)
[types.ts:314](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L314)

***

Expand All @@ -18,7 +18,7 @@
#### Defined in

[types.ts:310](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L310)
[types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313)

***

Expand All @@ -28,7 +28,7 @@
#### Defined in

[types.ts:312](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L312)
[types.ts:315](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L315)

***

Expand All @@ -38,4 +38,4 @@
#### Defined in

[types.ts:313](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L313)
[types.ts:316](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L316)
10 changes: 7 additions & 3 deletions apps/developer/docs/packages/SDK/interfaces/Address.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@

> **address**: `string`
The address

#### Defined in

[types.ts:281](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L281)
[types.ts:284](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L284)

***

Expand All @@ -18,14 +20,16 @@
#### Defined in

[types.ts:282](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L282)
[types.ts:285](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L285)

***

### profile

> **profile**: `string`
The id of the profile.

#### Defined in

[types.ts:280](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L280)
[types.ts:281](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L281)
2 changes: 1 addition & 1 deletion apps/developer/docs/packages/SDK/interfaces/Addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
#### Defined in

[types.ts:286](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L286)
[types.ts:289](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/src/types.ts#L289)
Loading

0 comments on commit e884ddc

Please sign in to comment.