Changes by create-pull-request action

README.md

@@ -43,11 +43,11 @@ At its core, **Netlify CMS** is an open-source React app that acts as a wrapper
 
 1. ### Clone this repo
 
-   `git clone https://github.com/SettleForDevelopers/Developer-Docs.git`
+   `git clone https://github.com/SettleAPI/settle-developer-docs.git`
 
 2. ### Navigate into your newly created Settle API docs directory
 
-   `cd settle-api-docs`
+   `cd settle-developer-docs`
 
 3. ### Install dependencies
 

docs/.vuepress/enhanceApp.js

@@ -1,3 +1 @@
-module.exports = () => {
-    // console.log('enhancedApp.js');
-}
+

docs/.vuepress/nav/left/guides.js

@@ -18,13 +18,22 @@ const introduction = {
   collapsable: false,
   sidebarDepth: 0,
   children: [
-    '/api/guides/introduction/interacting',
-    '/api/guides/introduction/callbacks',
-    '/api/guides/introduction/error-responses',
-    '/api/guides/introduction/media-type',
-    '/api/guides/introduction/a-note-on-settle-api-users',
-    '/api/guides/introduction/versioning',
-    ['/api/guides/introduction/resiliency', 'Resiliency'],
+    ['/api/guides/introduction/a-note-on-settle-api-users.md', 'A Note on Settle API Users'],
+    ['/api/guides/introduction/attachments.md','Attachments'],
+    ['/api/guides/introduction/authentication.md','Authentication'],
+    ['/api/guides/introduction/callbacks.md','Callbacks'],
+    ['/api/guides/introduction/error-responses.md','Error Responses'],
+    ['/api/guides/introduction/interacting.md','Interacting'],
+    ['/api/guides/introduction/ledgers.md','Ledgers'],
+    ['/api/guides/introduction/media-type.md','Media Types'],
+    ['/api/guides/introduction/payment-flows.md','Payment Flows'],
+    ['/api/guides/introduction/permission-requests.md','Permission Requests'],
+    ['/api/guides/introduction/qr-acceptance.md','QR Acceptance'],
+    ['/api/guides/introduction/resiliency.md','Resiliency'],
+    ['/api/guides/introduction/sandbox-environment.md','Sandbox Enviroment #1'],
+    ['/api/guides/introduction/settle-sandbox-environment.md',' Sandbox Enviroment #2'],
+    ['/api/guides/introduction/settlements.md','Settlements'],
+    ['/api/guides/introduction/versioning.md','Verioning'],
   ],
 };
 
