zendesk_api 0.2.6 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. data/.gitignore +2 -1
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +10 -2
  4. data/LICENSE +176 -19
  5. data/Readme.md +13 -5
  6. data/config/newrelic.yml +255 -0
  7. data/lib/zendesk_api/association.rb +1 -1
  8. data/lib/zendesk_api/associations.rb +129 -100
  9. data/lib/zendesk_api/client.rb +44 -25
  10. data/lib/zendesk_api/collection.rb +83 -58
  11. data/lib/zendesk_api/console/extensions.rb +47 -28
  12. data/lib/zendesk_api/server/base.rb +4 -0
  13. data/lib/zendesk_api/server/docs/account_settings.md +8 -0
  14. data/lib/zendesk_api/server/docs/automations.md +6 -0
  15. data/lib/zendesk_api/server/docs/changes_roadmap.md +76 -1
  16. data/lib/zendesk_api/server/docs/forum_subscriptions.md +2 -2
  17. data/lib/zendesk_api/server/docs/introduction.md +4 -2
  18. data/lib/zendesk_api/server/docs/macros.md +2 -0
  19. data/lib/zendesk_api/server/docs/organizations.md +3 -4
  20. data/lib/zendesk_api/server/docs/requests.md +21 -7
  21. data/lib/zendesk_api/server/docs/tickets.md +64 -8
  22. data/lib/zendesk_api/server/docs/topic_subscriptions.md +3 -3
  23. data/lib/zendesk_api/server/docs/topic_votes.md +0 -1
  24. data/lib/zendesk_api/server/docs/triggers.md +7 -0
  25. data/lib/zendesk_api/server/docs/users.md +4 -4
  26. data/lib/zendesk_api/server/docs/views.md +57 -8
  27. data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +131 -0
  28. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +190 -0
  29. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +616 -0
  30. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +362 -0
  31. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +438 -0
  32. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +243 -0
  33. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +190 -0
  34. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +190 -0
  35. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +462 -0
  36. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +1490 -0
  37. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +2825 -0
  38. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +1212 -0
  39. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +860 -0
  40. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +190 -0
  41. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +134 -0
  42. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +322 -0
  43. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +222 -0
  44. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +190 -0
  45. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +1432 -0
  46. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +348 -0
  47. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +216 -0
  48. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +307 -0
  49. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +245 -0
  50. data/lib/zendesk_api/server/public/doc/ZendeskAPI/FormatError.html +123 -0
  51. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +1196 -0
  52. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +616 -0
  53. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +243 -0
  54. data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +616 -0
  55. data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +209 -0
  56. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +209 -0
  57. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +438 -0
  58. data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +361 -0
  59. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +1016 -0
  60. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +278 -0
  61. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +220 -0
  62. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +826 -0
  63. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +604 -0
  64. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +258 -0
  65. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +190 -0
  66. data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +383 -0
  67. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +938 -0
  68. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +510 -0
  69. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +403 -0
  70. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +166 -0
  71. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +131 -0
  72. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +523 -0
  73. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +684 -0
  74. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +303 -0
  75. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +508 -0
  76. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/UserRequest.html +125 -0
  77. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +244 -0
  78. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +350 -0
  79. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +209 -0
  80. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +247 -0
  81. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +342 -0
  82. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +2731 -0
  83. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +385 -0
  84. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +636 -0
  85. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +243 -0
  86. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +243 -0
  87. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +205 -0
  88. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +1086 -0
  89. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +232 -0
  90. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +624 -0
  91. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +743 -0
  92. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +616 -0
  93. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +438 -0
  94. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +140 -0
  95. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +237 -0
  96. data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +222 -0
  97. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +404 -0
  98. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +3611 -0
  99. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +563 -0
  100. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +194 -0
  101. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +338 -0
  102. data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +1283 -0
  103. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +190 -0
  104. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +1342 -0
  105. data/lib/zendesk_api/server/public/doc/_index.html +799 -0
  106. data/lib/zendesk_api/server/public/doc/class_list.html +53 -0
  107. data/lib/zendesk_api/server/public/doc/css/common.css +1 -0
  108. data/lib/zendesk_api/server/public/doc/css/full_list.css +57 -0
  109. data/lib/zendesk_api/server/public/doc/css/style.css +328 -0
  110. data/lib/zendesk_api/server/public/doc/file.Readme.html +377 -0
  111. data/lib/zendesk_api/server/public/doc/file_list.html +55 -0
  112. data/lib/zendesk_api/server/public/doc/frames.html +28 -0
  113. data/lib/zendesk_api/server/public/doc/index.html +377 -0
  114. data/lib/zendesk_api/server/public/doc/js/app.js +214 -0
  115. data/lib/zendesk_api/server/public/doc/js/full_list.js +173 -0
  116. data/lib/zendesk_api/server/public/doc/js/jquery.js +4 -0
  117. data/lib/zendesk_api/server/public/doc/method_list.html +2540 -0
  118. data/lib/zendesk_api/server/public/doc/top-level-namespace.html +144 -0
  119. data/lib/zendesk_api/version.rb +1 -1
  120. data/zendesk_api.gemspec +1 -1
  121. metadata +96 -3
