monday_ruby 0.6.2 → 1.1.0

data/docs/resources/board/create_board.md

@@ -1,95 +0,0 @@
-# #create\_board
-
-The `create_board` mutation will allow you to create a new board.
-
-### Basic usage
-
-This method accepts various arguments to create a board. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/boards#arguments-1).
-
-You can pass these filters using the `args` option.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-args = {
-  board_name: "New test board",
-  board_kind: "public",
-  description: "The description for the board"
-}
-response = client.create_board(args: args)
-
-puts response.body
-```
-{% endcode %}
-
-This will create a private board with the name "New test board" and description "The description for the board" on the account.
-
-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": {
-    "create_board": {
-      "id": "456",
-      "name": "New test board",
-      "description": "The description for the board"
-    }
-  },
-  "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_name: "New test board",
-  board_kind: "public",
-  description: "The description for the board"
-}
-select = %w[id name description items_count permissions]
-
-response = client.create_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_name: "New test board",
-  board_kind: "public",
-  description: "The description for the board"
-}
-select = [
-  "id",
-  "name",
-  {
-    creator: %w[id name email is_admin]
-  }
-]
-
-response = client.create_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/delete_board.md

@@ -1,79 +0,0 @@
-# #delete\_board
-
-The `delete_board` mutation will allow you to delete a board.
-
-### Basic usage
-
-This method accepts one required argument - `board_id`.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-board_id = 789
-response = client.delete_board(board_id)
-
-puts response.body
-```
-{% endcode %}
-
-This will delete the `789` board.
-
-This will return the board's ID by default.
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "delete_board": {
-      "id": "789"
-    }
-  },
-  "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 = 789
-select = %w[id name description items_count permissions]
-
-response = client.delete_board(board_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.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-board_id = 789
-select = [
-  "id",
-  "name",
-  {
-    creator: %w[id name email is_admin]
-  }
-]
-
-response = client.delete_board(board_id, 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/delete_board_subscribers.md

@@ -1,87 +0,0 @@
-# #delete\_board\_subscribers
-
-The `delete_board_subscribers` mutation will allow you to delete subscribers from a board.
-
-### Basic usage
-
-This method accepts two required parameters - `board_id` and `user_ids`.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-board_id = 789
-user_ids = [123, 456]
-response = client.delete_board_subscribers(board_id, user_ids)
-
-puts response.body
-```
-{% endcode %}
-
-This will delete `123` and `456` subscribers from the `789` board.
-
-This will return the deleted subscriber's ID by default.
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "delete_subscribers_from_board": [
-      {
-        "id": 123
-      },
-      {
-        "id": 456
-      }
-    ]
-  },
-  "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 = 789
-user_ids = [123, 456]
-select = %w[id name is_guest is_admin]
-
-response = client.delete_board_subscribers(board_id, user_ids, 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>)
-
-board_id = 789
-user_ids = [123, 456]
-select = [
-  "id",
-  "name",
-  {
-    account: %w[id slug tier]
-  }
-]
-
-response = client.delete_board_subscribers(board_id, user_ids, 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/duplicate_board.md

@@ -1,94 +0,0 @@
-# #duplicate\_board
-
-The `duplicate_board` mutation will allow you to duplicate a board with all its items and groups to a workspace or folder of your choice.
-
-### 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-2).
-
-You can pass these filters using the `args` option.
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-args = {
-  board_id: 456,
-  duplicate_type: "duplicate_board_with_structure"
-}
-response = client.duplicate_board(args: args)
-
-puts response.body
-```
-{% endcode %}
-
-This will duplicate the board `456`.
-
-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": {
-    "duplicate_board": {
-      "board": {
-        "id": "789",
-        "name": "Duplicate of New test board",
-        "description": "The description for the board"
-      }
-    }
-  },
- "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: 456,
-  duplicate_type: "duplicate_board_with_structure"
-}
-select = %w[id name description items_count permissions]
-
-response = client.duplicate_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: 456,
-  duplicate_type: "duplicate_board_with_structure"
-}
-select = [
-  "id",
-  "name",
-  {
-    creator: %w[id name email is_admin]
-  }
-]
-
-response = client.duplicate_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/update_board.md

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

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

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

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

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

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