monday_ruby 0.1.0 → 0.2.0

data/docs/resources/column/columns.md

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

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

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

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

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

data/docs/resources/item/create_item.md

@@ -0,0 +1,105 @@
+# #create\_item
+
+The `create_item` mutation will allow you to create an item on a specific board.
+
+### Basic usage
+
+This method accepts various arguments to fetch the items. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/items#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,
+  item_name: "New Task",
+  column_values: {
+    status: {
+      label: "Working on it"
+    }
+  }
+}
+response = client.create_item(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will return the items' ID, name and created\_at fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "create_item": {
+      "id": "7890",
+      "name": "New Task",
+      "created_at": "2023-06-27T16:39:29Z"
+    }
+  },
+  "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_name: "New Task",
+  column_values: {
+    status: {
+      label: "Working on it"
+    }
+  }
+}
+select = %w[id state creator_id]
+response = client.create_item(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. 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>)
+
+args = {
+  board_id: 123,
+  item_name: "New Task",
+  column_values: {
+    status: {
+      label: "Working on it"
+    }
+  }
+}
+select = [
+  "id",
+  "state",
+  "creator_id",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.create_item(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/item/delete_item.md

@@ -0,0 +1,80 @@
+# #delete\_item
+
+The `delete_item` mutation will allow you to delete 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.delete_item(item_id)
+
+puts response.body
+```
+{% endcode %}
+
+This will return the deleted item's ID by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "delete_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.delete_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.delete_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).

data/docs/resources/item/duplicate_item.md

@@ -0,0 +1,87 @@
+# #duplicate\_item
+
+The `duplicate_item` mutation will allow you to duplicate an item.
+
+### Basic usage
+
+This method accepts three required arguments - `board_id`, `item_id` and `with_updates`.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+board_id = "123"
+item_id = "7890"
+with_updates = true
+response = client.duplicate_item(board_id, item_id, with_updates)
+
+puts response.body
+```
+{% endcode %}
+
+This will return the items' ID, name and created\_at fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "duplicate_item": {
+      "id": "0123",
+      "name": "New Task (copy)",
+      "created_at": "2023-06-27T16:45:07Z"
+    }
+  },
+  "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"
+item_id = "7890"
+with_updates = true
+
+select = %w[id state creator_id]
+response = client.duplicate_item(board_id, item_id, with_updates, 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>)
+
+board_id = "123"
+item_id = "7890"
+with_updates = true
+
+select = [
+  "id",
+  "state",
+  "creator_id",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.duplicate_item(board_id, item_id, with_updates, 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/item/items.md

@@ -0,0 +1,95 @@
+# #items
+
+Querying `items` will return the metadata for one or a collection of columns.
+
+### Basic usage
+
+This method accepts various arguments to fetch the items. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/items#arguments).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  ids: [1234, 5678]
+}
+response = client.items(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will return the items' ID, name and created\_at fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "items": [
+      {
+        "id": "1234",
+        "name": "Task 1",
+        "created_at": "2023-06-26T23:20:56Z"
+      },
+      "items": [
+      {
+        "id": "5678",
+        "name": "Task 2",
+        "created_at": "2023-06-26T23:25:50Z"
+      }
+    ]
+  },
+  "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 = {
+  ids: [1234, 5678]
+}
+select = %w[id state creator_id]
+response = client.items(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. 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>)
+
+args = {
+  ids: [1234, 5678]
+}
+select = [
+  "id",
+  "state",
+  "creator_id",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.items(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).