Merge pull request #2 from RTradeLtd/org

Add Organization Management Documentation

Makefile

@@ -0,0 +1,9 @@
+.PHONY: install-deps
+install-deps:
+	sudo apt install ruby ruby-dev
+	sudo gem install bundler:1.17.3
+
+.PHONY: run-locally
+run-locally:
+	bundle install
+	bundle exec middleman server

source/account.md

@@ -13,6 +13,7 @@ includes:
   - account/recovery
   - account/keys
   - account/utility
+  - account/organization_management
 
 slug: account
 search: true

source/includes/account/_account_api.md

@@ -6,7 +6,13 @@ We have usage examples for Javascript and will add Python and Golang soon.
 
 You can view code examples to the right, and switch the programming language above.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## Authentication
 

source/includes/account/_organization_management.md

@@ -0,0 +1,226 @@
+# Organization Management
+
+Temporal enables groups of accounts called Organizations. Instead of each account needing to maintain a credit balance and pay upfront for storage costs, the storage costs for all users is applied towards the organization as an amount owed.
+
+Each user account is allowed to create at most 1 organization. To create an organization you user account must be partner tier. To become a partner account your user account must be manually upgraded by an RTrade team member. Thus user accounts registered underneath an organization are prevented from creating an organization themselves. So dont go trying to game the system for free storage, it just wont happen ;)
+
+## POST new organization
+
+```go
+Golang code here.
+```
+
+```python
+Python code here.
+```
+
+```javascript
+Javascript code here.
+```
+
+> Example Response (200)
+
+```
+{
+    "code": 200,
+    "response": "organization created"
+}
+```
+
+`https://api.temporal.cloud/v2/org/new`
+
+Creates an organization, and marks the calling user account as the owner. After this you will be unable to create another organization, and you will have full management access to the organization you just created.
+
+### Parameters
+
+| Field | Type | Description
+|-----------|------|-------------
+| <b>name</b> | String | The name of the organization.
+
+## POST register user
+
+```go
+Golang code here.
+```
+
+```python
+Python code here.
+```
+
+```javascript
+handleRegister = (username, password, email, orgname) => () => {
+
+        var data = new FormData();
+        data.append("username", username);
+        data.append("password", password);
+        data.append("email_address", email);
+        data.append("organization_name", orgname);
+        \
+        var xhr = new XMLHttpRequest();
+        xhr.withCredentials = false;
+
+        xhr.addEventListener("readystatechange", function () {
+
+            if (xhr.readyState === 4) {
+
+                let result = JSON.parse(xhr.responseText);
+
+                if (result.code === 200) {
+                    console.log(result);
+                }
+
+                else {
+                    // Error handling.
+                }
+            }
+        }.bind(this));
+
+        xhr.open("POST", "https://api.temporal.cloud/v2/org/register/user");
+        xhr.setRequestHeader("Cache-Control", "no-cache");
+        xhr.send(data);
+
+    };
+```
+
+> Example Response (200)
+
+```
+{
+    "code": 200,
+    "response": {
+        "ID": 22,
+        "CreatedAt": "2019-10-31T01:16:57.828295Z",
+        "UpdatedAt": "2019-10-31T01:16:57.87117814Z",
+        "DeletedAt": null,
+        "UserName": "postables+org99999",
+        "EmailAddress": "[email protected]",
+        "AccountEnabled": true,
+        "EmailEnabled": false,
+        "EmailVerificationToken": "scrubbed",
+        "AdminAccess": false,
+        "HashedPassword": "scrubbed",
+        "Free": true,
+        "Credits": 0,
+        "CustomerObjectHash": "zdpuAnUGSDoNQoHQ2jpjhPePHEvg26mYLsAAGxr4jkzCWUpde",
+        "Organization": "myTestOrganizationnnnn",
+        "IPFSKeyNames": null,
+        "IPFSKeyIDs": null,
+        "IPFSNetworkNames": null,
+        "Status": "by continuing to use this service you agree to be bound by the following api terms and service https://gateway.temporal.cloud/ipns/docs.ts.temporal.cloud"
+    }
+}
+```
+
+`https://api.temporal.cloud/v2/org/register/user`
+
+Registers your information for the `POST login` call, which is used to generate the JWT (JSON Web Token) we use for API authentication. Additionally this user will be rgistered as part of the specified organization, and all storage costs will be applied to the organization. The field `status` within the `response` object, is used to display the terms and service URL associated with the API, that will change depending on usage of either the production, or development API. The values of `EmailVerificationToken` and `HashedPassword` are scrubbed before the response is sent.
+
+### Parameters
+
+| Field | Type | Description
+|-----------|------|-------------
+| <b>username</b> | String | Your desired username.
+| <b>password</b> | String | Your desired password.
+| <b>email_address</b> | String | An associated e-mail address.
+| <b>organization_name</b> | String | The organization to register this user under.
+
+### Response (200)
+
+| Field | Type | Description
+|-----------|------|-------------
+| <b>ID</b> | Int | The unique ID of your registration.
+| <b>CreatedAt</b> | DateTime | Time the account was created.
+| <b>UpdatedAt</b> | DateTime | Time the account was last updated.
+| <b>DeletedAt</b> | DateTime | Time the account was deleted.
+| <b>Username</b> | String | Your username.
+| <b>EmailAddress</b> | String | Your e-mail address.
+| <b>AccountEnabled</b> | Bool | Your account status.
+| <b>EmailEnabled</b> | Bool | Your e-mail notification status.
+| <b>EmailVerificationToken</b> | String | Sent via e-mail to confirm association.
+| <b>AdminAccess</b> | Bool | Your admin status.
+| <b>HashedPassword</b> | String | The hash of your password
+| <b>Free</b> | Bool | Indicates if the account is free tier 
+| <b>Credits</b> | Int | Your starting credits.
+| <b>CustomerObjectHash</b> | String | IPLD object of your uploads (not yet implemented)
+| <b>IPFSKeyNames</b> | Array[String] | IPFS key names associated with your account.
+| <b>IPFSKeyIDs</b> | Array[String] | IPFS key values associated with your account.
+| <b>IPFSNetworkNames</b> | Array[String] | Private IPFS networks associated with your account.
+| <b>Status</b> | String | Terms And Service link
+
+## GET organization
+
+```go
+Golang code here.
+```
+
+```python
+Python code here.
+```
+
+```javascript
+Javascript code here.
+```
+
+> Example Response (200)
+
+```
+{
+    "code": 200,
+    "response": {
+        "ID": 6,
+        "CreatedAt": "2019-10-31T01:14:00.062643Z",
+        "UpdatedAt": "2019-10-31T01:16:57.868267Z",
+        "DeletedAt": null,
+        "Name": "myTestOrganizationnnnn",
+        "UserOwner": "postables",
+        "AccountBalance": 0,
+        "RegisteredUsers": [
+            "postables+org99999"
+        ]
+    }
+}
+```
+
+`https://api.temporal.cloud/v2/org/get/model`
+
+Returns the organization model associated with the accont. Note that this can only be ran by the `UserOwner` of an organization. If an account that is part of an organization which is not the `UserOwner` calls this, an error will be returned.
+
+## GET billing report
+
+```go
+Golang code here.
+```
+
+```python
+Python code here.
+```
+
+```javascript
+Javascript code here.
+```
+
+> Example Response (200)
+
+```
+{
+    "code": 200,
+    "response": {
+        "org_name": "myTestOrganizationnnnn",
+        "items": null,
+        "amount_due": 0,
+        "time": 1572495932811044601
+    }
+}
+```
+
+`https://api.temporal.cloud/v2/org/get/billing/report`
+
+Returns a billing report of all users, uploads, and currently active storage costs for the specified date range. If you specify 30 for `number_of_days` then we will get the last 30 days from when the API call is processed. If you specify 5, then we will get the last 5 days from when the API call is processed.
+
+The idea behind this is that you can stay up to date with the usage of your organization accounts, and not have any surprises when we send you the invoice.
+
+### Parameters
+
+| Field | Type | Description
+|-----------|------|-------------
+| <b>number_of_days</b> | Integer | The amount of days to cover in report

