monday_ruby 0.1.0 → 0.2.0

data/docs/resources/activity-log/activity_logs.md

@@ -0,0 +1,95 @@
+# #activity\_logs
+
+Querying `activity_logs` will return a collection of activity logs from a specific board.
+
+### Basic usage
+
+This method accepts one required argument - `board_ids`, an array of board IDs.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+board_ids = [123, 456]
+response = client.activity_logs(board_ids)
+
+puts response.body
+```
+{% endcode %}
+
+This will return the activity logs' ID, event and data fields by default.
+
+The response body from the above query would be as follows:
+
+{% code lineNumbers="true" %}
+```json
+{
+  "data": {
+    "boards": [
+      {
+        "activity_logs": [
+          {
+            "id": "123-abc",
+            "event": "create_column",
+            "data": "{\"board_id\":123,\"column_id\":\"date0\",\"column_title\":\"Date\",\"column_type\":\"date\"}"
+          },
+          {
+            "id": "456-def",
+            "event": "create_column",
+            "data": "{\"board_id\":123,\"column_id\":\"status\",\"column_title\":\"Status\",\"column_type\":\"color\"}"
+          },
+          {
+            "id": "789-ghi",
+            "event": "create_column",
+            "data": "{\"board_id\":123,\"column_id\":\"name\",\"column_title\":\"Name\",\"column_type\":\"name\"}"
+          }
+        ]
+      }
+    ]
+  },
+ "account_id": 123
+}
+```
+{% endcode %}
+
+### Filtering activity logs
+
+This method accepts various arguments to filter down the activity logs. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/activity-logs#arguments).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+board_ids = [123, 456]
+args = {
+  from: "2023-01-01T00:00:00Z",
+  to: "2023-06-01T00:00:00Z"
+}
+response = client.activity_logs(board_ids, args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will filter and return the logs from Jan 1, 2023, to Jun 1, 2023.
+
+### 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_ids = [123, 456]
+
+select = %w[id event data entity user_id]
+response = client.activity_logs(board_ids, select: select)
+
+puts response.body
+```
+{% endcode %}
+
+You can find the list of all the available fields for activity logs [here](https://developer.monday.com/api-reference/docs/activity-logs#fields).

data/docs/resources/board/README.md

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

data/docs/resources/board/archive_board.md

@@ -0,0 +1,79 @@
+# #archive\_board
+
+The `archive_board` mutation will allow you to archive 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.archive_board(board_id)
+
+puts response.body
+```
+{% endcode %}
+
+This will archive 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": {
+    "archive_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.archive_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.archive_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/boards.md

@@ -0,0 +1,96 @@
+# #boards
+
+Querying `boards` will return the metadata for one or a collection of boards.
+
+### Basic usage
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+response = client.boards
+
+puts response.body
+```
+{% endcode %}
+
+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": {
+    "boards": [
+      {
+        "id": "4691485686",
+        "name": "Your first board",
+        "description": "Add your board's description here"
+      }
+    ]
+  },
+ "account_id": 123
+}
+```
+{% endcode %}
+
+### Filtering board
+
+This method accepts various arguments to filter down the boards. You can find the complete list of arguments [here](https://developer.monday.com/api-reference/docs/boards#arguments).
+
+You can pass these filters using the `args` option.
+
+{% code lineNumbers="true" %}
+```ruby
+client = Monday::Client.new(token: <AUTH_TOKEN>)
+
+args = {
+  board_kind: "private",
+}
+response = client.boards(args: args)
+
+puts response.body
+```
+{% endcode %}
+
+This will filter and return the boards that are private on the account.
+
+### 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 description items_count permissions]
+response = client.boards(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>)
+
+select = [
+  "id",
+  "name",
+  {
+    creator: %w[id name email is_admin]
+  }
+]
+
+response = client.boards(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/create_board.md

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

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

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

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