@@ -48,3 +57,6 @@ module.exports = [
 //         '/guides/qr-acceptance',
 //     ];
 // }
+
+
+

docs/.vuepress/nav/left/rest/v1/reference/merchant.js

@@ -6,6 +6,7 @@ function merchant_apiKeys() {
     children: [
       ['/api/reference/rest/v1/merchant.apiKeys/', 'Overview'],
       ['/api/reference/rest/v1/merchant.apiKeys/create', 'create'],
+      ['/api/reference/rest/v1/merchant.apiKeys/list', 'list'],
       ['/api/reference/rest/v1/merchant.apiKeys/get', 'get'],
       ['/api/reference/rest/v1/merchant.apiKeys/update', 'update'],
       ['/api/reference/rest/v1/merchant.apiKeys/delete', 'delete'],

docs/.vuepress/theme/components/Models.vue

@@ -19,7 +19,7 @@
             <!-- <a :href="'#' + type.title" class="header-anchor">#</a>  -->
             {{ type.title }}
           </h2>
-          <p v-if="type.properties && type.description">
+          <p v-if="type.properties || type.description">
             {{ type.description }}
           </p>
           <div v-if="type.properties" class="modelEntry">
@@ -112,7 +112,7 @@
               <p v-if="property.description">{{ property.description }}</p>
             </div>
           </div>
-          <div v-else>
+          <div v-if="!type.description && !type.properties">
             <p>
               No info available for <strong>{{ type.title }}</strong> at of this
               moment. Please
@@ -187,7 +187,7 @@ export default {
     } else if (site.pages[0].models) {
       data.types = site.pages[0].models;
     } else {
-      console.warn('Neither page.models or site.pages[0].models found...');
+      console.warn("Neither page.models or site.pages[0].models found...");
     }
 
     // console.log(data.types);

docs/.vuepress/theme/components/PageResource.vue

@@ -48,6 +48,16 @@
                 :to="'/api/guides/introduction/authentication/#authentication-using-key'"
                 >{{ $frontmatter.authLevel }}
               </router-link>
+              <router-link
+                v-if="$frontmatter.authLevel === 'JWT'"
+                :to="'/api/guides/introduction/authentication/#authentication-using-secret'"
+                >{{ $frontmatter.authLevel }}
+              </router-link>
+              <router-link
+                v-if="$frontmatter.authLevel === 'RSA'"
+                :to="'/api/guides/introduction/authentication/#authentication-using-key'"
+                >{{ $frontmatter.authLevel }}
+              </router-link>
             </li>
             <li>Authorized Roles: {{ $frontmatter.authRoles }}</li>
           </ul>
@@ -122,7 +132,7 @@
                   "
                 >
                   Length: <code>{{ type.minLength }}</code>
-                </li>
+                </li
                 <li v-else-if="type.minLength">
                   Length: <code>&#8805; {{ type.minLength }}</code>
                 </li>

docs/.vuepress/theme/components/PageResourceOverview.vue

@@ -17,9 +17,14 @@
         <router-link :to="'#resource'" class="header-anchor">#</router-link>
         Resource
       </h3>
-      <p>There is no persistent data associated with this resource.</p>
-      &nbsp; &nbsp; &nbsp;
-      <Content />
+      <div v-if="$frontmatter.resourceDesc === true">
+        <Content slot-key="resource" :hasDescription="true" />
+      </div>
+      <div v-else>
+        <p>There is no persistent data associated with this resource.</p>
+      </div>
+
+      <!-- <Content /> -->
       <h2 id="http-request">
         <router-link :to="'#http-request'" class="header-anchor">#</router-link>
         HTTP Requests
@@ -52,7 +57,10 @@
       </table>
       <div v-else class="warning custom-block">
         <p class="custom-block-title">WARNING</p>
-        <p>No Methods found for <strong>{{ $frontmatter.schema }}</strong>.</p>
+        <p>
+          No Methods found for <strong>{{ $frontmatter.schema }}</strong
+          >.
+        </p>
       </div>
     </div>
     <PageEdit />
@@ -72,7 +80,7 @@ const _ = require("lodash");
 
 const yaml = require("js-yaml");
 
-console.clear();
+// console.clear();
 
 let getMethods;
 
@@ -98,6 +106,9 @@ export default {
       methods: [],
     };
   },
+  async extendPageData($page) {
+    $page.size = await getAsyncData();
+  },
   async beforeMount() {
     site = this.$site;
     page = this.$page;

docs/api/guides/index.md

@@ -8,4 +8,4 @@ description: Getting started with the Settle API
 
 To get started we recommend that you first create a consumer account and a business account in the [Sandbox environment](/sandbox). This allows you to try out Settle and test your integration without having to worry about real money.
 
-You can then follow one the tutorials or checkout the API references directly.
+You can then follow one of the tutorials or checkout the API references directly.

docs/api/guides/introduction/interacting.md

@@ -1,5 +1,5 @@
 ---
-title: Interacting with the REST API's
+title: 1. Interacting with the REST API's
 description: How to interact with the Settle REST API's
 ---
 # Creating, Retrieving, Updating and Deleting resources (CRUD)

docs/api/reference/rest/v1/merchant.apiKeys/create.md

@@ -7,6 +7,6 @@ schema: merchant.apiKeys
 operationId: merchant.apiKeys.create
 operation: post
 method: create
-authLevel: KEY
-authRoles: All
+authLevel: RSA
+authRoles: SUPERUSER, INTEGRATOR
 ---

docs/api/reference/rest/v1/merchant.apiKeys/delete.md

@@ -7,6 +7,6 @@ schema: merchant.apiKeys
 operationId: merchant.apiKeys.delete
 operation: delete
 method: delete
-authLevel: KEY
-authRoles: All
+authLevel: RSA
+authRoles: SUPERUSER, INTEGRATOR
 ---

docs/api/reference/rest/v1/merchant.apiKeys/get.md

@@ -7,6 +7,6 @@ schema: merchant.apiKeys
 operationId: merchant.apiKeys.get
 operation: get
 method: get
-authLevel: SECRET
-authRoles: All
+authLevel: JWT
+authRoles: USER, SUPERUSER, INTEGRATOR
 ---

docs/api/reference/rest/v1/merchant.apiKeys/index.md

@@ -4,10 +4,11 @@ title: merchant.apiKeys
 description: Overview
 schema: merchant.apiKeys
 api: merchant
+resourceDesc: true
 ---
 
-## Merchant API Keys
+::: slot resource
+In order to gain access to the [Merchant API](/api/reference/rest) a client must authenticate itself using the `X-Settle-User` ID and the JWT/RSA KEY of an existing user. This means that the first user for a Merchant must be created in the **Self Service Portal** or by an Integrator on behalf of the Merchant.
 
-In order to gain access to the [Merchant API](/api/reference/rest) a client must authenticate itself using the ID and the secret/public key of an existing user. This means that the first user for a merchant must be created in the Self Service Portal or by an integrator on behalf of the merchant.
-
-Each user is created for a specific merchant, which ID is given by the value of the **X-Settle-Merchant** header when making a [ `merchant.apiKeys.create` ](/api/reference/rest/v1/merchant.apiKeys/create/) request. A user can only interact with the API on behalf of the merchant which it was created for. The user ID is chosen on create and is has to be unique for the parent Merchant.
+Each `X-Settle-User` is created for a specific Merchant, which ID is given by the value of the `X-Settle-Merchant` header when making a [ `merchant.apiKeys.create` ](/api/reference/rest/v1/merchant.apiKeys/create/) request. An API User can only interact with the API on behalf of the Merchant which it was created for. The `X-Settle-User` ID is chosen on `merchant.apiKeys.create` and is has to be unique for the parent Merchant.
+:::

docs/api/reference/rest/v1/merchant.apiKeys/list.md

@@ -7,6 +7,6 @@ schema: merchant.apiKeys
 operationId: merchant.apiKeys.list
 operation: get
 method: list
-authLevel: KEY
-authRoles: SUPERUSER, INTEGRATOR
+authLevel: RSA
+authRoles: USER, SUPERUSER, INTEGRATOR
 ---

docs/api/reference/rest/v1/merchant.apiKeys/update.md

@@ -7,6 +7,6 @@ schema: merchant.apiKeys
 operationId: merchant.apiKeys.update
 operation: put
 method: update
-authLevel: KEY
-authRoles: All
+authLevel: RSA
+authRoles: SUPERUSER, INTEGRATOR
 ---

docs/api/reference/rest/v1/merchant.balance/get.md

@@ -7,8 +7,9 @@ schema: merchant.balance
 operationId: merchant.balance.get
 operation: get
 method: get
-authLevel: SECRET
-authRoles: Any
+
+authLevel: JWT
+authRoles: USER, SUPERUSER, INTEGRATOR
 ---
 
 ::: slot example

docs/api/reference/rest/v1/merchant.logo/get.md

@@ -7,6 +7,6 @@ schema: merchant.logo
 operationId: merchant.logo.get
 operation: get
 method: get
-authLevel: SECRET
-authRoles: Any
----
+authLevel: JWT
+authRoles: USER, SUPERUSER, INTEGRATOR
+---

yarn.lock

@@ -6107,9 +6107,9 @@ postcss-value-parser@^4.0.2, postcss-value-parser@^4.1.0:
   integrity sha512-97DXOFbQJhk71ne5/Mt6cOu6yxsSfM0QGQyl0L25Gca4yGWEGJaig7l7gbCX623VqTBNGLRLaVUCnNkcedlRSQ==
 
 postcss@^7.0.0, postcss@^7.0.1, postcss@^7.0.14, postcss@^7.0.26, postcss@^7.0.27, postcss@^7.0.32, postcss@^7.0.5, postcss@^7.0.6:
-  version "7.0.35"
-  resolved "https://registry.yarnpkg.com/postcss/-/postcss-7.0.35.tgz#d2be00b998f7f211d8a276974079f2e92b970e24"
-  integrity sha512-3QT8bBJeX/S5zKTTjTCIjRF3If4avAT6kqxcASlTWEtAFCb9NH0OUxNDfgZSWdP5fJnBYCMEWkIFfWeugjzYMg==
+  version "7.0.36"
+  resolved "https://registry.yarnpkg.com/postcss/-/postcss-7.0.36.tgz#056f8cffa939662a8f5905950c07d5285644dfcb"
+  integrity sha512-BebJSIUMwJHRH0HAQoxN4u1CN86glsrwsW0q7T+/m44eXOUAxSNdHRkNZPYz5vVUbg17hFgOQDE7fZk7li3pZw==
   dependencies:
     chalk "^2.4.2"
     source-map "^0.6.1"