@@ -22,7 +22,7 @@ Topic subscriptions are links between users and topics they subscribe to
22
22
  ```
23
23
 
24
24
  ### List Topic Subscriptions
25
- `GET /api/v2/topic/{topic_id}/subscriptions.json`
25
+ `GET /api/v2/topics/{topic_id}/subscriptions.json`
26
26
 
27
27
  `GET /api/v2/topic_subscriptions.json`
28
28
 
@@ -100,8 +100,8 @@ Status: 200 OK
100
100
 
101
101
  ```bash
102
102
  curl https://{subdomain}.zendesk.com/api/v2/topic_subscriptions.json \
103
- -d '{"user_id": 772, "topic_id": 881}' \
104
- -v -u {email_address}:{password} -X POST
103
+ -d '{"topic_subscription": {"user_id": 772, "topic_id": 881}}' \
104
+ -v -u {email_address}:{password} -H "Content-Type: application/json" -X POST
105
105
  ```
106
106
 
107
107
  #### Example Response
@@ -64,7 +64,6 @@ Status: 200 OK
64
64
 
65
65
  Agents can pass a `user_id={user_id}` to all actions below to control voting for specific users.
66
66
 
67
-
68
67
  ### Check for Vote
69
68
  `GET /api/v2/topics/{id}/vote.json`
70
69
 
@@ -1,5 +1,12 @@
1
1
  ## Triggers
2
2
 
3
+ A trigger consists of one or more actions performed when a ticket is created or updated. The actions are performed only if certain conditions are met. For example, a trigger can notify the customer when an agent changes the status of a ticket to Solved.
4
+
5
+ All your triggers are checked from first to last each time a ticket is created or updated. The order of triggers is important because the actions of one trigger may affect another trigger. New triggers are added in last place by default.
6
+
7
+ For more information, see [Streamlining workflow with ticket updates and triggers](https://support.zendesk.com/entries/20011606).
8
+
9
+
3
10
  ### JSON Format
4
11
  Triggers are represented as simple flat JSON objects which have the following keys.
5
12
 
@@ -422,8 +422,8 @@ Status: 200
422
422
 
423
423
  ```bash
424
424
  curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/password.json \
425
- -X POST -d '{"password": "newpassword"}' \
426
- -v -u {email_address}:{password}
425
+ -d '{"password": "newpassword"}' \
426
+ -v -u {email_address}:{password} -X POST -H "Content-Type: application/json"
427
427
  ```
428
428
 
429
429
  #### Example Response
@@ -444,8 +444,8 @@ Status: 200
444
444
 
445
445
  ```bash
446
446
  curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/password.json \
447
- -X POST -d '{"previous_password": "oldpassword", "password": "newpassword"}' \
448
- -v -u {email_address}:{password}
447
+ -d '{"previous_password": "oldpassword", "password": "newpassword"}' \
448
+ -v -u {email_address}:{password} -X PUT -H "Content-Type: application/json"
449
449
  ```
450
450
 
451
451
  #### Example Response
@@ -1,5 +1,10 @@
1
1
  ## Views
2
2
 
3
+ A view consists of one or more conditions that define a collection of tickets to display. If the conditions are met, the ticket is included in the view. For example, a view can display all open tickets that were last updated more than 24 hours ago.
4
+
5
+ For more information, see [Using views to manage ticket workflow](https://support.zendesk.com/entries/20103667).
6
+
7
+
3
8
  ### JSON Format
4
9
  Views are represented as simple flat JSON objects which have the following keys.
5
10
 
@@ -59,10 +64,6 @@ View Execution is a read-only object that describes how to display a collection
59
64
  }
60
65
  ```
