zendesk_api 1.3.5 → 1.3.7

data/lib/zendesk_api/server/docs/attachments.md

@@ -1,142 +0,0 @@
-## Attachments
-
-### JSON Format
-Attachments are represented as JSON objects with the following keys:
-
-| Name         | Type             | Read-only | Comment
-| ------------ | ---------------- | --------- | -------
-| id           | integer          | yes       | Automatically assigned when created
-| file_name    | string           | yes       | The name of the image file
-| content_url  | string           | yes       | A full URL where the attachment image file can be downloaded
-| content_type | string           | yes       | The content type of the image. Example value: `image/png`
-| size         | integer          | yes       | The size of the image file in bytes
-| thumbnails   | array            | yes       | An array of [Photo](#attachments) objects. Note that thumbnails do not have thumbnails.
-
-#### Example
-```js
-{
-  "id":           928374,
-  "file_name":    "my_funny_profile_pic.png",
-  "content_url":  "https://company.zendesk.com/attachments/my_funny_profile_pic.png",
-  "content_type": "image/png",
-  "size":         166144,
-  "thumbnails": [
-    {
-      "id":           928375,
-      "file_name":    "my_funny_profile_pic_thumb.png",
-      "content_url":  "https://company.zendesk.com/attachments/my_funny_profile_pic_thumb.png",
-      "content_type": "image/png",
-      "size":         58298
-    }
-  ]
-}
-```
-
-### Uploading files
-`POST /api/v2/uploads.json`
-
-Adding multiple attachments to the same upload is handled by splitting requests and
-passing the token received from the first request to each subsequent one.
-
-#### Allowed For
-
- * End Users
-
-#### Using curl
-
-```bash
- curl -u username:password -H "Content-Type: application/binary" \
-   --data-binary @file.dat -X POST \
-   "https://helpdesk.zendesk.com/api/v2/uploads.json?filename=myfile.dat&token={optional_token}"
-```
-
-#### Example Response
-
-```http
-Status: 201 Created
-
-{
-  "upload": {
-    "token": "6bk3gql82em5nmf",
-    "attachments": [
-      {
-        "id":           498483,
-        "name":         "crash.log",
-        "content_url":  "https://company.zendesk.com/attachments/crash.log",
-        "content_type": "text/plain",
-        "size":         2532,
-        "thumbnails":   []
-      }
-    ]
-  }
-}
-```
-
-### Deleting Uploads
-`DELETE /api/v2/uploads/{token}.json`
-
-#### Allowed For
-
- * Agents
-
-#### Using curl
-
-```bash
- curl -u username:password -X DELETE https://helpdesk.zendesk.com/api/v2/uploads/{token}.json
-```
-
-#### Example Response
-
-```http
-200 OK
-```
-
-### Getting Attachments
-`GET /api/v2/attachments/{id}.json`
-
-#### Allowed For
-
- * Admins
-
-#### Using curl
-
-```bash
- curl -u username:password https://helpdesk.zendesk.com/api/v2/attachments/{id}.json
-```
-
-#### Example Response
-
-```http
-{
-  "attachment": {
-    "id":           498483,
-    "name":         "crash.log",
-    "content_url":  "https://company.zendesk.com/attachments/crash.log",
-    "content_type": "text/plain",
-    "size":         2532,
-    "thumbnails":   [],
-    "url":          "https://company.zendesk.com/api/v2/attachments/498483.json",
-  }
-}
-```
-
-### Deleting Attachments
-`DELETE /api/v2/attachments/{id}.json`
-
-Currently, only attachments on forum posts are allowed to be deleted.
-
-#### Allowed For
-
- * Admins
-
-#### Using curl
-
-```bash
- curl -u username:password -X DELETE https://helpdesk.zendesk.com/api/v2/attachments/{id}.json
-```
-
-#### Example Response
-
-```http
-200 OK
-```

data/lib/zendesk_api/server/docs/autocomplete.md

@@ -1,29 +0,0 @@
-## Autocompletion
-
-### Autocomplete Tags
-`POST /api/v2/autocomplete/tags.json?name={name}`
-
-Returns an array of registered and recent tag names that start with the specified name.
-The name must be at least 2 characters in length.
-
-#### Allowed For
-
- * Agents
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/autocomplete/tags.json \
-  -X POST -d '{"name": "att"}' -H "Accept: application/json" \
-  -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "tags": [ "attention", "attack" ]
-}
-```

data/lib/zendesk_api/server/docs/automations.md

@@ -1,256 +0,0 @@
-## Automations
-
-An automation consists of one or more actions that are performed if certain conditions are met after a period of time. The conditions are checked every hour. For example, an automation can notify an agent when a ticket remains unresolved after 24 hours.
-
-Even if the actions are performed once, they'll be performed again later if the conditions still apply. To ensure the actions are performed only once, include an action in the automation that cancels one of the conditions.
-
-For more information, see [Streamlining workflow with time-based events and automations](https://support.zendesk.com/entries/20012032).
-
-### JSON Format
-Automations are represented as simple flat JSON objects which have the following keys.
-
-| Name            | Type                       | Comment
-| --------------- | ---------------------------| -------------------
-| id              | integer                    | Automatically assigned when created
-| title           | string                     | The title of the trigger
-| active          | boolean                    | Whether the trigger is active
-| conditions      | [Conditions](#conditions)  | An object that describes the conditions under which the trigger will execute
-| actions         | [Actions](#actions)        | An object describing what the trigger will do
-| created_at      | date                       | The time the trigger was created
-| updated_at      | date                       | The time of the last update of the trigger
-
-#### Example
-```js
-{
-  "automation": {
-    "id": 25,
-    "title": "Notify requester of comment update",
-    "active": true,
-    "actions": { ... },
-    "conditions": { ... },
-    "updated_at": "2012-09-25T22:50:26Z",
-    "created_at": "2012-09-25T22:50:26Z"
-  }
-}
-```
-
-### Conditions
-The conditions under which a ticket is selected.
-
-| Name         | Type    | Comment
-| ------------ | ------- | -------
-| all          | array   | Tickets must fulfill *all* of these conditions to be considered matching
-| any          | array   | Tickets may satisfy *any* of these conditions to be considered matching
-
-#### Example
-```js
-{
-   "conditions": {
-     "all": [
-       { "field": "status", "operator": "less_than", "value": "solved" },
-       { "field": "assignee", "operator": "is", "value": "me" },
-     ],
-     "any": [
-     ]
-   }
-}
-```
-
-### Actions
-The actions that will be applied to the ticket.
-
-| Name         | Type    | Comment
-| ------------ | ------- | -------
-| field        | string  | The ticket field being modified
-| value        | string  | The new value of the field
-
-#### Example
-```js
-{
-   "actions": [
-       { "field": "status", "value": "solved" },
-       { "field": "assignee", "value": "me" },
-   ]
-}
-```
-
-### List Automations
-`GET /api/v2/automations.json`
-
-Lists all automations for the current account
-
-#### Allowed For:
-
- * Agents
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/automations.json \
-  -v -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "automations": [
-     {
-      "id": 25,
-      "title": "Close and Save",
-      "active": true
-      "conditions": [ ... ],
-      "actions": [ ... ],
-      ...
-    },
-    {
-      "id": 26,
-      "title": "Assign priority tag",
-      "active": false
-      "conditions": [ ... ],
-      "actions": [ ... ],
-      ...
-    }
-  ],
-  "count": 2,
-  "previous_page": null,
-  "next_page": null
-}
-```
-
-### Getting Automations
-`GET /api/v2/automations/{id}.json`
-
-#### Allowed For:
-
- * Agents
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/automations/{id}.json \
-  -v -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "automation": {
-    "id": 25,
-    "title": "Tickets updated <12 Hours",
-    "active": true
-    "conditions": [ ... ],
-    "actions": [ ... ],
-    ...
-  }
-}
-```
-
-### List active Automations
-`GET /api/v2/automations/active.json`
-
-Lists all active automations
-
-#### Allowed For:
-
- * Agents
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/automations/active.json \
-  -v -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "automations": [
-     {
-      "id": 25,
-      "title": "Close and Save",
-      "active": true
-      "conditions": [ ... ],
-      "actions": [ ... ],
-      ...
-    },
-    {
-      "id": 28,
-      "title": "Close and redirect to topics",
-      "active": true
-      "conditions": [ ... ],
-      "actions": [ ... ],
-      ...
-    }
-  ],
-  "count": 2,
-  "previous_page": null,
-  "next_page": null
-}
-```
-
-### Create Automation
-`POST /api/v2/automations.json`
-
-#### Allowed For
-
- * Agents
-
-#### Using curl
-
-```bash
-curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/automations.json \
-  -H "Content-Type: application/json" -X POST -d \
-  '{"automation":{"title":"Roger Wilco", "all": [{ "field": "status", "operator": "is", "value": "open" }], "actions": [{ "field": "status", "value": "closed" }]}}'
-```
-
-#### Example Response
-
-```http
-Status: 201 Created
-Location: /api/v2/automation/{new-automation-id}.json
-
-{
-  "automation": {
-    "id":   9873843,
-    "title": "Roger Wilco",
-    ...
-  }
-}
-```
-
-### Update Automation
-`PUT /api/v2/automations/{id}.json`
-
-#### Allowed For
-
- * Agents
-
-#### Using curl
-
-```bash
-curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/automations/{id}.json \
-  -H "Content-Type: application/json" -X PUT -d '{"automation":{"title":"Roger Wilco II"}}'
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "automation": {
-    "id":   9873843,
-    "title": "Roger Wilco II",
-    ...
-  }
-}
-```

