@monerium/sdk 2.6.0 → 2.6.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.6.3](https://github.com/monerium/sdk/compare/v2.6.2...v2.6.3) (2023-10-18)
+
+
+### Bug Fixes
+
+* tests ([6be0014](https://github.com/monerium/sdk/commit/6be00148724942bdca74bbeea961b8b33bcd80f7))
+
+## [2.6.2](https://github.com/monerium/sdk/compare/v2.6.1...v2.6.2) (2023-10-18)
+
+
+### Bug Fixes
+
+* add missing info from README [no-ci] ([600bda5](https://github.com/monerium/sdk/commit/600bda52f9d8b61aa47222ace5308d3087e674e5))
+* **docs:** add source code link to README ([c2a9294](https://github.com/monerium/sdk/commit/c2a9294f49e60ba9fd9373d94ec6069b6b559fb0))
+* revert changes to action ([36eada9](https://github.com/monerium/sdk/commit/36eada92b89b9bf1de0659f74479d27b58697975))
+* update docs on every push to main ([e0f57e6](https://github.com/monerium/sdk/commit/e0f57e61312a5fce0d02608eed6fc7c5aaba5b09))
+
+## [2.6.1](https://github.com/monerium/sdk/compare/v2.6.0...v2.6.1) (2023-09-11)
+
+
+### Bug Fixes
+
+* add info how to set environment ([c803cc5](https://github.com/monerium/sdk/commit/c803cc579ea11006ab845d4a4790e2a9bffae0b0))
+
 ## [2.6.0](https://github.com/monerium/sdk/compare/v2.5.2...v2.6.0) (2023-07-19)
 
 

package/README.md

@@ -5,6 +5,8 @@ Everything you need to interact with the [Monerium API](https://monerium.dev/api
 _This package is in development. Please make sure to check if any future updates contain commits
 that may change the behavior of your application before you upgrade._
 
+[Source code](https://github.com/monerium/sdk)
+
 [SDK Documentation](https://monerium.github.io/sdk/)
 
 [Code coverage](https://monerium.github.io/sdk/coverage)
@@ -37,14 +39,16 @@ networks: `mainnet`, `mainnet`, `mainnet`.
 
 ## Getting started
 
-If you are new here, we recommend starting in the [Developer Portal](https://monerium.dev/docs/welcome). There you will more about `client_id`'s and ways of authenticating.
+We recommend starting in the [Developer Portal](https://monerium.dev/docs/welcome). There you will learn more about `client_id`'s and ways of authenticating.
 
 ### Import the SDK and initialize a client
 
 ```ts
 import { MoneriumClient } from '@monerium/sdk';
 
-const client = new MoneriumClient();
+// By default, the client will use the sandbox environment.
+// To change to production, pass "production" as the first argument.
+const client = new MoneriumClient('sandbox');
 ```
 
 ### Authenticate using client credentials
@@ -57,6 +61,9 @@ await client.auth({
 
 // User is now authenticated, get authentication data
 await client.getAuthContext()
+
+// You can now find your access and refresh token here:
+const { access_token, refresh_token } = client.bearerProfile;
 ```
 
 ### Authenticate using auth flow
@@ -64,7 +71,8 @@ await client.getAuthContext()
 ```ts
 // Construct the authFlowUrl for your application and redirect your customer.
 let authFlowUrl = client.getAuthFlowURI({
-  client_id: "your_client_authflow_uuid"
+  client_id: "your_client_authflow_uuid",
+  redirect_uri: "http://your-webpage.com/monerium-integration"
   // optional automatic wallet selection:
   network: "mumbai",
   chain: "polygon",
@@ -91,6 +99,9 @@ await client.auth({
 
 // User is now authenticated, get authentication data
 await client.getAuthContext();
+
+// You can now find your access and refresh token here:
+const { access_token, refresh_token } = client.bearerProfile;
 ```
 
 ## Contributing
@@ -112,10 +123,10 @@ yarn dlx @yarnpkg/sdks vscode
 
 For development, a package can be linked into another project. This is often useful to test out new features or when trying to debug an issue in a package that manifests itself in another project. run yarn link inside of the sdk project.
 
-
 ```sh
 YARN_IGNORE_PATH=1 yarn link
 ```
+
 Use `yarn link "@monerium/sdk"` to link and test into your current project.
 
 ```sh
@@ -123,7 +134,6 @@ cd ../your-project
 yarn link "@monerium/sdk"
 ```
 
-
 ## Publishing
 
 When changes are merged to the `main` branch that follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, [release-please](https://github.com/googleapis/release-please) workflow creates a pull request, preparing for the next release. If kept open, the following commits will also be added to the PR. Merging that PR will create a new release, a workflow will publish it on NPM and tag it on Github.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monerium/sdk",
-  "version": "2.6.0",
+  "version": "2.6.3",
   "description": "Everything you need to interact with the Monerium API - an electronic money issuer.",
   "license": "MIT",
   "repository": {