61
66
 
62
- # Deprecated
63
-
64
- #
65
-
66
67
  ### Conditions
67
68
  The conditions under which a ticket is selected.
68
69
 
@@ -244,7 +245,7 @@ Status: 200 OK
244
245
  ### List Views - Compact
245
246
  `GET /api/v2/views/compact.json`
246
247
 
247
- A compacted shared and personal Views available to the current user
248
+ A compacted list of shared and personal views available to the current user
248
249
 
249
250
  #### Allowed For:
250
251
 
@@ -371,6 +372,16 @@ Status: 200 OK
371
372
  ### Executing Views
372
373
  `GET /api/v2/views/{id}/execute.json`
373
374
 
375
+ You execute a view in order to get the tickets that fulfill the conditions of the view.
376
+
377
+ The view execution system is designed for periodic rather than high-frequency API usage. In particular, views that are called very
378
+ frequently by an API client (more often than once every 5 minutes on average) may be cached by our software. This means
379
+ that the API client will still receive a result however that result may have been computed at any time within the last 10
380
+ minutes.
381
+
382
+ If you are looking for a method to get the latest changes to your Zendesk via the API we recommend the ticket export API
383
+ which can be called as often as once a minute, and will return all the tickets changed since last poll.
384
+
374
385
  View output sorting can be controlled by passing the sort_by and sort_order parameters in the
