zendesk_api 0.2.1 → 0.2.2

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

@@ -133,7 +133,7 @@ Status: 200 OK
 #### Allowed For
 
  * Admins on non-enterprise accounts
- * Admins and agents will full forum access on enterprise accounts
+ * Admins and agents with full forum access on enterprise accounts
 
 #### Using curl
 
@@ -169,12 +169,12 @@ Location: https://{subdomain}.zendesk.com/api/v2/forums/{id}.json
 ```
 
 ### Update Forum
-`PUT /api/v2/forum/{id}.json`
+`PUT /api/v2/forums/{id}.json`
 
 #### Allowed For
 
  * Admins on non-enterprise accounts
- * Admins and agents will full forum access on enterprise accounts
+ * Admins and agents with full forum access on enterprise accounts
 
 #### Using curl
 
@@ -213,7 +213,7 @@ Status: 200 OK
 #### Allowed For
 
  * Admins on non-enterprise accounts
- * Admins and agents will full forum access on enterprise accounts
+ * Admins and agents with full forum access on enterprise accounts
 
 #### Using curl
 

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

@@ -9,7 +9,7 @@ When documenting a resource, we use curly braces for identifiers, like `{subdoma
 
 ### Change Policy
 
-We reserves the right to add new attributes and resources to the API without advance notice. Breaking changes such as removing or renaming an attribute, may happen on an existing version of the API with two weeks notice. Major structural changes will only happen within the context of a version update.
+We reserves the right to add new attributes and resources to the API without advance notice. Breaking changes such as removing or renaming an attribute, may happen on an existing version of the API with two weeks notice and deprecation of attributes are tracked in our [Changes Roadmap](changes_roadmap.html). Major structural changes will only happen within the context of a version update.
 
 ### Security and Authentication
 
@@ -67,6 +67,8 @@ We respond to unsuccessful requests with HTTP status codes in the 400 range. The
 }
 ```
 
+If you see a response from a known endpoint that looks like plain text, you've probably made a syntax error in your REST call. This is a common response if you try to make a request to a nonexistent Zendesk instance.
+
 If you ever experience responses with status codes in the 500 range, Zendesk may be experiencing internal issues or having a scheduled maintenance (during which we send a `503 Service Unavailable` status code).
 
 Please check [@zendeskops](https://twitter.com/zendeskops) and our [status page](http://www.zendesk.com/support/system-status) in such cases for any known issues.
@@ -143,6 +145,7 @@ The response receieved will then include a top-level array of associated data un
 | [View Execution / Previewing](views.html#executing-views) | The following are automatically side-loaded if applicable: group, organization, users
 | [Topics](topics.html)                                     | users, forums
 | [Topic Comments](topic_comments.html)                     | users
+| [Requests](requests.html)                                 | The following are automatically side-loaded: users, organizations
 
 **Warning: this is still experimental. If you encounter any issues, please contact <a href="mailto:support@zendesk.com">support@zendesk.com</a>. Please do not abuse this feature.**
 
@@ -153,6 +156,7 @@ The response receieved will then include a top-level array of associated data un
 
 ### API Clients from the Zendesk Developer Community
 
+* [.NET Client Library by Eric Neifert](https://github.com/eneifert/ZendeskApi_v2)
 * [zendeskR by Basho Technologies (R)](https://github.com/tcash21/zendeskR)
 * [node-zendesk by Farrin Reid (node.js)](https://github.com/blakmatrix/node-zendesk)
 

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

@@ -1,7 +1,7 @@
 ## Macros
 
 ### JSON Format
-Macros are read-only and represented as simple flat JSON objects which have the following keys.
+Macros are represented as simple flat JSON objects which have the following keys.
 
 | Name            | Type                       | Comment
 | --------------- | ---------------------------| -------------------

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

@@ -175,6 +175,25 @@ Location: https://{subdomain}.zendesk.com/api/v2/organizations/{id}.json
 }
 ```
 