source/includes/database/_database_api.md

@@ -6,7 +6,13 @@ We have usage examples for Javascript and will add Python and Golang soon.
 
 You can view code examples to the right, and switch the programming language above.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## Authentication
 

source/includes/ipfs/_ipfs_api.md

@@ -7,7 +7,13 @@ We have usage examples for Javascript and will add Python and Golang soon.
 
 You can view code examples to the right, and switch the programming language above.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## IPFS HTTP API
 

source/includes/ipfs/_public_network.md

@@ -103,7 +103,9 @@ Python code here.
 
 `https://api.temporal.cloud/v2/ipfs/public/file/add/directory`
 
-Used to upload a directory to IPFS, particularly useful for hosting websites. The directory **must** first be zipped, with a `.zip` extension, and that zip file is what you must upload. The total uncompressed size of the zip file must be no larger than the maximum upload limit, which is currently 1GB
+Used to upload a directory to IPFS, particularly useful for hosting websites. The directory **must** first be zipped, with a `.zip` extension, and that zip file is what you must upload. The total uncompressed size of the zip file must be no larger than the maximum upload limit, which is currently 2GB.
+
+Please note that this call is not available in production, and is only available in development environments. It is recommended you use the IPFS HTTP API to upload directories.
 
 ### Parameters
 

source/includes/ipns/_ipns_api.md

@@ -6,7 +6,13 @@ We have usage examples for Javascript and will add Python and Golang soon.
 
 You can view code examples to the right, and switch the programming language above.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## Authentication
 

source/includes/lens/_lens_api.md

@@ -3,7 +3,13 @@
 The Lens API is used to perform indexing, and searching of files stored on IPFS through Temporal. Lens is *opt-int*, and available without signing up to Temporal.
 Anything you index is available to the **public** so do not index anything you don't want easily discoverable. The search engine is facilitated through [bleve](https://github.com/blevesearch/bleve), while indexing is performed using a mix of text based analysis, Tesseract-OCR, and Tensorflow.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## Authentication
 

source/includes/payment/_payment_api.md

@@ -6,7 +6,13 @@ We have usage examples for Javascript and will add Python and Golang soon.
 
 You can view code examples to the right, and switch the programming language above.
 
-To access the development API use `https://dev.api.temporal.cloud` instead of `https://api.temporal.cloud`
+To access the development API use the following url:
+
+* https://dev.api.temporal.cloud
+
+Should you wish to access the production API  use the following url:
+
+* https://api.temporal.cloud
 
 ## Authentication