Skip to content

Commit ffeefd2

Browse files
committed
chore: update docs
1 parent 90e8639 commit ffeefd2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+266
-266
lines changed

packages/sdk-react-provider/src/lib/provider.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { AuthorizeParams } from './types';
1212
* @param params
1313
* @param params.children - Rest of the application.
1414
* @param params.clientId - Monerium auth flow client id.
15-
* @param params.redirectUrl - Monerium auth flow redirect url.
15+
* @param params.redirectUri - Monerium auth flow redirect url.
1616
* @param params.environment - Monerium environment.
1717
* @returns
1818
*/

packages/sdk/docs/generated/classes/MoneriumClient.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ new MoneriumClient({
4040

4141
#### Defined in
4242

43-
[client.ts:90](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L90)
43+
[client.ts:90](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L90)
4444

4545
## Properties
4646

@@ -52,7 +52,7 @@ The bearer profile will be available after authentication, it includes the `acce
5252

5353
#### Defined in
5454

55-
[client.ts:61](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L61)
55+
[client.ts:61](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L61)
5656

5757
***
5858

@@ -62,7 +62,7 @@ The bearer profile will be available after authentication, it includes the `acce
6262
6363
#### Defined in
6464

65-
[client.ts:69](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L69)
65+
[client.ts:69](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L69)
6666

6767
***
6868

@@ -74,7 +74,7 @@ The state parameter is used to maintain state between the request and the callba
7474

7575
#### Defined in
7676

77-
[client.ts:75](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L75)
77+
[client.ts:75](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L75)
7878

7979
## Methods
8080

@@ -101,7 +101,7 @@ string
101101

102102
##### Defined in
103103

104-
[client.ts:130](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L130)
104+
[client.ts:130](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L130)
105105

106106
***
107107

@@ -117,7 +117,7 @@ Cleanups the socket and the subscriptions
117117

118118
##### Defined in
119119

120-
[client.ts:515](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L515)
120+
[client.ts:515](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L515)
121121

122122
***
123123

@@ -141,7 +141,7 @@ boolean to indicate if access has been granted
141141

142142
##### Defined in
143143

144-
[client.ts:166](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L166)
144+
[client.ts:166](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L166)
145145

146146
***
147147

@@ -157,7 +157,7 @@ boolean to indicate if access has been granted
157157

158158
##### Defined in
159159

160-
[client.ts:288](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L288)
160+
[client.ts:288](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L288)
161161

162162
***
163163

@@ -173,7 +173,7 @@ Revokes access
173173

174174
##### Defined in
175175

176-
[client.ts:528](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L528)
176+
[client.ts:528](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L528)
177177

178178
### Accounts
179179

@@ -195,7 +195,7 @@ the id of the profile to fetch balances.
195195

196196
##### Defined in
197197

198-
[client.ts:312](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L312)
198+
[client.ts:312](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L312)
199199

200200
***
201201

@@ -217,7 +217,7 @@ the id of the profile to fetch balances.
217217

218218
##### Defined in
219219

220-
[client.ts:351](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L351)
220+
[client.ts:351](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L351)
221221

222222
### Profiles
223223

@@ -239,7 +239,7 @@ the id of the profile to fetch.
239239

240240
##### Defined in
241241

242-
[client.ts:297](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L297)
242+
[client.ts:297](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L297)
243243

244244
***
245245

@@ -255,7 +255,7 @@ the id of the profile to fetch.
255255

256256
##### Defined in
257257

258-
[client.ts:304](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L304)
258+
[client.ts:304](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L304)
259259

260260
### Orders
261261

@@ -271,7 +271,7 @@ Connects to the order notifications socket
271271

272272
##### Defined in
273273

274-
[client.ts:472](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L472)
274+
[client.ts:472](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L472)
275275

276276
***
277277

@@ -291,7 +291,7 @@ Connects to the order notifications socket
291291

292292
##### Defined in
293293

294-
[client.ts:333](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L333)
294+
[client.ts:333](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L333)
295295

296296
***
297297

@@ -311,7 +311,7 @@ Connects to the order notifications socket
311311

312312
##### Defined in
313313

314-
[client.ts:324](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L324)
314+
[client.ts:324](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L324)
315315

316316
***
317317

@@ -331,7 +331,7 @@ Connects to the order notifications socket
331331

332332
##### Defined in
333333

334-
[client.ts:366](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L366)
334+
[client.ts:366](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L366)
335335

336336
***
337337

@@ -359,7 +359,7 @@ The handler to be called when the event is triggered
359359

360360
##### Defined in
361361

362-
[client.ts:544](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L544)
362+
[client.ts:544](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L544)
363363

364364
***
365365

@@ -375,7 +375,7 @@ Subscribes to the order notifications socket
375375

376376
##### Defined in
377377

378-
[client.ts:483](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L483)
378+
[client.ts:483](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L483)
379379

380380
***
381381

@@ -397,7 +397,7 @@ The event to unsubscribe from
397397

398398
##### Defined in
399399

400-
[client.ts:553](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L553)
400+
[client.ts:553](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L553)
401401

402402
***
403403

@@ -417,7 +417,7 @@ The event to unsubscribe from
417417

418418
##### Defined in
419419

420-
[client.ts:383](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L383)
420+
[client.ts:383](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L383)
421421

422422
### Tokens
423423

@@ -433,4 +433,4 @@ The event to unsubscribe from
433433

434434
##### Defined in
435435

436-
[client.ts:341](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/client.ts#L341)
436+
[client.ts:341](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/client.ts#L341)

packages/sdk/docs/generated/enumerations/AccountState.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:221](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L221)
17+
[types.ts:221](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L221)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:222](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L222)
27+
[types.ts:222](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L222)
2828

2929
***
3030

@@ -34,4 +34,4 @@
3434
3535
#### Defined in
3636

37-
[types.ts:220](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L220)
37+
[types.ts:220](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L220)

packages/sdk/docs/generated/enumerations/Currency.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:69](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L69)
17+
[types.ts:69](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L69)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:71](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L71)
27+
[types.ts:71](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L71)
2828

