uiza 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c138520bf1258148cdbbcf9539c0178e400c4caae9a69835f489f71cdcbbe0e
-  data.tar.gz: 8d6666866e771dc11e8bef1e0d7794f0c12a2a06053cfe920537c64c4b1dd966
+  metadata.gz: f23fc7407a3590ab55b04ef7520be7ec172f75ab8f19e191bdc16e96bbd11500
+  data.tar.gz: 96a0910830247d02b9b7e2ec23d61dc90efd5b6dcfe69164bd8752682a05afd4
 SHA512:
-  metadata.gz: 43a345233984081c0b003236656b7a5ce8cee2043ae814132794bda4f0c5fa2f04aa1e873b690205623ea2b7211f08114037bf93f51a6597c3f825ce4393e870
-  data.tar.gz: b4ff6a137446846094ba3e38afa37b102d2c1a1b89ac97bd50e59b1a4d22c3ddc3c71970aef1fee7406d90b6fe68495b77b39a6280c93a6aa47075f532e0530f
+  metadata.gz: 2ad4d4a999b5f3929e2c11dcde22093daafe97b5de02b5386a535e1bc2698fa7130dd363ff103b8920d4ce87c53f2bff0e90c856d63995e2e981af7d2ff5930f
+  data.tar.gz: 9f2e73ef4bee92d1095dd9c08155b31bc9b02b908086e70cc8902112c7831c738b55aee1a87482da89b8e9708b38d23470b9e442e862ff54f3df3bac38c80166

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.0 - 2019-03-28
+[#151](https://github.com/uizaio/api-wrapper-ruby/pull/151) Release Sprint 5
+1. Upgrade API v3 to API v4
+
 ## 1.1.0 - 2019-03-07
 [#89](https://github.com/uizaio/api-wrapper-ruby/pull/89) Release Sprint 4
 1. Add User

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uiza (1.1.1)
+    uiza (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,9 @@
 # Uiza
 
 ## Introduction
-This is documents the public API for Uiza version 3.0.
+This is documents the public API for Uiza version 4.0.
+
+See documents for public API for Uiza version 3.0 [here](https://github.com/uizaio/api-wrapper-ruby/tree/master_v3). Please use gem `uiza` version 1.1.0 to use API v3
 
 The Uiza API is organized around RESTful standard.
 Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
@@ -49,7 +51,7 @@ See details [here](https://docs.uiza.io/#authentication).
 ## Ruby
 ```ruby
 require "uiza"
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 ```
 
@@ -57,14 +59,14 @@ Uiza.authorization = "your-authorization"
 Create file `your-app/config/initializers/uiza.rb`
 
 ```ruby
-Uiza.workspace_api_domain = ENV["WORKSPACE_API_DOMAIN"]
+Uiza.app_id = ENV["APP_ID"]
 Uiza.authorization = ENV["AUTHORIZATION"]
 ```
 
 ## Entity
 These below APIs used to take action with your media files (we called Entity).
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/ENTITY.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ENTITY.md).
 
 ```ruby
 begin
@@ -83,12 +85,12 @@ end
 ## Category
 Category has been splits into 3 types: `folder`, `playlist` and `tag`. These will make the management of entity more easier.
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/CATEGORY.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CATEGORY.md).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -108,7 +110,7 @@ end
 You can add your storage (`FTP`, `AWS S3`) with UIZA.
 After synced, you can select your content easier from your storage to [create entity](https://docs.uiza.io/#create-entity).
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/STORAGE.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master/doc/STORAGE.md).
 
 ```ruby
 require "json"
@@ -134,12 +136,12 @@ These APIs used to create and manage live streaming event.
 * When a Live is not start : it's named as `Event`.
 * When have an `Event` , you can start it : it's named as `Feed`.
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/LIVE_STREAMING.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/LIVE.md).
 
 ```ruby
 require "json"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -158,16 +160,16 @@ end
 ## Callback
 Callback used to retrieve an information for Uiza to your server, so you can have a trigger notice about an entity is upload completed and .
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/CALLBACK.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CALLBACK.md).
 
 ```ruby
 require "json"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
-  callback = Uiza::Live.retrieve "your-callback-id"
+  callback = Uiza::Callback.retrieve "your-callback-id"
   puts callback.id
   puts callback.url
 rescue Uiza::Error::UizaError => e
@@ -184,15 +186,13 @@ You can manage user with APIs user. Uiza have 2 levels of user:
   Admin - This account will have the highest priority, can have permission to create & manage users.
   User - This account level is under Admin level. It only manages APIs that relates to this account.
 
-See details [here](https://docs.uiza.io/#user-management).
+ See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/USER.md).
 
-```ruby
+ ```ruby
 require "json"
-
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+ Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
-
-begin
+ begin
   user = Uiza::User.retrieve "your-user-id"
   puts user.id
   puts user.username
@@ -205,42 +205,10 @@ rescue StandardError => e
 end
 ```
 
-## Analytic
-Monitor the four key dimensions of video QoS: playback failures, startup time, rebuffering, and video quality.
-These 15 metrics help you track playback performance, so your team can know exactly what’s going on.
-
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/ANALYTIC.md).
-
-```ruby
-require "json"
-
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
-Uiza.authorization = "your-authorization"
-
-params = {
-  start_date: "YYYY-MM-DD hh:mm",
-  end_date: "YYYY-MM-DD hh:mm",
-  type_filter: "your-type-filter"
-}
-
-begin
-  response = Uiza::Analytic.total_line params
-  puts response.first.name
-  puts response.first.total_view
-  puts response.percentage_of_view
-rescue Uiza::Error::UizaError => e
-  puts "description_link: #{e.description_link}"
-  puts "code: #{e.code}"
-  puts "message: #{e.message}"
-rescue StandardError => e
-  puts "message: #{e.message}"
-end
-```
-
 ## Embed Metadata
 Embed metadata is information that can be embed into video/audio file. You can embed into file by adding a json compose these tag.
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/EMBED_METADATA.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master/doc/EMBED_METADATA.md).
 
 ## Errors Code
 Uiza uses conventional HTTP response codes to indicate the success or failure of an API request.
@@ -248,7 +216,7 @@ In general: Codes in the `2xx` range indicate success.
 Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
 Codes in the `5xx` range indicate an error with Uiza's servers.
 
-See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/doc/ERRORS_CODE.md).
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/master/doc/ERRORS_CODE.md).
 
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -271,4 +239,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/uizaio
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
-Everyone interacting in the Uiza project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/uizaio/api-wrapper-ruby/blob/master_v3/CODE_OF_CONDUCT.md).
+Everyone interacting in the Uiza project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/uizaio/api-wrapper-ruby/blob/master/CODE_OF_CONDUCT.md).

data/doc/CALLBACK.md

@@ -1,17 +1,17 @@
 ## Callback
 Callback used to retrieve an information for Uiza to your server, so you can have a trigger notice about an entity is upload completed and .
 
-See details [here](https://docs.uiza.io/#callback).
+See details [here](https://docs.uiza.io/v4/#callback).
 
 ## Create a callback
 This API will allow you setup a callback to your server when an entity is completed for upload or public
 
-See details [here](https://docs.uiza.io/#create-a-callback).
+See details [here](https://docs.uiza.io/v4/#create-a-callback).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
@@ -33,28 +33,38 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "0a6bf245-1cce-494f-a193-b5a44aa05558",
-  "url": "https://callback-url.uiza.co",
-  "headersData": null,
-  "jsonData": null,
-  "method": "POST",
-  "status": 1,
-  "createdAt": "2018-06-23T01:27:08.000Z",
-  "updatedAt": "2018-06-23T01:27:08.000Z"
+  "data": {
+    "id": "37b3b1fe-c73d-4a7c-8e6b-108d6a251b7b",
+    "url": "https://61b2923c-b7fd-4186-ac7d-cb4bbd6480e0.uiza.co",
+    "headersData": nil,
+    "jsonData": nil,
+    "method": "POST",
+    "status": 1,
+    "createdAt": "2019-03-13T09:32:39.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T12:36:37.811Z",
+  "policy": "public",
+  "requestId": "7f8931e6-4d5b-459d-b107-94043494516a",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Retrieve a callback
 Retrieves the details of an existing callback.
 
-See details [here](https://docs.uiza.io/#retrieve-a-callback).
+See details [here](https://docs.uiza.io/v4/#retrieve-a-callback).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -71,30 +81,38 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "0a6bf245-1cce-494f-a193-b5a44aa05558",
-  "url": "https://callback-url.uiza.co",
-  "headersData": null,
-  "jsonData": {
-    "text": "example callback"
+  "data": {
+    "id": "37b3b1fe-c73d-4a7c-8e6b-108d6a251b7b",
+    "url": "https://61b2923c-b7fd-4186-ac7d-cb4bbd6480e0.uiza.co",
+    "headersData": nil,
+    "jsonData": nil,
+    "method": "POST",
+    "status": 1,
+    "createdAt": "2019-03-13T09:32:39.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
   },
-  "method": "POST",
-  "status": 1,
-  "createdAt": "2018-06-23T01:27:08.000Z",
-  "updatedAt": "2018-06-23T01:27:08.000Z"
+  "version": 4,
+  "datetime": "2019-03-13T12:36:37.811Z",
+  "policy": "public",
+  "requestId": "7f8931e6-4d5b-459d-b107-94043494516a",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Update a callback
 This API will allow you setup a callback to your server when an entity is completed for upload or public
 
-See details [here](https://docs.uiza.io/#update-a-callback).
+See details [here](https://docs.uiza.io/v4/#update-a-callback).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
@@ -117,28 +135,38 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "your-callback-id",
-  "url": "https://callback-url.uiza.co",
-  "headersData": null,
-  "jsonData": null,
-  "method": "GET",
-  "status": 1,
-  "createdAt": "2018-06-23T01:27:08.000Z",
-  "updatedAt": "2018-06-23T01:27:08.000Z"
+  "data": {
+    "id": "37b3b1fe-c73d-4a7c-8e6b-108d6a251b7b",
+    "url": "https://update-callback-url.uiza.co",
+    "headersData": nil,
+    "jsonData": nil,
+    "method": "POST",
+    "status": 1,
+    "createdAt": "2019-03-13T09:32:39.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T12:39:35.619Z",
+  "policy": "public",
+  "requestId": "c3ad45c8-d022-4dbe-8161-5c140ea2ea7f",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Delete a callback
 Delete an existing callback.
 
-See details [here](https://docs.uiza.io/#delete-a-callback).
+See details [here](https://docs.uiza.io/v4/#delete-a-callback).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -154,8 +182,18 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "your-callback-id"
+  "data": {
+    "id": "37b3b1fe-c73d-4a7c-8e6b-108d6a251b7b"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T12:41:10.784Z",
+  "policy": "public",
+  "requestId": "4b89d46a-c7e4-4f97-8ebb-fb5b769b7fda",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```

data/doc/CATEGORY.md

@@ -2,24 +2,28 @@
 Category has been splits into 3 types: folder, playlist and tag.
 These will make the management of entity more easier.
 
-See details [here](https://docs.uiza.io/#category).
+See details [here](https://docs.uiza.io/v4/#categorization).
 
 ## Create category
 Create category for entity for easier management.
 Category use to group all the same entities into a group (like `Folder`/`playlist` or `tag`).
 
-See details [here](https://docs.uiza.io/#create-category).
+See details [here](https://docs.uiza.io/v4/#create-category).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
   name: "Folder sample",
   type: "folder",
-  description: "Folder description"
+  description: "Folder description",
+  orderNumber: 1,
+  icon: "https://exemple.com/icon.png",
+  slug: "Azx12da",
+  status: 1
 }
 
 begin
@@ -36,30 +40,40 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "f932aa79-852a-41f7-9adc-19935034f944",
-  "name": "Playlist sample",
-  "description": "Playlist description",
-  "slug": "playlist-sample",
-  "type": "playlist",
-  "orderNumber": 3,
-  "icon": "https:///example.com/image002.png",
-  "status": 1,
-  "createdAt": "2018-06-18T04:29:05.000Z",
-  "updatedAt": "2018-06-18T04:29:05.000Z"
+  "data": {
+    "id": "b62c676a-7370-4d57-960f-ff77cf3d8739",
+    "name": "Folder sample",
+    "description": "Folder description",
+    "slug": "azx12da",
+    "type": "folder",
+    "orderNumber": 1,
+    "icon": "https://exemple.com/icon.png",
+    "status": 1,
+    "createdAt": "2019-03-13T10:45:26.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T10:45:26.237Z",
+  "policy": "public",
+  "requestId": "85b8dc0b-6b0b-42e8-ab70-ab9771e21d4a",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Retrieve category
 Get detail of category.
 
-See details [here](https://docs.uiza.io/?shell#retrieve-category).
+See details [here](https://docs.uiza.io/v4/#retrieve-category).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -76,34 +90,51 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "f932aa79-852a-41f7-9adc-19935034f944",
-  "name": "Playlist sample",
-  "description": "Playlist description",
-  "slug": "playlist-sample",
-  "type": "playlist",
-  "orderNumber": 3,
-  "icon": "https:///example.com/image002.png",
-  "status": 1,
-  "createdAt": "2018-06-18T04:29:05.000Z",
-  "updatedAt": "2018-06-18T04:29:05.000Z"
+  "data": {
+    "id": "b62c676a-7370-4d57-960f-ff77cf3d8739",
+    "name": "Folder sample",
+    "description": "Folder description",
+    "slug": "azx12da",
+    "type": "folder",
+    "orderNumber": 1,
+    "icon": "https://exemple.com/icon.png",
+    "status": 1,
+    "createdAt": "2019-03-13T10:45:26.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T10:48:50.499Z",
+  "policy": "public",
+  "requestId": "bad8b2ca-ebf3-4815-9f1b-952ec394175c",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Retrieve category list
 Get all category.
 
-See details [here](https://docs.uiza.io/#retrieve-category-list).
+See details [here](https://docs.uiza.io/v4/#list-categories).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
+params = {
+  page: 1,
+  limit: 10
+}
+
 begin
-  categories = Uiza::Category.list
+  categories = Uiza::Category.list params
+  # params is optional
+  # or entities = Uiza::Category.list
   puts categories.first.id
   puts categories.first.name
 rescue Uiza::Error::UizaError => e
@@ -116,50 +147,65 @@ end
 ```
 
 Example Response
-```ruby
-[
-  {
-    "id": "f932aa79-852a-41f7-9adc-19935034f944",
-    "name": "Playlist sample",
-    "description": "Playlist desciption",
-    "slug": "playlist-sample",
-    "type": "playlist",
-    "orderNumber": 3,
-    "icon": "/example.com/image002.png",
-    "status": 1,
-    "createdAt": "2018-06-18T04:29:05.000Z",
-    "updatedAt": "2018-06-18T04:29:05.000Z"
+```json
+{
+  "data": [
+    {
+      "id": "b62c676a-7370-4d57-960f-ff77cf3d8739",
+      "name": "Folder sample",
+      "description": "Folder description",
+      "slug": "azx12da",
+      "type": "folder",
+      "orderNumber": 1,
+      "icon": "https://exemple.com/icon.png",
+      "status": 1,
+      "createdAt": "2019-03-13T10:45:26.000Z",
+      "updatedAt": "0000-00-00 00:00:00"
+    },
+    {
+      "id": "dcaec097-7c2a-4792-9e20-727926ec6b3b",
+      "name": "Folder sample",
+      "description": "Folder description",
+      "slug": "folder-sample",
+      "type": "folder",
+      "orderNumber": 0,
+      "icon": nil,
+      "status": 1,
+      "createdAt": "2019-03-13T10:41:28.000Z",
+      "updatedAt": "0000-00-00 00:00:00"
+    }
+  ],
+  "metadata": {
+    "total": 2,
+    "result": 2,
+    "page": 1,
+    "limit": 20
   },
-  {
-    "id": "ab54db88-0c8c-4928-b1be-1e7120ad2c39",
-    "name": "Folder sample",
-    "description": "Folder's description",
-    "slug": "folder-sample",
-    "type": "folder",
-    "orderNumber": 1,
-    "icon": "/example.com/icon.png",
-    "status": 1,
-    "createdAt": "2018-06-18T03:17:07.000Z",
-    "updatedAt": "2018-06-18T03:17:07.000Z"
-  }
-]
+  "version": 4,
+  "datetime": "2019-03-13T10:50:37.024Z",
+  "policy": "public",
+  "requestId": "0ad6ec82-7ff1-4bf4-87bb-28ea84f1055c",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
+}
 ```
 
 ## Update category
 Update information of category.
 
-See details [here](https://docs.uiza.io/#update-category).
+See details [here](https://docs.uiza.io/v4/#update-a-category).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
   id: "your-category-id",
-  name: "Folder edited",
-  type: "folder"
+  name: "Folder sample edited"
 }
 
 begin
@@ -176,30 +222,40 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "f932aa79-852a-41f7-9adc-19935034f944",
-  "name": "Folder edited",
-  "description": "Playlist description",
-  "slug": "playlist-sample",
-  "type": "folder",
-  "orderNumber": 3,
-  "icon": "https:///example.com/image002.png",
-  "status": 1,
-  "createdAt": "2018-06-18T04:29:05.000Z",
-  "updatedAt": "2018-06-18T04:29:05.000Z"
+  "data": {
+    "id": "b62c676a-7370-4d57-960f-ff77cf3d8739",
+    "name": "Folder sample edited",
+    "description": "Folder description",
+    "slug": "folder-sample-edited",
+    "type": "folder",
+    "orderNumber": 1,
+    "icon": "https://exemple.com/icon.png",
+    "status": 1,
+    "createdAt": "2019-03-13T10:45:26.000Z",
+    "updatedAt": "0000-00-00 00:00:00"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T10:55:23.462Z",
+  "policy": "public",
+  "requestId": "65a2d0fc-b3aa-42eb-b93b-edbb52286691",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Delete category
 Delete category.
 
-See details [here](https://docs.uiza.io/#delete-category).
+See details [here](https://docs.uiza.io/v4/#delete-a-category).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 begin
@@ -215,21 +271,31 @@ end
 ```
 
 Example Response
-```ruby
+```json
 {
-  "id": "f932aa79-852a-41f7-9adc-19935034f944"
+  "data": {
+    "id": "b62c676a-7370-4d57-960f-ff77cf3d8739"
+  },
+  "version": 4,
+  "datetime": "2019-03-13T10:58:05.997Z",
+  "policy": "public",
+  "requestId": "35b0f8c0-22b7-4bea-bdab-38ce6457b306",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
 }
 ```
 
 ## Create category relation
 Add relation for entity and category.
 
-See details [here](https://docs.uiza.io/#create-category-relation).
+See details [here](https://docs.uiza.io/v4/#create-category-relation).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
@@ -251,30 +317,46 @@ end
 ```
 
 Example Response
-```ruby
-[
-  {
-    "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
-    "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
-    "metadataId": "095778fa-7e42-45cc-8a0e-6118e540b61d"
+```json
+{
+  "data": [
+    {
+      "id": "ac48b2e3-421f-4362-b46a-d217834acc78",
+      "entityId": "ed9f5057-b05a-4499-92b4-d3cdba76d0ec",
+      "metadataId": "a257d0b7-4a58-44ac-b2ff-0cb26006daa4"
+    },
+    {
+      "id": "c1a9e68a-f1de-4a51-b625-03211fdec4fb",
+      "entityId": "ed9f5057-b05a-4499-92b4-d3cdba76d0ec",
+      "metadataId": "95b75a92-bd82-4b1f-8925-044caccc6663"
+    }
+  ],
+  "metadata": {
+    "total": 2,
+    "result": 2,
+    "page": 1,
+    "limit": 20
   },
-  {
-    "id": "47209e60-a99f-4c96-99fb-be4f858481b4",
-    "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
-    "metadataId": "e00586b9-032a-46a3-af71-d275f01b03cf"
-  }
-]
+  "version": 4,
+  "datetime": "2019-03-13T11:03:36.482Z",
+  "policy": "public",
+  "requestId": "d38329d2-a3bb-4444-ae91-af388316967f",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
+}
 ```
 
 ## Delete category relation
 Delete relation for entity and category.
 
-See details [here](https://docs.uiza.io/#delete-category-relation).
+See details [here](https://docs.uiza.io/v4/#delete-category-relation).
 
 ```ruby
 require "uiza"
 
-Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.app_id = "your-app-id"
 Uiza.authorization = "your-authorization"
 
 params = {
@@ -296,17 +378,33 @@ end
 ```
 
 Example Response
-```ruby
-[
-  {
-      "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
-      "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
-      "metadataId": "095778fa-7e42-45cc-8a0e-6118e540b61d"
+```json
+{
+  "data": [
+    {
+      "id": "ac48b2e3-421f-4362-b46a-d217834acc78",
+      "entityId": "ed9f5057-b05a-4499-92b4-d3cdba76d0ec",
+      "metadataId": "a257d0b7-4a58-44ac-b2ff-0cb26006daa4"
+    },
+    {
+      "id": "c1a9e68a-f1de-4a51-b625-03211fdec4fb",
+      "entityId": "ed9f5057-b05a-4499-92b4-d3cdba76d0ec",
+      "metadataId": "95b75a92-bd82-4b1f-8925-044caccc6663"
+    }
+  ],
+  "metadata": {
+    "total": 2,
+    "result": 2,
+    "page": 1,
+    "limit": 20
   },
-  {
-      "id": "47209e60-a99f-4c96-99fb-be4f858481b4",
-      "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
-      "metadataId": "e00586b9-032a-46a3-af71-d275f01b03cf"
-  }
-]
+  "version": 4,
+  "datetime": "2019-03-13T11:05:19.156Z",
+  "policy": "public",
+  "requestId": "52b847af-f620-46c0-8673-a00ebbb59f31",
+  "serviceName": "api-v4",
+  "message": "OK",
+  "code": 200,
+  "type": "SUCCESS"
+}
 ```