zendesk_api 0.2.1 → 0.2.2

data/Gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (0.2.0)
+    zendesk_api (0.2.2)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie

data/lib/zendesk_api/resources.rb

@@ -23,9 +23,7 @@ module ZendeskAPI
   class Topic < Resource; end
   class Bookmark < Resource; end
   class Ability < DataResource; end
-  class Macro < Resource; end
   class Group < Resource; end
-  class Trigger < ReadResource; end
   class SharingAgreement < ReadResource; end
   class JobStatus < ReadResource; end
 
@@ -185,28 +183,17 @@ module ZendeskAPI
   class Request < Resource
     class Comment < ReadResource
       has_many Attachment, :inline => true
+      has :author, :class => User
     end
 
     has_many Comment
+
     has Organization
+    has :requester, :class => User
   end
 
   class TicketField < Resource; end
 
-  class TicketComment < Data
-    include Save
-
-    has_many :uploads, :class => Attachment, :inline => true
-    has :author, :class => User
-
-    def save
-      save_associations
-      true
-    end
-
-    alias :save! :save
-  end
-
   class TicketMetric < DataResource
     extend Read
   end
@@ -217,6 +204,22 @@ module ZendeskAPI
       has :author, :class => User
     end
 
+    class Tag < Resource; end
+
+    class Comment < Data
+      include Save
+
+      has_many :uploads, :class => Attachment, :inline => true
+      has :author, :class => User
+
+      def save
+        save_associations
+        true
+      end
+
+      alias :save! :save
+    end
+
     has :requester, :class => User, :inline => :create
     has :submitter, :class => User
     has :assignee, :class => User
@@ -227,8 +230,9 @@ module ZendeskAPI
     has :forum_topic, :class => Topic
     has Organization
 
-    has :comment, :class => TicketComment, :inline => true
-    has :last_comment, :class => TicketComment, :inline => true
+    has :comment, :class => Comment, :inline => true
+    has :last_comment, :class => Comment, :inline => true
+    has_many :last_comments, :class => Comment, :inline => true
 
     # Gets a incremental export of tickets from the start_time until now.
     # @param [Client] client The {Client} object to be used
@@ -272,16 +276,18 @@ module ZendeskAPI
     end
   end
 
-  class ViewExecution < Data
+  class RuleExecution < Data
     has_many :custom_fields, :class => TicketField
   end
 
   class ViewCount < DataResource; end
 
-  class View < ReadResource
+  class View < Resource
     has_many :tickets, :class => Ticket
+    has_many :feed, :class => Ticket, :path => "feed"
+
     has_many :rows, :class => ViewRow, :path => "execute"
-    has :execution, :class => ViewExecution
+    has :execution, :class => RuleExecution
     has ViewCount, :path => "count"
 
     def self.preview(client, options = {})
@@ -289,6 +295,18 @@ module ZendeskAPI
     end
   end
 
+  class Trigger < Resource
+    has :execution, :class => RuleExecution
+  end
+
+  class Automation < Resource
+    has :execution, :class => RuleExecution
+  end
+
+  class Macro < Resource
+    has :execution, :class => RuleExecution
+  end
+
   class GroupMembership < Resource
     has User
     has Group

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

@@ -32,6 +32,7 @@ Account Settings are read-only. They contain settings for the various aspects of
 | list_empty_views                   | boolean | Clients should display Views with no matching Tickets in menus
 | maximum_personal_views_to_list     | number  | Maximum number of personal Views clients should display in menus
 | tagging                            | boolean | Tickets may be tagged
+| markdown_ticket_comments           | boolean | Whether agent comments should be processed with Markdown
 
 ### Chat
 
@@ -69,6 +70,12 @@ Account Settings are read-only. They contain settings for the various aspects of
 | host                               | string  | The Screenr domain used when recording and playing Screencasts.
 | tickets_recorder_id                | string  | The Screenr Recorder id used when recording Screencasts.
 
+### GooddataAdvancedAnalytics
+
+| Name                               | Type    | Comment
+| ---------------------------------- | ------- | -------
+| enabled                            | boolean | GoodData Advanced Analytics is enabled
+
 
 #### Example
 
@@ -93,7 +100,8 @@ Account Settings are read-only. They contain settings for the various aspects of
     "agent_collision":                true
     "list_empty_views":               true,
     "maximum_personal_views_to_list": 12,
-    "tagging":                        true
+    "tagging":                        true,
+    "markdown_ticket_comments":       false
   },
   "chat": {
     "maximum_request_count": 5,
@@ -135,6 +143,36 @@ curl https://{subdomain}.zendesk.com/api/v2/account/settings.json \
 ```http
 Status: 200 OK
 
+"settings": {
+  "apps": {.. },
+  "tickets": { ...  },
+  "chat": { ... },
+  "twitter": { ... },
+  "users": { ... }
+}
+```
+
+### Update Account Settings
+`PUT /api/v2/account/settings.json`
+
+#### Allowed For
+
+ * Admins
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/account/settings.json \
+  -H "Content-Type: application/json" -X PUT \
+  -d '{ "settings": { "lotus": { "prefer_lotus": false }}}' \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
 "settings": {
   "apps": {.. },
   "tickets": { ...  },

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

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

@@ -36,7 +36,7 @@ Accounts that have forum categories
 #### 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
 
@@ -110,7 +110,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
 
@@ -144,7 +144,7 @@ Location: https://{subdomain}.zendesk.com/api/v2/categories/{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
 
@@ -177,7 +177,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