2929
***
3030

@@ -34,7 +34,7 @@
3434
3535
#### Defined in
3636

37-
[types.ts:72](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L72)
37+
[types.ts:72](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L72)
3838

3939
***
4040

@@ -44,4 +44,4 @@
4444
4545
#### Defined in
4646

47-
[types.ts:70](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L70)
47+
[types.ts:70](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L70)

packages/sdk/docs/generated/enumerations/KYCOutcome.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:214](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L214)
17+
[types.ts:214](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L214)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:215](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L215)
27+
[types.ts:215](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L215)
2828

2929
***
3030

@@ -34,4 +34,4 @@
3434
3535
#### Defined in
3636

37-
[types.ts:216](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L216)
37+
[types.ts:216](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L216)

packages/sdk/docs/generated/enumerations/KYCState.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:207](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L207)
17+
[types.ts:207](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L207)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:210](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L210)
27+
[types.ts:210](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L210)
2828

2929
***
3030

@@ -34,7 +34,7 @@
3434
3535
#### Defined in
3636

37-
[types.ts:209](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L209)
37+
[types.ts:209](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L209)
3838

3939
***
4040

@@ -44,4 +44,4 @@
4444
4545
#### Defined in
4646

47-
[types.ts:208](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L208)
47+
[types.ts:208](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L208)

packages/sdk/docs/generated/enumerations/Method.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:174](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L174)
17+
[types.ts:174](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L174)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:173](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L173)
27+
[types.ts:173](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L173)
2828

2929
***
3030

@@ -34,7 +34,7 @@
3434
3535
#### Defined in
3636

37-
[types.ts:171](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L171)
37+
[types.ts:171](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L171)
3838

3939
***
4040

@@ -44,4 +44,4 @@
4444
4545
#### Defined in
4646

47-
[types.ts:172](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L172)
47+
[types.ts:172](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L172)

packages/sdk/docs/generated/enumerations/OrderKind.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:281](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L281)
17+
[types.ts:281](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L281)
1818

1919
***
2020

@@ -24,4 +24,4 @@
2424
2525
#### Defined in
2626

27-
[types.ts:280](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L280)
27+
[types.ts:280](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L280)

packages/sdk/docs/generated/enumerations/OrderState.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
#### Defined in
1616

17-
[types.ts:286](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L286)
17+
[types.ts:286](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L286)
1818

1919
***
2020

@@ -24,7 +24,7 @@
2424
2525
#### Defined in
2626

27-
[types.ts:285](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L285)
27+
[types.ts:285](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L285)
2828

2929
***
3030

@@ -34,7 +34,7 @@
3434
3535
#### Defined in
3636

37-
[types.ts:287](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L287)
37+
[types.ts:287](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L287)
3838

3939
***
4040

@@ -44,4 +44,4 @@
4444
4545
#### Defined in
4646

47-
[types.ts:288](https://github.com/monerium/js-monorepo/blob/4f2ccbbab3654810f24287d973126d95378140bb/packages/sdk/src/types.ts#L288)
47+
[types.ts:288](https://github.com/monerium/js-monorepo/blob/90e863940da8623462a29ce3ac59bdfdcf20271e/packages/sdk/src/types.ts#L288)

0 commit comments

Comments
 (0)