monday_ruby 0.1.0 → 0.2.0

data/docs/resources/board/update_board.md

@@ -0,0 +1,91 @@
+# #update\_board
+
+The `update_board` mutation will allow you to update a board.
+
+### Basic usage
+
+This method accepts various arguments to duplicate a board. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/boards#arguments-3).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 789,
+  board_attribute: "description",
+  new_value: "Updated description"
+}
+response = client.update_board(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update board `789`'s description.
+
+This will return the boards' ID, name and description fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "update_board": "{\"success\":true,\"undo_data\":{\"undo_record_id\":65894,\"action_type\":\"modify_project\",\"entity_type\":\"Board\",\"entity_id\":789,\"count\":1}}"
+  },
+ "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 789,
+  board_attribute: "description",
+  new_value: "Updated description"
+}
+select = %w[id name description items_count permissions]
+
+response = client.update_board(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+### Retrieving nested fields
+
+Some fields have nested attributes, and you need to specify the attributes to retrieve that field; else, the API will respond with an error.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 789,
+  board_attribute: "description",
+  new_value: "Updated description"
+}
+select = [
+  "id",
+  "name",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.update_board(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for boards [here](https://developer.monday.com/api-reference/docs/board-view-queries#fields).

data/docs/resources/board-view/README.md

@@ -0,0 +1,9 @@
+# Board View
+
+The board view API is used to access the board view data. It includes the following methods:
+
+[board\_views.md](board\_views.md "mention")
+
+{% hint style="info" %}
+Visit monday.com's API documentation to know more about the [board views API](https://developer.monday.com/api-reference/docs/board-view-queries).
+{% endhint %}

data/docs/resources/board-view/board_views.md

@@ -0,0 +1,88 @@
+# #board\_views
+
+Querying `board_views` will return a collection of board views from a specific board.
+
+### Basic usage
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+response = client.board_views
+
+puts response.body
+```
+{% endcode %}
+
+This will return the board views' ID, name and type fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "boards": [
+      {
+        "views" : [
+          {
+            "type": "FormBoardView",
+            "name": "Contact Form",
+            "id": "55567306"
+          },
+          {
+            "type": "ItemsGalleryBoardView",
+            "name": "Cards",
+            "id": "212647324"
+          },
+          {
+            "type": "KanbanBoardView",
+            "name": "Kanban",
+            "id": "212644479"
+          }
+        ]
+      }
+    ]
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Filtering board views
+
+This method accepts various arguments to filter down the views. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/board-view-queries#arguments).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  ids: [123, 456]
+}
+response = client.board_views(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will filter and return the views for boards `123` and `456`.
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+select = %w[id name settings_str type]
+response = client.board_views(select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for board views [here](https://developer.monday.com/api-reference/docs/board-view-queries#fields).

data/docs/resources/column/README.md

@@ -0,0 +1,25 @@
+# Column
+
+The column API is used to access and mutate the columns. It includes the following methods:
+
+[columns.md](columns.md "mention")
+
+[column\_values.md](column\_values.md "mention")
+
+[create\_column.md](create\_column.md "mention")
+
+[change\_column\_title.md](change\_column\_title.md "mention")
+
+[change\_column\_metadata.md](change\_column\_metadata.md "mention")
+
+[change\_column\_value.md](change\_column\_value.md "mention")
+
+[change\_simple\_column\_value.md](change\_simple\_column\_value.md "mention")
+
+[change\_multiple\_column\_value.md](change\_multiple\_column\_value.md "mention")
+
+[delete\_column.md](delete\_column.md "mention")
+
+{% hint style="info" %}
+Visit monday.com's API documentation to know more about the [columns API](https://developer.monday.com/api-reference/docs/columns).
+{% endhint %}

data/docs/resources/column/change_column_metadata.md

@@ -0,0 +1,70 @@
+# #change\_column\_metadata
+
+The `change_column_metadata` mutation will allow you to update the metadata of a column.
+
+### Basic usage
+
+This method accepts various arguments to update a column's metadata. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-7).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  column_id: "status",
+  column_property: "description",
+  value: "Updated status column description"
+}
+response = client.change_column_metadata(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update the description for the `status` column on `123` board to "Updated status column description".
+
+This will return the columns' ID, title and description fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "change_column_metadata": {
+      "id": "status",
+      "title": "New Work Status",
+      "description": "Updated status column description"
+    }
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  column_id: "status",
+  column_property: "description",
+  value: "Updated status column description"
+}
+select = %w[id archived width settings_str]
+
+response =  client.change_column_metadata(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for columns [here](https://developer.monday.com/api-reference/docs/columns#fields).

data/docs/resources/column/change_column_title.md

@@ -0,0 +1,68 @@
+# #change\_column\_title
+
+The `change_column_title` mutation will allow you to update a column's title.
+
+### Basic usage
+
+This method accepts various arguments to update a column's title. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-6).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  column_id: "status",
+  title: "New Work Status"
+}
+response = client.change_column_title(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update the column title for the `status` column on `123` board to "New Work Status".
+
+This will return the columns' ID, title and description fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "change_column_title": {
+      "id": "status",
+      "title": "New Work Status",
+      "description": "Status Column"
+    }
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  column_id: "status",
+  title: "New Work Status"
+}
+select = %w[id archived width settings_str]
+
+response =  client.change_column_title(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for columns [here](https://developer.monday.com/api-reference/docs/columns#fields).

data/docs/resources/column/change_column_value.md

@@ -0,0 +1,73 @@
+# #change\_column\_value
+
+The `change_column_value` mutation will allow you to update the value of a column for a specific item.
+
+### Basic usage
+
+This method accepts various arguments to update the column's value. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-3).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_id: "status",
+  value: {
+    label: "Working on it"
+  }
+}
+response = client.change_column_value(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update the `status` column value for item ID `1234` on the board ID `123` to "Working on it".
+
+This will return the items' ID and name fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "change_column_value": {
+      "id": "1234",
+      "name": "Task 1"
+    }
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_id: "status",
+  value: {
+    label: "Working on it"
+  }
+}
+select = %w[id name email]
+
+response =  client.change_column_value(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for items [here](https://developer.monday.com/api-reference/docs/items#fields).

data/docs/resources/column/change_multiple_column_value.md

@@ -0,0 +1,81 @@
+# #change\_multiple\_column\_value
+
+The `change_multiple_column_value` mutation will allow you to update the values of multiple columns for a specific item.
+
+### Basic usage
+
+This method accepts various arguments to update the column values. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-5).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_values: {
+    status: {
+      label: "Done"
+    },
+    keywords: {
+      labels: %w[Tech Marketing]
+    }
+  }
+}
+response = client.change_multiple_column_value(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update the `status` column value for item ID `1234` on the board ID `123` to "Done" and the `keywords` column value to "Tech, Marketing".
+
+This will return the items' ID and name fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "change_multiple_column_value": {
+      "id": "1234",
+      "name": "Task 1"
+    }
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_values: {
+    status: {
+      label: "Done"
+    },
+    keywords: {
+      labels: %w[Tech Marketing]
+    }
+  }
+}
+select = %w[id name email]
+
+response =  client.change_multiple_column_value(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for items [here](https://developer.monday.com/api-reference/docs/items#fields).

data/docs/resources/column/change_simple_column_value.md

@@ -0,0 +1,69 @@
+# #change\_simple\_column\_value
+
+The `change_simple_column_value` mutation will allow you to update the value of a column for a specific item.
+
+### Basic usage
+
+This method accepts various arguments to update the column's value. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-4).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_id: "status",
+  value: "Triage"
+}
+response = client.change_simple_column_value(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will update the `status` column value for item ID `1234` on the board ID `123` to "Triage".
+
+This will return the items' ID and name fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "change_simple_column_value": {
+      "id": "1234",
+      "name": "Task 1"
+    }
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `select` option and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_id: 123,
+  item_id: 1234,
+  column_id: "status",
+  value: "Triage"
+}
+select = %w[id name email]
+
+response =  client.change_simple_column_value(args: args, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for items [here](https://developer.monday.com/api-reference/docs/items#fields).

data/docs/resources/column/column_values.md

@@ -0,0 +1,115 @@
+# #column\_values
+
+Querying `column_values` will return the metadata for one or a collection of columns.
+
+### Basic usage
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+response = client.column_values
+
+puts response.body
+```
+{% endcode %}
+
+By default, this will return the columns metadata for the ID, title, and description fields.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+  "data": {
+    "boards": [
+      {
+        "items": [
+          {
+            "column_values": [
+              {
+                "id": "subitems",
+                "title": "Subitems",
+                "description": null
+              },
+              {
+                "id": "work_status",
+                "title": "Status",
+                "description": "New description"
+              },
+              {
+                "id": "keywords",
+                "title": "Keywords",
+                "description": "This is keywords column"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "items": [
+          {
+            "column_values": [
+              {
+                "id": "person",
+                "title": "Owner",
+                "description": null
+              },
+              {
+                "id": "status",
+                "title": "Status",
+                "description": null
+              },
+              {
+                "id": "date0",
+                "title": "Date",
+                "description": null
+              }
+            ]
+          },
+          {
+            "column_values": [
+              {
+                "id": "person",
+                "title": "Owner",
+                "description": null
+              },
+              {
+                "id": "status",
+                "title": "Status",
+                "description": null
+              },
+              {
+                "id": "date0",
+                "title": "Date",
+                "description": null
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  "account_id": 123
+}
+```
+{% endcode %}
+
+### Customizing fields to retrieve
+
+You can customize the fields to retrieve by passing in the `board_ids` and `item_ids` options and listing all the fields you need to retrieve as an array.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+board_ids = [456]
+item_ids = [1234, 5678]
+select = %w[id description value]
+
+response = client.column_values(board_ids, item_ids, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for columns [here](https://developer.monday.com/api-reference/docs/column-values#fields).