+### Create Many Organizations
+`POST /api/v2/organizations/create_many.json`
+
+#### Allowed For
+
+ * Admins
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/organizations/create_many.json \
+  -H "Content-Type: application/json" -X POST -d "{\"organizations\":[{\"name\":\"My Org 1\"}, {\"name\":\"My Org 2\"}]}"
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+See [Job Status](job_statuses.md#show-job-status)
+
 ### Updating Organizations
 `PUT /api/v2/organizations/{id}.json`
 

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

@@ -9,11 +9,12 @@ Requests are represented as JSON objects which have the following keys:
 | ---------------- | ---------------------------------------- | --------- | --------- | -------
 | id               | integer                                  | yes       | no        | Automatically assigned when creating requests
 | url              | string                                   | yes       | no        | The API url of this request
-| subject          | string                                   | no        | no        | The value of the subject field for this request
-| description      | string                                   | yes       | no        | The first comment on the request
+| subject          | string                                   | no        | yes       | The value of the subject field for this request
+| description      | string                                   | yes       | yes       | The first comment on the request
 | status           | string                                   | no        | no        | The state of the request, "new", "open", "pending", "hold", "solved", "closed"
 | custom_fields    | Array                                    | no        | no        | The fields and entries for this request
 | organization_id  | integer                                  | yes       | no        | The organization of the requester
+| requester_id     | integer                                  | yes       | no        | The id of the requester
 | via              | [Via](ticket_audits.html#the-via-object) | yes       | no        | This object explains how the request was created
 | created_at       | date                                     | yes       | no        | When this record was created
 | updated_at       | date                                     | yes       | no        | When this record last got updated
@@ -29,6 +30,7 @@ Requests are represented as JSON objects which have the following keys:
   "description":      "The fire is very colorful.",
   "status":           "open",
   "organization_id":  509974,
+  "requester_id":     1462,
   "via": {
     "channel": "web"
   }
@@ -44,14 +46,16 @@ Ticket comments have the following keys:
 | --------------- | ------- | --------- | -------
 | id              | integer | yes       | Automatically assigned when creating events
 | body            | string  | yes       | The actual comment made by the author
+| author_id       | integer | yes       | The id of the author
 | attachments     | array   | yes       | The attachments on this comment as [Attachment](attachments.md) objects
 | created_at      | date    | yes       | When this comment was created
 
 #### Example
 ```js
 {
-  "id":     1274,
-  "body":   "Thanks for your help!",
+  "id": 1274,
+  "body": "Thanks for your help!",
+  "author_id": 1,
   "attachments": [
     {
       "id":           498483,

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

@@ -9,7 +9,8 @@
 | subject          | string                 | yes       | no        | The value of the subject field for this ticket
 | content          | string                 | yes       | no        | The content that was flagged
 | cause            | string                 | yes       | no        | Why the ticket was suspended
-| message_id       | string                 | yes       | no        | The id of the email, if available
+| message_id       | string                 | yes       | no        | The ID of the email, if available
+| ticket_id        | integer                | yes       | no        | The ticket ID this suspended email is associated with, if available
 | created_at       | date                   | yes       | no        | When this record was created
 | updated_at       | date                   | yes       | no        | When this record last got updated
 | via              | [Via](#the-via-object) | yes       | no        | This object explains how the ticket was created
@@ -23,6 +24,7 @@
   "subject":          "Help, my printer is on fire!",
   "content":          "Out Of Office Reply",
   "cause":            "Detected as spam",
+  "ticket_id":        67321,
   "created_at":       "2009-07-20T22:55:29Z",
   "updated_at":       "2011-05-05T10:38:52Z",
   "via": {

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

@@ -34,3 +34,112 @@ Status: 200 OK
   ]
 }
 ```
+
+### Show Tags
+`GET /api/v2/tickets/{id}/tags.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{id}/tags.json \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "tags": [
+    "important",
+    "customer"
+  ]
+}
+```
+
+### Set Tags
+`POST /api/v2/tickets/{id}/tags.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{id}/tags.json \
+  -v -u {email_address}:{password} -X POST \
+  -d '{ "tags": ["important"] }'
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "tags": [
+    "important"
+  ]
+}
+```
+
+### Add Tags
+`PUT /api/v2/tickets/{id}/tags.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{id}/tags.json \
+  -v -u {email_address}:{password} -X PUT \
+  -d '{ "tags": ["customer"] }'
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "tags": [
+    "important",
+    "customer"
+  ]
+}
+```
+
+### Remove Tags
+`DELETE /api/v2/tickets/{id}/tags.json`
+
+#### Allowed For:
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{id}/tags.json \
+  -v -u {email_address}:{password} -X DELETE \
+  -d '{ "tags": ["customer"] }'
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "tags": [
+    "important"
+  ]
+}
+```

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

@@ -314,6 +314,8 @@ Voice Comments have the following keys:
 | type            | string  | yes       | Has the value `VoiceComment`
 | data            | string  | yes       | A hash of properties about the call
 | public          | boolean | yes       | If true, the ticket requester can see this comment
+| formatted_from  | string  | yes       | A formatted version of the phone number which dialed the call
+| formatted_to    | string  | yes       | A formatted version of the phone number which answered the call
 
 #### Example
 ```js
@@ -321,9 +323,24 @@ Voice Comments have the following keys:
   "id":                    1274,
   "type":                  "VoiceComment"
   "body":                  "Thanks for your help!",
-  "data":                  TODO
-  "formatted_from":        TODO
-  "transcription_visible": TODO
+  "data":                  {
+                             "from":                 "+14156973270",
+                             "to":                   "+14129996294",
+                             "recording_url":        "http//api.twilio.com/2010-04-01/Accounts/accountsid/Recordings/recording_sid",
+                             "recording_duration":   "7",
+                             "call_duration":        60,
+                             "call_id":              171,
+                             "answered_by_id":       6,            # not present for voicemails
+                             "transcription_text":   "Hello",      # only present for voicemails with transcription enabled
+                             "transcription_status": "completed",  # only present for voicemails with transcription enabled
+                             "started_at":           2012-11-16 223622 UTC,
+                             "location":             "San Francisco, California, United States",
+                             "voice_transcription":  true,
+                             "outbound":             false
+                           },
+  "formatted_from":        "+1 (123) 654-7890",
+  "formatted_to":          "+1 (123) 325-7890",
+  "transcription_visible": true,
   "public":                true,
   "attachments":           []
 }

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

