monday_ruby 0.6.2 → 1.0.0

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).

data/docs/resources/item/create_item.md

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

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

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

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

data/docs/response.md

@@ -1,21 +0,0 @@
-# Response
-
-Every request made using the client will return a `Monday::Response` object. This object consists of the following methods:
-
-#### `status`
-
-This is the returned HTTP status code.
-
-#### `body`
-
-This is the response body.
-
-#### `headers`
-
-This is the response header.
-
-#### `success?`
-
-This returns true or false based on the status code and the response body.
-
-Sometimes when the application handles the exceptions, the API will return a `200` status code, but the body will return the error message.