monday_ruby 0.6.2 → 1.1.0

data/docs/resources/column/change_column_value.md

@@ -1,73 +0,0 @@
-# #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

@@ -1,81 +0,0 @@
-# #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

@@ -1,69 +0,0 @@
-# #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

@@ -1,115 +0,0 @@
-# #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).

data/docs/resources/column/columns.md

@@ -1,117 +0,0 @@
-# #columns
-
-Querying `columns` 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.columns
-
-puts response.body
-```
-{% endcode %}
-
-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": {
-    "boards": [
-      {
-        "columns": [
-          {
-            "id": "name",
-            "title": "Name",
-            "description": null
-          },
-          {
-            "id": "subitems",
-            "title": "Subitems",
-            "description": null
-          },
-          {
-            "id": "work_status",
-            "title": "Status",
-            "description": "New description"
-          },
-          {
-            "id": "keywords",
-            "title": "Keywords",
-            "description": "This is keywords column"
-          }
-        ]
-      },
-      {
-        "columns": [
-          {
-            "id": "name",
-            "title": "Name",
-            "description": null
-          },
-          {
-            "id": "person",
-            "title": "Owner",
-            "description": null
-          },
-          {
-            "id": "status",
-            "title": "Status",
-            "description": null
-          },
-          {
-            "id": "date0",
-            "title": "Date",
-            "description": null
-          }
-        ]
-      }
-    ]
-  },
-  "account_id": 123
-}
-```
-{% endcode %}
-
-### Filtering columns
-
-This method accepts various arguments to filter down the columns. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments).
-
-You can pass these filters using the `args` option.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-args = {
-  ids: [456],
-}
-response = client.columns(args: args)
-
-puts response.body
-```
-{% endcode %}
-
-This will filter and return the columns that belong to board ID `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 archived width settings_str]
-response = client.columns(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/create_column.md

@@ -1,70 +0,0 @@
-# #create\_column
-
-The `create_column` mutation will allow you to create a column.
-
-### Basic usage
-
-This method accepts various arguments to create a column. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/columns#arguments-1).
-
-You can pass these filters using the `args` option.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-args = {
-  board_id: 123,
-  title: "Work Status",
-  description: "This is the work status column",
-  column_type: status
-}
-response = client.create_column(args: args)
-
-puts response.body
-```
-{% endcode %}
-
-This will create a new column on the `123` board titled "Work Status" and the "This is the work status column" description with the column type as 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": {
-    "create_column": {
-      "id": "status",
-      "title": "Work Status",
-      "description": "This is the work 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,
-  title: "Work Status",
-  description: "This is the work status column",
-  column_type: status
-}
-select = %w[id archived width settings_str]
-
-response =  client.create_column(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/delete_column.md

@@ -1,58 +0,0 @@
-# #delete\_column
-
-The `delete_column` mutation will allow you to delete a column from a specific board.
-
-### Basic usage
-
-This method accepts two required arguments - `board_id` and `column_id`.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-board_id = 123
-column_id = "keywords"
-response = client.delete_column(board_id, column_id)
-
-puts response.body
-```
-{% endcode %}
-
-This will delete the `keywords` column from the board ID `123`.
-
-This will return the deleted column's ID by default.
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "delete_column": {
-      "id": "keywords"
-    }
-  },
-  "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>)
-
-board_id = 123
-column_id = "keywords"
-select = %w[id type title]
-
-response =  client.delete_column(board_id, column_id, 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/item/README.md

@@ -1,17 +0,0 @@
-# Item
-
-The item API is used to access and mutate the items. It includes the following methods:
-
-[items.md](items.md "mention")
-
-[create\_item.md](create\_item.md "mention")
-
-[duplicate\_item.md](duplicate\_item.md "mention")
-
-[archive\_item.md](archive\_item.md "mention")
-
-[delete\_item.md](delete\_item.md "mention")
-
-{% hint style="info" %}
-Visit monday.com's API documentation to know more about the [items API](https://developer.monday.com/api-reference/docs/items).
-{% endhint %}

data/docs/resources/item/archive_item.md

@@ -1,80 +0,0 @@
-# #archive\_item
-
-The `archive_item` mutation will allow you to archive an item.
-
-### Basic usage
-
-This method accepts one required argument - `item_id`.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-item_id = "0123"
-
-response = client.archive_item(item_id)
-
-puts response.body
-```
-{% endcode %}
-
-This will return the archived item's ID by default.
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "archive_item": {
-      "id": "0123"
-    }
-  },
-  "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>)
-
-item_id = "0123"
-
-select = %w[id state creator_id]
-response = client.archive_item(item_id, 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. For example, the field `creator` is of type `User` and expects you to pass the attributes from `User` that you want to retrieve for `creator`.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-item_id = "0123"
-
-select = [
-  "id",
-  "state",
-  "creator_id",
-  {
-    creator: %w[id name email is_admin]
-  }
-]
-
-response = client.archive_item(item_id, 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).