375
386
  format described in the table under [view previewing](#previewing-views).
376
387
 
@@ -548,14 +559,14 @@ Status: 200 OK
548
559
  {
549
560
  "view_counts": [{
550
561
  "view_id": 25,
551
- "url": "https://company.zendesk.com/api/v2/rules/views/25/count.json",
562
+ "url": "https://company.zendesk.com/api/v2/views/25/count.json",
552
563
  "value": 719,
553
564
  "pretty": "~700",
554
565
  "fresh": true
555
566
  },
556
567
  {
557
568
  "view_id": 78,
558
- "url": "https://company.zendesk.com/api/v2/rules/views/78/count.json",
569
+ "url": "https://company.zendesk.com/api/v2/views/78/count.json",
559
570
  "value": null,
560
571
  "pretty": "...",
561
572
  "fresh": false
@@ -586,10 +597,48 @@ Status: 200 OK
586
597
  {
587
598
  "view_count": {
588
599
  "view_id": 25,
589
- "url": "https://company.zendesk.com/api/v2/rules/views/25/count.json",
600
+ "url": "https://company.zendesk.com/api/v2/views/25/count.json",
590
601
  "value": 719,
591
602
  "pretty": "~700",
592
603
  "fresh": true
593
604
  }
594
605
  }
606
+ ```
607
+
608
+ ### Exporting Views
609
+ `GET /api/v2/views/{id}/export.json`
610
+
611
+ Returns the csv attachment of the current view if possible.
612
+ Enqueues a job to produce the csv if needed.
613
+
614
+ #### Allowed For:
615
+
616
+ * Agents
617
+
618
+ #### Using curl
619
+
620
+ ```bash
621
+ curl https://{subdomain}.zendesk.com/api/v2/views/{id}/export.json \
622
+ -v -u {email_address}:{password}
623
+ ```
624
+
625
+ #### Example Responses
626
+
627
+ ##### With available data
628
+ ```http
629
+ Status: 200
630
+ Content-Disposition: Attachment
631
+ [CSV data]
632
+ ```
633
+
634
+ ##### Starting a CSV job
635
+ ```http
636
+ Status: 201
637
+
638
+ {
639
+ "export": {
640
+ "view_id": 25,
641
+ "status": "starting"
642
+ }
643
+ }
595
644
  ```
@@ -0,0 +1,131 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: ZendeskAPI
8
+
9
+ &mdash; Documentation by YARD 0.8.4.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (Z)</a> &raquo;
35
+
36
+
37
+ <span class="title">ZendeskAPI</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: ZendeskAPI
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/zendesk_api.rb<span class="defines">,<br />
83
+ lib/zendesk_api/verbs.rb,<br /> lib/zendesk_api/rescue.rb,<br /> lib/zendesk_api/client.rb,<br /> lib/zendesk_api/trackie.rb,<br /> lib/zendesk_api/version.rb,<br /> lib/zendesk_api/helpers.rb,<br /> lib/zendesk_api/actions.rb,<br /> lib/zendesk_api/resource.rb,<br /> lib/zendesk_api/resources.rb,<br /> lib/zendesk_api/lru_cache.rb,<br /> lib/zendesk_api/collection.rb,<br /> lib/zendesk_api/server/base.rb,<br /> lib/zendesk_api/sideloading.rb,<br /> lib/zendesk_api/association.rb,<br /> lib/zendesk_api/associations.rb,<br /> lib/zendesk_api/track_changes.rb,<br /> lib/zendesk_api/configuration.rb,<br /> lib/zendesk_api/console/extensions.rb,<br /> lib/zendesk_api/middleware/request/retry.rb,<br /> lib/zendesk_api/middleware/response/gzip.rb,<br /> lib/zendesk_api/middleware/request/upload.rb,<br /> lib/zendesk_api/middleware/response/logger.rb,<br /> lib/zendesk_api/middleware/response/deflate.rb,<br /> lib/zendesk_api/middleware/response/callback.rb,<br /> lib/zendesk_api/middleware/request/etag_cache.rb,<br /> lib/zendesk_api/middleware/response/parse_iso_dates.rb</span>
84
+ </dd>
85
+
86
+ </dl>
87
+ <div class="clear"></div>
88
+
89
+ <h2>Defined Under Namespace</h2>
90
+ <p class="children">
91
+
92
+
93
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">Console</a></span>, <span class='object_link'><a href="ZendeskAPI/Create.html" title="ZendeskAPI::Create (module)">Create</a></span>, <span class='object_link'><a href="ZendeskAPI/Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span>, <span class='object_link'><a href="ZendeskAPI/Read.html" title="ZendeskAPI::Read (module)">Read</a></span>, <span class='object_link'><a href="ZendeskAPI/Save.html" title="ZendeskAPI::Save (module)">Save</a></span>, <span class='object_link'><a href="ZendeskAPI/Server.html" title="ZendeskAPI::Server (module)">Server</a></span>, <span class='object_link'><a href="ZendeskAPI/Update.html" title="ZendeskAPI::Update (module)">Update</a></span>, <span class='object_link'><a href="ZendeskAPI/Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span>
94
+
95
+
96
+
97
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="ZendeskAPI/Ability.html" title="ZendeskAPI::Ability (class)">Ability</a></span>, <span class='object_link'><a href="ZendeskAPI/Activity.html" title="ZendeskAPI::Activity (class)">Activity</a></span>, <span class='object_link'><a href="ZendeskAPI/Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span>, <span class='object_link'><a href="ZendeskAPI/Automation.html" title="ZendeskAPI::Automation (class)">Automation</a></span>, <span class='object_link'><a href="ZendeskAPI/Bookmark.html" title="ZendeskAPI::Bookmark (class)">Bookmark</a></span>, <span class='object_link'><a href="ZendeskAPI/CRMData.html" title="ZendeskAPI::CRMData (class)">CRMData</a></span>, <span class='object_link'><a href="ZendeskAPI/CRMDataStatus.html" title="ZendeskAPI::CRMDataStatus (class)">CRMDataStatus</a></span>, <span class='object_link'><a href="ZendeskAPI/Category.html" title="ZendeskAPI::Category (class)">Category</a></span>, <span class='object_link'><a href="ZendeskAPI/Client.html" title="ZendeskAPI::Client (class)">Client</a></span>, <span class='object_link'><a href="ZendeskAPI/Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span>, <span class='object_link'><a href="ZendeskAPI/Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="ZendeskAPI/CreateResource.html" title="ZendeskAPI::CreateResource (class)">CreateResource</a></span>, <span class='object_link'><a href="ZendeskAPI/CustomRole.html" title="ZendeskAPI::CustomRole (class)">CustomRole</a></span>, <span class='object_link'><a href="ZendeskAPI/Data.html" title="ZendeskAPI::Data (class)">Data</a></span>, <span class='object_link'><a href="ZendeskAPI/DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span>, <span class='object_link'><a href="ZendeskAPI/DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span>, <span class='object_link'><a href="ZendeskAPI/FormatError.html" title="ZendeskAPI::FormatError (class)">FormatError</a></span>, <span class='object_link'><a href="ZendeskAPI/Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span>, <span class='object_link'><a href="ZendeskAPI/ForumSubscription.html" title="ZendeskAPI::ForumSubscription (class)">ForumSubscription</a></span>, <span class='object_link'><a href="ZendeskAPI/Group.html" title="ZendeskAPI::Group (class)">Group</a></span>, <span class='object_link'><a href="ZendeskAPI/GroupMembership.html" title="ZendeskAPI::GroupMembership (class)">GroupMembership</a></span>, <span class='object_link'><a href="ZendeskAPI/JobStatus.html" title="ZendeskAPI::JobStatus (class)">JobStatus</a></span>, <span class='object_link'><a href="ZendeskAPI/Locale.html" title="ZendeskAPI::Locale (class)">Locale</a></span>, <span class='object_link'><a href="ZendeskAPI/Macro.html" title="ZendeskAPI::Macro (class)">Macro</a></span>, <span class='object_link'><a href="ZendeskAPI/MobileDevice.html" title="ZendeskAPI::MobileDevice (class)">MobileDevice</a></span>, <span class='object_link'><a href="ZendeskAPI/Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span>, <span class='object_link'><a href="ZendeskAPI/ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span>, <span class='object_link'><a href="ZendeskAPI/Request.html" title="ZendeskAPI::Request (class)">Request</a></span>, <span class='object_link'><a href="ZendeskAPI/Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span>, <span class='object_link'><a href="ZendeskAPI/Role.html" title="ZendeskAPI::Role (class)">Role</a></span>, <span class='object_link'><a href="ZendeskAPI/RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span>, <span class='object_link'><a href="ZendeskAPI/SatisfactionRating.html" title="ZendeskAPI::SatisfactionRating (class)">SatisfactionRating</a></span>, <span class='object_link'><a href="ZendeskAPI/Search.html" title="ZendeskAPI::Search (class)">Search</a></span>, <span class='object_link'><a href="ZendeskAPI/Setting.html" title="ZendeskAPI::Setting (class)">Setting</a></span>, <span class='object_link'><a href="ZendeskAPI/SharingAgreement.html" title="ZendeskAPI::SharingAgreement (class)">SharingAgreement</a></span>, <span class='object_link'><a href="ZendeskAPI/SingularResource.html" title="ZendeskAPI::SingularResource (class)">SingularResource</a></span>, <span class='object_link'><a href="ZendeskAPI/SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span>, <span class='object_link'><a href="ZendeskAPI/Ticket.html" title="ZendeskAPI::Ticket (class)">Ticket</a></span>, <span class='object_link'><a href="ZendeskAPI/TicketField.html" title="ZendeskAPI::TicketField (class)">TicketField</a></span>, <span class='object_link'><a href="ZendeskAPI/TicketMetric.html" title="ZendeskAPI::TicketMetric (class)">TicketMetric</a></span>, <span class='object_link'><a href="ZendeskAPI/Topic.html" title="ZendeskAPI::Topic (class)">Topic</a></span>, <span class='object_link'><a href="ZendeskAPI/TopicComment.html" title="ZendeskAPI::TopicComment (class)">TopicComment</a></span>, <span class='object_link'><a href="ZendeskAPI/TopicSubscription.html" title="ZendeskAPI::TopicSubscription (class)">TopicSubscription</a></span>, <span class='object_link'><a href="ZendeskAPI/Trigger.html" title="ZendeskAPI::Trigger (class)">Trigger</a></span>, <span class='object_link'><a href="ZendeskAPI/UpdateResource.html" title="ZendeskAPI::UpdateResource (class)">UpdateResource</a></span>, <span class='object_link'><a href="ZendeskAPI/Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span>, <span class='object_link'><a href="ZendeskAPI/User.html" title="ZendeskAPI::User (class)">User</a></span>, <span class='object_link'><a href="ZendeskAPI/View.html" title="ZendeskAPI::View (class)">View</a></span>, <span class='object_link'><a href="ZendeskAPI/ViewCount.html" title="ZendeskAPI::ViewCount (class)">ViewCount</a></span>, <span class='object_link'><a href="ZendeskAPI/ViewRow.html" title="ZendeskAPI::ViewRow (class)">ViewRow</a></span>
98
+
99
+
100
+ </p>
101
+
102
+ <h2>Constant Summary</h2>
103
+
104
+ <dl class="constants">
105
+
106
+ <dt id="VERSION-constant" class="">VERSION =
107
+
108
+ </dt>
109
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.6</span><span class='tstring_end'>&quot;</span></span></pre></dd>
110
+
111
+ </dl>
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+ </div>
123
+
124
+ <div id="footer">
125
+ Generated on Mon Feb 11 17:45:36 2013 by
126
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
127
+ 0.8.4.1 (ruby-1.9.3).
128
+ </div>
129
+
130
+ </body>
131
+ </html>
@@ -0,0 +1,190 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: ZendeskAPI::Ability
8
+
9
+ &mdash; Documentation by YARD 0.8.4.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (A)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
36
+ &raquo;
37
+ <span class="title">Ability</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: ZendeskAPI::Ability
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></li>
82
+
83
+ <li class="next"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></li>
84
+
85
+ <li class="next">ZendeskAPI::Ability</li>
86
+
87
+ </ul>
88
+ <a href="#" class="inheritanceTree">show all</a>
89
+
90
+ </dd>
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r2 last">Defined in:</dt>
101
+ <dd class="r2 last">lib/zendesk_api/resources.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>Instance Attribute Summary</h2>
113
+
114
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
115
+ <p class="inherited"><span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">#error</a></span>, <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">#error_message</a></span></p>
116
+
117
+
118
+
119
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
120
+ <p class="inherited"><span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">#association</a></span>, <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">#response</a></span></p>
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <h2>Method Summary</h2>
137
+
138
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
139
+ <p class="inherited"><span class='object_link'><a href="Verbs.html#delete-instance_method" title="ZendeskAPI::Verbs#delete (method)">#delete</a></span>, <span class='object_link'><a href="Verbs.html#post-instance_method" title="ZendeskAPI::Verbs#post (method)">#post</a></span>, <span class='object_link'><a href="Verbs.html#put-instance_method" title="ZendeskAPI::Verbs#put (method)">#put</a></span></p>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
156
+ <p class="inherited"><span class='object_link'><a href="Data.html#%2F-instance_method" title="ZendeskAPI::Data#/ (method)">#/</a></span>, <span class='object_link'><a href="Data.html#%3D%3D-instance_method" title="ZendeskAPI::Data#== (method)">#==</a></span>, <span class='object_link'><a href="Data.html#format-class_method" title="ZendeskAPI::Data.format (method)">format</a></span>, <span class='object_link'><a href="Data.html#id-instance_method" title="ZendeskAPI::Data#id (method)">#id</a></span>, <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Data.html#new_record%3F-instance_method" title="ZendeskAPI::Data#new_record? (method)">#new_record?</a></span>, <span class='object_link'><a href="Data.html#path-instance_method" title="ZendeskAPI::Data#path (method)">#path</a></span>, <span class='object_link'><a href="Data.html#resource_name-class_method" title="ZendeskAPI::Data.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Data.html#singular_resource_name-class_method" title="ZendeskAPI::Data.singular_resource_name (method)">singular_resource_name</a></span>, <span class='object_link'><a href="Data.html#subclasses-class_method" title="ZendeskAPI::Data.subclasses (method)">subclasses</a></span>, <span class='object_link'><a href="Data.html#to_json-instance_method" title="ZendeskAPI::Data#to_json (method)">#to_json</a></span></p>
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <div id="constructor_details" class="method_details_list">
164
+ <h2>Constructor Details</h2>
165
+
166
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">ZendeskAPI::Data</a></span></p>
167
+
168
+ </div>
169
+ <div id="method_missing_details" class="method_details_list">
170
+ <h2>Dynamic Method Handling</h2>
171
+ <p class="notice super">
172
+ This class handles dynamic methods through the <tt>method_missing</tt> method
173
+
174
+ in the class <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">ZendeskAPI::Data</a></span>
175
+
176
+ </p>
177
+
178
+ </div>
179
+
180
+
181
+ </div>
182
+
183
+ <div id="footer">
184
+ Generated on Mon Feb 11 17:45:38 2013 by
185
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
+ 0.8.4.1 (ruby-1.9.3).
187
+ </div>
188
+
189
+ </body>
190
+ </html>