zendesk_api 0.1.11 → 0.2.1

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

@@ -0,0 +1,29 @@
+## 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/categories.md

@@ -0,0 +1,193 @@
+## 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 will 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 will 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 will 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 will 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
+```

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

@@ -0,0 +1,88 @@
+## Custom Agent Roles
+
+Zendesk enterprise accounts have the option of providing a more granular access to their agents. This is done using custom roles, which is a specialization of the agent role. This API provides access to list the specialized roles available on the account.
+
+### List Custom Roles
+`GET /api/v2/custom_roles.json`
+
+#### Availability
+
+ * Accounts on the enterprise plan
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/custom_roles.json \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "custom_roles": [
+    {
+      "id":             16,
+      "name":           "Advisor",
+      "description":    "Advisors manage the workflow and configure the help desk. They create or manage automations, macros, triggers, views, and SLA targets. They also set up channels and extensions. Advisors don't solve tickets, they can only make private comments.",
+      "created_at":     "2012-03-12T16:32:22Z",
+      "updated_at":     "2012-03-12T16:32:22Z",
+      "configuration": {
+        "chat_access":                     true,
+        "end_user_profile":                "readonly",
+        "forum_access":                    "readonly",
+        "forum_access_restricted_content": false,
+        "macro_access":                    "full",
+        "manage_business_rules":           true,
+        "manage_dynamic_content":          false,
+        "manage_extensions_and_channels":  true,
+        "manage_facebook":                 false,
+        "organization_editing":            false,
+        "report_access":                   "none",
+        "ticket_access":                   "within-groups",
+        "ticket_comment_access":           "private",
+        "ticket_deletion":                 false,
+        "ticket_editing":                  true,
+        "ticket_merge":                    false,
+        "ticket_tag_editing":              true,
+        "twitter_search_access":           true,
+        "view_access":                     "full"
+      },
+    },
+    {
+      "id":             6,
+      "name":           "Staff",
+      "description":    "A Staff agent's primary role is to solve tickets. They can edit tickets within their groups, view reports, and add or edit personal views and macros.",
+      "created_at":     "2011-07-20T04:31:29Z",
+      "updated_at":     "2012-02-02T10:32:59Z",
+      "configuration": {
+        "chat_access":                     true,
+        "end_user_profile":                "readonly",
+        "forum_access":                    "readonly",
+        "forum_access_restricted_content": false,
+        "macro_access":                    "full",
+        "manage_business_rules":           true,
+        "manage_dynamic_content":          false,
+        "manage_extensions_and_channels":  true,
+        "manage_facebook":                 false,
+        "organization_editing":            false,
+        "report_access":                   "none",
+        "ticket_access":                   "within-groups",
+        "ticket_comment_access":           "private",
+        "ticket_deletion":                 false,
+        "ticket_editing":                  true,
+        "ticket_merge":                    false,
+        "ticket_tag_editing":              true,
+        "twitter_search_access":           true,
+        "view_access":                     "full"
+      },
+    }
+  ]
+}
+```

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

@@ -0,0 +1,139 @@
+## Forum Subscriptions
+
+### JSON Format
+Forum subscriptions are links between users and forums they subscribe to
+
+| Name            | Type    | Read-only | Mandatory | Comment
+| --------------- | ------- | --------- | --------- | -------
+| id              | integer | yes       | no        | Automatically assigned upon creation
+| forum_id        | integer | no        | yes       | The forum being subscribed to
+| user_id         | integer | no        | yes       | The user subscribed to the forum
+| created_at      | date    | yes       | no        | The time the subscription was created
+
+#### Example
+```js
+{
+  "id":              35436,
+  "forum_id":        32,
+  "user_id":         482,
+  "created_at":      "2009-07-20T22:55:29Z"
+}
+```
+
+### List Forum Subscriptions
+`GET /api/v2/forum/{forum_id}/subscriptions.json`
+
+`GET /api/v2/forum_subscriptions.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions.json \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "forum_subscriptions": [
+    {
+      "id":              35436,
+      "forum_id":        32,
+      "user_id":         482,
+      "created_at":      "2009-07-20T22:55:29Z"
+    },
+    {
+      "id":              43681,
+      "forum_id":        334,
+      "user_id":         9471,
+      "created_at":      "2011-08-22T21:12:09Z"
+    }
+  ]
+}
+```
+
+### Show Forum Subscription
+`GET /api/v2/forum_subscriptions/{id}.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions/{id}.json \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "forum_subscription": {
+    "id":              35436,
+    "forum_id":        32,
+    "user_id":         482,
+    "created_at":      "2009-07-20T22:55:29Z"
+  }
+}
+```
+
+### Create Forum Subscription
+`POST /api/v2/forum_subscriptions.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions.json \
+  -d '{"user_id": 772, "forum_id": 881}' \
+  -v -u {email_address}:{password} -X POST
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "forum_subscription": {
+    "id":              55436,
+    "forum_id":        881,
+    "user_id":         772,
+    "created_at":      "2012-04-20T22:55:29Z"
+  }
+}
+```
+
+### Delete Forum Subscription
+`DELETE /api/v2/forum_subscriptions/{id}.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/forum_subscriptions/{id}.json \
+  -v -u {email_address}:{password} -X DELETE
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+```