monday_ruby 0.6.1 → 1.0.0

data/docs/error-handling.md

@@ -1,71 +0,0 @@
-# Error Handling
-
-Monday.com has a set of predefined errors and exceptions that are sent back from their GraphQL API. Refer to their [official documentation](https://developer.monday.com/api-reference/docs/errors) to know more about the error codes.
-
-### Catching exceptions
-
-If there is an error from the API, the library raises an exception. It's a best practice to catch and handle exceptions.
-
-To catch an exception, use the `rescue` keyword. You can catch all the exceptions from the API using the `Monday::Error` class. However, it is recommended to catch specific exceptions using its subclasses and have a fallback rescue using `Monday::Error`.
-
-```ruby
-require "monday_ruby"
-
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-def example
-  res = client.boards
-  puts res.body
-rescue Monday::AuthorizationError => error
-  puts "Authorization error: #{error.message}"
-  puts "Error code: #{error.code}"
-rescue Monday::Error => error
-  puts "Other error: #{error.message}"
-end
-```
-
-Along with the default status code exceptions, monday.com returns some other exceptions with `200` status code. This library handles those errors and raises exceptions accordingly.
-
-#### `Monday::InternalServer Error`
-
-This exception is raised when the server returns a `500` status code. Read more about what can cause this error on Monday.com's [official documentation](https://developer.monday.com/api-reference/docs/errors#internal-server-error).
-
-#### `Monday::AuthorizationError`
-
-This exception is raised when the server returns a `401` or a `403` status code. This can happen when the client is not authenticated, i.e., not configured with the token, or the token is incorrect.
-
-This exception is also raised when the server returns a `200` status code but the body returns `UserUnauthorizedException` error code.
-
-#### `Monday::RateLimitError`
-
-This exception is raised when the server returns a `429` status code. This can happen when you exceed the rate limit, i.e., 5,000 requests per minute. Read more about their rate limit on their [official documentation](https://developer.monday.com/api-reference/docs/rate-limits).
-
-#### `Monday::ResourceNotFoundError`
-
-This exception is raised when the server returns a `404` status code. This can happen when you pass an invalid ID in the query.
-
-This exception is also raised when the server returns a `200` status code but the body returns `ResourceNotFoundException` error code.
-
-#### `Monday::ComplexityError`
-
-This exception is raised when the server returns a `200` status code but the body returns  `ComplexityException` error code.
-
-#### `Monday::InvalidRequestError`
-
-This exception is raised when the server returns a `400` status code. This can happen when the query you pass is invalid.
-
-This exception is also raised when the server returns a `200` status code but the body returns the following error codes:
-
-1. `InvalidUserIdException`
-2. `InvalidVersionException`
-3. `InvalidColumnIdException`
-4. `InvalidItemIdException`
-5. `InvalidBoardIdException`
-6. `InvalidArgumentException`
-7. `CreateBoardException`
-8. `ItemsLimitationException`
-9. `ItemNameTooLongException`
-10. `ColumnValueException`
-11. `CorrectedValueException`
-
-Read more about these specific exceptions on their [official API documentation](https://developer.monday.com/api-reference/docs/errors).

data/docs/getting-started.md

@@ -1,25 +0,0 @@
-# Getting Started
-
-### Installation
-
-You don't need the source code unless you want to modify the gem. If you want to use the package, run the following:
-
-```sh
-gem install monday_ruby
-```
-
-If you want to build the gem from the source:
-
-```sh
-gem build monday_ruby.gemspec
-```
-
-### Bundler
-
-If you are installing via bundler, you should be sure to use the HTTPS rubygems source in your Gemfile, as any gems fetched over HTTP could potentially be compromised in transit and alter the code of gems fetched securely over HTTPS:
-
-```ruby
-source "https://rubygems.org"
-
-gem "monday_ruby"
-```

data/docs/quick-start.md

@@ -1,269 +0,0 @@
-# Quick Start
-
-The following is the minimum needed to fetch all the boards with their IDs and column IDs:
-
-{% code lineNumbers="true" %}
-```ruby
-require "monday_ruby"
-
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-select = [
-  "id",
-  {
-    columns: "id"
-  }
-]
-
-response = client.boards(select: select)
-# => <Monday::Response ...>
-
-puts response.body
-```
-{% endcode %}
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "boards": [
-      {
-        "id": "123",
-        "columns": [
-          {
-            "id": "name"
-          },
-          {
-            "id": "subitems"
-          },
-          {
-            "id": "work_status"
-          },
-          {
-            "id": "keywords"
-          }
-        ]
-      },
-      {
-        "id": "456",
-        "columns": [
-          {
-            "id": "name"
-          },
-          {
-            "id": "person"
-          },
-          {
-            "id": "status"
-          },
-          {
-            "id": "date0"
-          }
-        ]
-      },
-    ]
-  },
-  "account_id": 123
-}
-```
-{% endcode %}
-
-### Advanced select query
-
-The following is the minimum needed to fetch:
-
-1. All the boards' IDs, names and count of items on each board.
-2. The ID, title and type for the columns on each board.
-3. The ID, name and the value of the items on each board.
-
-{% code lineNumbers="true" %}
-```ruby
-require "monday_ruby"
-
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-select = [
-  "id",
-  "name",
-  "items_count",
-  {
-    columns: %w[id title type],
-    items: [
-      "id",
-      "name",
-      {
-        column_values: "value"
-      }
-    ]
-  }
-]
-
-response = client.boards(select: select)
-# => <Monday::Response ...>
-
-puts response.body
-```
-{% endcode %}
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "boards": [
-      {
-        "id": "123",
-        "name": "New test board",
-        "items_count": 2,
-        "columns": [
-          {
-            "id": "name",
-            "title": "Name",
-            "type": "name"
-          },
-          {
-            "id": "subitems",
-            "title": "Subitems",
-            "type": "subtasks"
-          },
-          {
-            "id": "work_status",
-            "title": "Status",
-            "type": "color"
-          },
-          {
-            "id": "keywords",
-            "title": "Keywords",
-            "type": "dropdown"
-          }
-        ],
-        "items": [
-          {
-            "id": "4708726090",
-            "name": "Task 1",
-            "column_values": [
-              {
-                "value": null
-              },
-              {
-                "value": "{\"index\":0,\"changed_at\":\"2023-06-27T16:21:22.192Z\"}"
-              },
-              {
-                "value": "{\"ids\":[1]}"
-              }
-            ]
-          },
-          {
-            "id": "4713421325",
-            "name": "New item",
-            "column_values": [
-              {
-                "value": null
-              },
-              {
-                "value": null
-              },
-              {
-                "value": null
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "id": "456",
-        "name": "Your first board",
-        "items_count": 3,
-        "columns": [
-          {
-            "id": "name",
-            "title": "Name",
-            "type": "name"
-          },
-          {
-            "id": "subitems",
-            "title": "Subitems",
-            "type": "subtasks"
-          },
-          {
-            "id": "person",
-            "title": "Person",
-            "type": "multiple-person"
-          },
-          {
-            "id": "status",
-            "title": "Status",
-            "type": "color"
-          },
-          {
-            "id": "date4",
-            "title": "Date",
-            "type": "date"
-          }
-        ],
-        "items": [
-          {
-            "id": "4691485763",
-            "name": "Item 1",
-            "column_values": [
-              {
-                "value": null
-              },
-              {
-                "value": "{\"changed_at\":\"2022-10-26T12:39:58.664Z\",\"personsAndTeams\":[{\"id\":44865791,\"kind\":\"person\"}]}"
-              },
-              {
-                "value": "{\"index\":0,\"post_id\":null,\"changed_at\":\"2019-03-01T17:24:57.321Z\"}"
-              },
-              {
-                "value": "{\"date\":\"2023-06-21\",\"icon\":null,\"changed_at\":\"2022-12-18T14:03:06.455Z\"}"
-              }
-            ]
-          },
-          {
-            "id": "4691485774",
-            "name": "Item 2",
-            "column_values": [
-              {
-                "value": null
-              },
-              {
-                "value": null
-              },
-              {
-                "value": "{\"index\":1,\"post_id\":null,\"changed_at\":\"2019-03-01T17:28:23.178Z\"}"
-              },
-              {
-                "value": "{\"date\":\"2023-06-23\",\"icon\":null,\"changed_at\":\"2022-12-25T12:31:18.096Z\"}"
-              }
-            ]
-          },
-          {
-            "id": "4691485784",
-            "name": "Item 3",
-            "column_values": [
-              {
-                "value": null
-              },
-              {
-                "value": null
-              },
-              {
-                "value": "{\"index\":2,\"post_id\":null,\"changed_at\":\"2022-12-11T14:33:50.083Z\"}"
-              },
-              {
-                "value": "{\"date\":\"2023-06-25\",\"changed_at\":\"2022-12-25T12:31:20.220Z\"}"
-              }
-            ]
-          }
-        ]
-      }
-    ]
-  },
-  "account_id": 123
-}
-```
-{% endcode %}

data/docs/resources/README.md

@@ -1,27 +0,0 @@
-# Resources
-
-Once you have the client set up, you can call the API resources using the client.
-
-{% content-ref url="account/" %}
-[account](account/)
-{% endcontent-ref %}
-
-{% content-ref url="activity-log/" %}
-[activity-log](activity-log/)
-{% endcontent-ref %}
-
-{% content-ref url="board-view/" %}
-[board-view](board-view/)
-{% endcontent-ref %}
-
-{% content-ref url="board/" %}
-[board](board/)
-{% endcontent-ref %}
-
-{% content-ref url="column/" %}
-[column](column/)
-{% endcontent-ref %}
-
-{% content-ref url="item/" %}
-[item](item/)
-{% endcontent-ref %}

data/docs/resources/account/README.md

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

data/docs/resources/account/accounts.md

@@ -1,82 +0,0 @@
-# #accounts
-
-Querying the `account` API will return the metadata for the account.
-
-{% hint style="info" %}
-This account is the one that is associated with the authentication token.
-{% endhint %}
-
-### Basic usage
-
-{% code lineNumbers="true" %}
-```ruby
-client = Monday::Client.new(token: <AUTH_TOKEN>)
-
-response = client.account
-# => <Monday::Response ...>
-
-puts response.body
-```
-{% endcode %}
-
-This will return the accounts' ID and name fields by default.
-
-The response body from the above query would be as follows:
-
-{% code lineNumbers="true" %}
-```json
-{
-  "data": {
-    "users": [
-      {
-        "account": {
-          "id": 1234,
-          "name": "Test User's Team"
-        }
-      }
-    ]
-  },
-  "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>)
-
-select = %w[id name slug logo country_code]
-
-response = client.account(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 `plan` is of type `Plan` and expects you to pass the attributes you want to retrieve for the `plan` field.
-
-{% 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 account [here](https://developer.monday.com/api-reference/docs/account#fields).

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

@@ -1,9 +0,0 @@
-# Activity Log
-
-The activity log API is used to access the activity on your boards. It includes the following methods:
-
-[activity\_logs.md](activity\_logs.md "mention")
-
-{% hint style="info" %}
-Visit monday.com's API documentation to know more about the [activity logs API](https://developer.monday.com/api-reference/docs/activity-logs).
-{% endhint %}

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

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

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

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