chore: self-custody restructuring (#153)

* chore: self-custody restructuring * chore: write a better intro for self-custody or managed * chore: wording * chore: add .idea to gitignore * chore: remove 'we' * chore: grammar * fix: path to self-custody Implementation page * chore: rename to match other files * chore: grammar, c# unity example * chore: add swagger link to getOperation, update unity samples * fix: unity sample of signing operation * chore: grammar, unity examples * chore: fix var name * chore: grammar, typos * chore: update urls * chore: update urls * chore: change titles * chore: update npm package url * chore: updated urls to nuget * chore: update the sdk page --------- Co-authored-by: lewinskimaciej <[email protected]>
BuildOnBeam · Jun 5, 2024 · 9cd811e · 9cd811e
1 parent 241b76a
commit 9cd811e
Show file tree

Hide file tree

Showing 47 changed files with 414 additions and 437 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@ node_modules
 .vercel
 
 .env
+
+.idea
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ If you would like to get your hands dirty without reading our documentation, we
 ## Getting started
 
 ```typescript
-import { Beam } from "@onbeam/node";
+import { Beam } from "@onbeam/automation-api-client";
 
 const beam = new Beam("x-api-key");
 
@@ -50,7 +50,7 @@ In this example, we initialize an instance of Beam by passing your api key. We t
 Profiles are managed by you, and through your api key you are able to transfer / trade and manage assets of the profiles of your users
 
 ```typescript
-import { Beam } from "@onbeam/node";
+import { Beam } from "@onbeam/automation-api-client";
 
 const beam = new Beam("x-api-key");
 

diff --git a/pages/service/_meta.json b/pages/service/_meta.json
@@ -1,51 +1,58 @@
 {
+  "--- Beam": {
+    "type": "separator",
+    "title": "Beam"
+  },
   "index": "Getting started",
-  "--- Self-custody (Beta)": {
+  "managed-or-self-custody": {
+    "title": "Player or Automation API"
+  },
+  "game": {
+    "title": "Managing your game"
+  },
+  "--- Player API (Beta)": {
     "type": "separator",
-    "title": "Self-custody (beta)"
+    "title": "Player API (beta)"
   },
-  "self-custody": {
-    "title": "Getting started"
+  "introduction-self-custody": {
+    "title": "Introduction"
+  },
+  "implementation-self-custody": {
+    "title": "Implementation"
   },
   "operations": {
     "title": "Operations (beta)"
   },
   "sessions": {
     "title": "Sessions (beta)"
   },
-  "--- Guides": {
-    "type": "separator",
-    "title": "Guides"
-  },
-  "game": {
-    "title": "Managing your game"
-  },
-  "profiles": {
-    "title": "Profiles"
-  },
   "transactions": {
     "title": "Transactions"
   },
-  "policies": {
-    "title": "Policies"
-  },
   "assets": {
     "title": "Assets"
   },
-  "trading": {
-    "title": "Trading"
-  },
   "marketplace": {
     "title": "Marketplace"
   },
   "exchange": {
     "title": "Exchange"
   },
-  "companion": {
-    "title": "Companion"
+  "--- Automation API": {
+    "type": "separator",
+    "title": "Automation API"
   },
-  "sphere": {
-    "title": "Sphere"
+  "introduction-managed": {
+    "title": "Introduction"
+  },
+  "profiles": {
+    "title": "Profiles"
+  },
+  "policies": {
+    "title": "Policies"
+  },
+  "trading": {
+    "title": "Trading"
   },
   "reporting": {
     "title": "Reporting"
@@ -59,13 +66,20 @@
   },
   "environments": "",
   "full-api-reference": "",
+  "--- Ecosystem": {
+    "type": "separator",
+    "title": "Ecosystem"
+  },
+  "sphere": {
+    "title": "Sphere"
+  },
+  "companion": {
+    "title": "Companion"
+  },
   "--- More": {
     "type": "separator",
     "title": "More"
   },
-  "roadmap": {
-    "title": "Roadmap"
-  },
   "terms-of-service": {
     "title": "Terms of Service"
   },

diff --git a/pages/service/assets/introduction.mdx b/pages/service/assets/introduction.mdx
@@ -10,11 +10,6 @@ Asset management is a crucial part of the Beam integration within your game. Dep
 
 By providing these options through the sdk, you are able to create a frictionless in-game marketplace built on beam without having to worry about creating infrastructure to support it.
 
-### Roadmap
-
-Throughout the coming months, we'll be releasing additional features that will help you to provide a more complete marketplace experience, with features ranging from programmatic offers, auctions and extensive filtering options to allow you to create a full-fledged in-game marketplace solely by relying on the Beam marketplace.
-
 <Callout emoji="🛠️">
-  Feel like something is missing, and needs to be prioritized? Check out our
-  [2024 roadmap](/service/roadmap) or let's have a chat through [email protected]
+  Feel like something is missing, and needs to be prioritized? Let's have a chat through [email protected]!
 </Callout>
diff --git a/pages/service/companion.mdx b/pages/service/companion.mdx
@@ -0,0 +1,35 @@
+---
+title: Introduction to Beam Companion
+---
+
+import { Callout, Cards, Card } from "nextra/components";
+
+# Introduction to Beam Companion
+
+The Beam Companion app allows users to manage and access their on-chain NFTs earned through playing your game.
+
+You'll be able to find the latest version of the Beam Companion through the following links
+
+<Cards>
+  <Card
+    icon="🍎 "
+    title="iOS"
+    href="https://apps.apple.com/us/app/beam-companion/id6467641736"
+  />
+  <Card
+    icon="🤖 "
+    title="Android"
+    href="https://play.google.com/store/apps/details?id=com.onbeam.companion_app"
+  />
+</Cards>
+
+<Callout emoji="🛠️">
+  Make sure you connect to **Beam testnet** in order to implement the application
+  during your development process. You can switch to testnet by switching on the
+  log-in screen of the app.
+</Callout>
+
+### Connecting users to the Beam Companion app
+
+The Beam Companion app works based on the same authentication solution as is being used in the self-custody features of Beam, meaning that any user you onboard through that solution will automatically be linked to your game and is able to use the Beam Companion app.
+
diff --git a/pages/service/companion/_meta.json b/pages/service/companion/_meta.json
diff --git a/pages/service/companion/connecting-your-users.mdx b/pages/service/companion/connecting-your-users.mdx
diff --git a/pages/service/companion/introduction.mdx b/pages/service/companion/introduction.mdx
diff --git a/pages/service/companion/verifying-webhooks.mdx b/pages/service/companion/verifying-webhooks.mdx
diff --git a/pages/service/environments.mdx b/pages/service/environments.mdx
@@ -14,7 +14,7 @@ Once you are ready to deploy your game to mainnet, simply request the production
 https://api.onbeam.com
 ````
 
-## api keys and environments
+### API keys and environments
 
 <Callout emoji="⚠️">
   Keep in mind that keys are not interchangeable per environment, meaning that you will need to send the correct key in the `x-api-key` header based on the hostname you use.

diff --git a/pages/service/exchange/introduction.mdx b/pages/service/exchange/introduction.mdx
@@ -8,11 +8,6 @@ import { Callout } from "nextra/components";
 
 The API allows you to convert any in-game tokens or BEAM associated with a profile, using Beam's decentralized exchange swap.onbeam.com. Conversion rates are determined via an Automated Market Maker mechanism, and depend on supply and demand of the respective tokens. You can learn more about setting up a liquidity pool for your own tokens here, in order to enable trading.
 
-### Roadmap
-
-Throughout the coming months, we'll be releasing additional features that will help you to provide a more complete marketplace experience, with features ranging from programmatic offers, auctions and extensive filtering options to allow you to create a full-fledged in-game marketplace solely by relying on the Beam marketplace.
-
 <Callout emoji="🛠️">
-  Feel like something is missing, and needs to be prioritized? Check out our
-  [2024 roadmap](/service/roadmap) or let's have a chat through [email protected]
+  Feel like something is missing, and needs to be prioritized? Let's have a chat through [email protected]!
 </Callout>
diff --git a/pages/service/full-api-reference.mdx b/pages/service/full-api-reference.mdx
@@ -6,14 +6,31 @@ The Beam API is a RESTful API. Given you have obtained your api key, you are abl
 
 If you ever feel the need to access all of the available endpoints directly from our deployed service, you can use the following links
 
+### Automation API
+
+```md filename="Swagger UI"
+https://api.testnet.onbeam.com/api/automation
+```
+
+```md filename="OpenAPI specification (JSON)"
+https://api.testnet.onbeam.com/api/automation-json
+```
+
+```md filename="OpenAPI specification (YAML)"
+https://api.testnet.onbeam.com/api/automation-yaml
+```
+
+
+### Player API
+
 ```md filename="Swagger UI"
-https://api.testnet.onbeam.com/api/game
+https://api.testnet.onbeam.com/api/player
 ```
 
 ```md filename="OpenAPI specification (JSON)"
-https://api.testnet.onbeam.com/api/game-json
+https://api.testnet.onbeam.com/api/player-json
 ```
 
 ```md filename="OpenAPI specification (YAML)"
-https://api.testnet.onbeam.com/api/game-yaml
+https://api.testnet.onbeam.com/api/player-yaml
 ```
diff --git a/pages/service/game/api-keys.mdx b/pages/service/game/api-keys.mdx
@@ -13,7 +13,7 @@ Note that, as soon as you regenerate the keys, your existing keys will be invali
 Below you'll find an example on how to regenerate your API keys.
 
 ```typescript
-import { Beam } from "@onbeam/node";
+import { Beam } from "@onbeam/automation-api-client";
 
 const beam = new Beam("x-regenerate-api-key");
 

diff --git a/pages/service/game/introduction.mdx b/pages/service/game/introduction.mdx
@@ -23,7 +23,7 @@ If you're just interested in the currently registered information of your game i
 **Note:** we don't expose your API keys in this request, as we don't want people to accidentally expose them in application logs.
 
 ```typescript
-import { Beam } from "@onbeam/node";
+import { Beam } from "@onbeam/automation-api-client";
 
 const beam = new Beam("x-api-key");