@@ -115,8 +115,6 @@ Tickets are ordered chronologically by created date, from oldest to newest.
 
 `GET /api/v2/organizations/{organization_id}/tickets.json`
 
-`GET /api/v2/views/{view_id}/tickets.json`
-
 `GET /api/v2/users/{user_id}/tickets/requested.json`
 
 `GET /api/v2/users/{user_id}/tickets/ccd.json`
@@ -307,6 +305,26 @@ curl https://{subdomain}.zendesk.com/api/v2/tickets/update_many.json?ids=1,2,3 \
 
 See [Job Status](job_statuses.md#show-job-status)
 
+### Mark a ticket as spam and suspend the requester
+`PUT /api/v2/tickets/{id}/mark_as_spam.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{id}/mark_as_spam.json\
+  -v -u {email_address}:{password} -X PUT
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+```
+
 ### Setting Collaborators
 
 You can set collaborators on tickets by passing in an array identifying the collaboratos you wish to

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

@@ -47,7 +47,7 @@ TopicComments are represented as simple flat JSON objects which have the followi
 #### Allowed For:
 
 * Admins on non-enterprise accounts
-* Admins and agents will full forum access on enterprise accounts
+* Admins and agents with full forum access on enterprise accounts
 * Users in general as permitted by the forum the topic is in
 
 #### Using curl
@@ -96,7 +96,7 @@ Status: 200 OK
 #### Allowed For
 
 * Admins on non-enterprise accounts
-* Admins and agents will full forum access on enterprise accounts
+* Admins and agents with full forum access on enterprise accounts
 * Users in general as permitted by the forum the topic is in
 
 #### Using curl
@@ -168,7 +168,7 @@ Location: https://{subdomain}.zendesk.com/api/v2/topics/{topic_id}/comments/{id}
 These are subject to the current permission settings on the enclosing account
 
 * Admins on non-enterprise accounts
-* Admins and agents will full forum access on enterprise accounts
+* Admins and agents with full forum access on enterprise accounts
 * The user who created the original comment
 
 #### Using curl
@@ -204,7 +204,7 @@ Status: 200 OK
 #### Allowed For
 
 * Admins on non-enterprise accounts
-* Admins and agents will full forum access on enterprise accounts
+* Admins and agents with full forum access on enterprise accounts
 * The user who created the original comment
 
 #### Using curl

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

@@ -54,7 +54,7 @@ Topics are represented in JSON with the below attributes
 #### Allowed For:
 
  * Admins on non-enterprise accounts
- * Admins and agents will full forum access on enterprise accounts
+ * Admins and agents with full forum access on enterprise accounts
 
 #### Using curl
 

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

@@ -1,7 +1,7 @@
 ## Triggers
 
 ### JSON Format
-Triggers are read-only and represented as simple flat JSON objects which have the following keys.
+Triggers are represented as simple flat JSON objects which have the following keys.
 
 | Name            | Type                       | Comment
 | --------------- | ---------------------------| -------------------
@@ -196,4 +196,62 @@ Status: 200 OK
   "previous_page": null,
   "next_page": null
 }
+```
+
+### Create Trigger
+`POST /api/v2/triggers.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/triggers.json \
+  -H "Content-Type: application/json" -X POST -d \
+  '{"trigger":{"title":"Roger Wilco", "all": [{ "field": "status", "operator": "is", "value": "open" }], "actions": [{ "field": "status", "value": "closed" }]}}'
+```
+
+#### Example Response
+
+```http
+Status: 201 Created
+Location: /api/v2/trigger/{new-trigger-id}.json
+
+{
+  "trigger": {
+    "id":   9873843,
+    "title": "Roger Wilco",
+    ...
+  }
+}
+```
+
+### Update Trigger
+`PUT /api/v2/triggers/{id}.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/triggers/{id}.json \
+  -H "Content-Type: application/json" -X PUT -d '{"trigger":{"title":"Roger Wilco II"}}'
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "trigger": {
+    "id":   9873843,
+    "title": "Roger Wilco II",
+    ...
+  }
+}
 ```