data/lib/zendesk_api/server/docs/categories.md

@@ -1,193 +0,0 @@
-## Categories
-
-### JSON Format
-Categories are represented as simple flat JSON objects which have the following keys:
-
-| Name            | Type    | Read-only | Mandatory | Comment
-| --------------- | ------- | --------- | --------- | -------
-| id              | integer | yes       | no        | Automatically assigned during creation
-| url             | string  | yes       | no        | The API url of this category
-| name            | string  | no        | yes       | The name of the category
-| description     | string  | no        | no        | The description of the category
-| position        | integer | no        | no        | The position of this category relative to other categories
-| created_at      | date    | yes       | no        | The time the category was created
-| updated_at      | date    | yes       | no        | The time of the last update of the category
-
-#### Example
-```js
-{
-  "id":              35436,
-  "url":             "https://company.zendesk.com/api/v2/categories/35436.json",
-  "name":            "Self Help Articles",
-  "description":     null,
-  "position":        21,
-  "created_at":      "2009-07-20T22:55:29Z",
-  "updated_at":      "2011-05-05T10:38:52Z"
-}
-```
-
-### List Categories
-`GET /api/v2/categories.json`
-
-#### Availability
-
-Accounts that have forum categories
-
-#### Allowed For:
-
- * Admins on non-enterprise accounts
- * Admins and agents with full forum access on enterprise accounts
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/categories.json \
-  -v -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "categories": [
-    {
-      "id":              35436,
-      "name":            "Self Help Articles",
-      "description":     null,
-      "position":        21,
-      "created_at":      "2009-07-20T22:55:29Z",
-      "updated_at":      "2011-05-05T10:38:52Z"
-    },
-    {
-      "id":              12,
-      "name":            "News",
-      "description":     "Announcements about routine maintenance, scheduled downtime, and new features.",
-      "position":        28,
-      "created_at":      "2011-07-20T04:31:29Z",
-      "updated_at":      "2012-02-02T10:32:59Z"
-    }
-  ]
-}
-```
-
-### Show Category
-`GET /api/v2/categories/{id}.json`
-
-#### Allowed For
-
- * Admins
- * Anyone who can access at least one forum in the category
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/categories/{id}.json \
-  -v -u {email_address}:{password}
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "category": {
-    "id":              12,
-    "name":            "News",
-    "description":     "Announcements about routine maintenance, scheduled downtime, and new features.",
-    "position":        28,
-    "created_at":      "2011-07-20T04:31:29Z",
-    "updated_at":      "2012-02-02T10:32:59Z"
-  }
-}
-```
-
-### Create Category
-`POST /api/v2/categories.json`
-
-#### Allowed For
-
- * Admins on non-enterprise accounts
- * Admins and agents with full forum access on enterprise accounts
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/categories.json \
-  -H "Content-Type: application/json" -d '{"category": {"name": "My Category"}}' \
-  -v -u {email_address}:{password} -X POST
-```
-
-#### Example Response
-
-```http
-Status: 201 Created
-Location: https://{subdomain}.zendesk.com/api/v2/categories/{id}.json
-
-{
-  "category": {
-    "id":              14215,
-    "name":            "My Category",
-    "description":     null,
-    "position":        9999,
-    "created_at":      "2012-02-02T04:31:29Z",
-    "updated_at":      "2012-02-02T04:31:29Z"
-  }
-}
-```
-
-### Update Category
-`PUT /api/v2/category/{id}.json`
-
-#### Allowed For
-
- * Admins on non-enterprise accounts
- * Admins and agents with full forum access on enterprise accounts
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/categories/{id}.json \
-  -H "Content-Type: application/json" -d '{"category": {"name": "The Category About Nothing"}}' \
-  -v -u {email_address}:{password} -X PUT
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-
-{
-  "category": {
-    "id":              14215,
-    "name":            "The Category About Nothing",
-    "description":     null,
-    "position":        9999,
-    "created_at":      "2012-02-02T04:31:29Z",
-    "updated_at":      "2012-03-10T14:51:08Z"
-  }
-}
-```
-
-### Delete Category
-`DELETE /api/v2/categories/{id}.json`
-
-#### Allowed For
-
- * Admins on non-enterprise accounts
- * Admins and agents with full forum access on enterprise accounts
-
-#### Using curl
-
-```bash
-curl https://{subdomain}.zendesk.com/api/v2/categories/{id} \
-  -v -u {email_address}:{password} -X DELETE
-```
-
-#### Example Response
-
-```http
-Status: 200 OK
-```