zendesk_api 0.2.6 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,258 @@
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::Resource
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 (R)</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">Resource</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::Resource
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::Resource</li>
86
+
87
+ </ul>
88
+ <a href="#" class="inheritanceTree">show all</a>
89
+
90
+ </dd>
91
+
92
+
93
+
94
+
95
+ <dt class="r2">Extended by:</dt>
96
+ <dd class="r2"><span class='object_link'><a href="Read.html" title="ZendeskAPI::Read (module)">Read</a></span></dd>
97
+
98
+
99
+
100
+
101
+ <dt class="r1">Includes:</dt>
102
+ <dd class="r1"><span class='object_link'><a href="Create.html" title="ZendeskAPI::Create (module)">Create</a></span>, <span class='object_link'><a href="Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span>, <span class='object_link'><a href="Update.html" title="ZendeskAPI::Update (module)">Update</a></span></dd>
103
+
104
+
105
+
106
+
107
+
108
+ <dt class="r2 last">Defined in:</dt>
109
+ <dd class="r2 last">lib/zendesk_api/resource.rb</dd>
110
+
111
+ </dl>
112
+ <div class="clear"></div>
113
+
114
+ <h2>Overview</h2><div class="docstring">
115
+ <div class="discussion">
116
+
117
+ <p>Represents a resource that can CRUD (create, read, update, delete).</p>
118
+
119
+
120
+ </div>
121
+ </div>
122
+ <div class="tags">
123
+
124
+
125
+ </div><div id="subclasses">
126
+ <h2>Direct Known Subclasses</h2>
127
+ <p class="children"><span class='object_link'><a href="Activity.html" title="ZendeskAPI::Activity (class)">Activity</a></span>, <span class='object_link'><a href="Automation.html" title="ZendeskAPI::Automation (class)">Automation</a></span>, <span class='object_link'><a href="Bookmark.html" title="ZendeskAPI::Bookmark (class)">Bookmark</a></span>, <span class='object_link'><a href="Category.html" title="ZendeskAPI::Category (class)">Category</a></span>, <span class='object_link'><a href="Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span>, <span class='object_link'><a href="ForumSubscription.html" title="ZendeskAPI::ForumSubscription (class)">ForumSubscription</a></span>, <span class='object_link'><a href="Group.html" title="ZendeskAPI::Group (class)">Group</a></span>, <span class='object_link'><a href="GroupMembership.html" title="ZendeskAPI::GroupMembership (class)">GroupMembership</a></span>, <span class='object_link'><a href="Macro.html" title="ZendeskAPI::Macro (class)">Macro</a></span>, <span class='object_link'><a href="MobileDevice.html" title="ZendeskAPI::MobileDevice (class)">MobileDevice</a></span>, <span class='object_link'><a href="Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Request.html" title="ZendeskAPI::Request (class)">Request</a></span>, <span class='object_link'><a href="SingularResource.html" title="ZendeskAPI::SingularResource (class)">SingularResource</a></span>, <span class='object_link'><a href="Ticket.html" title="ZendeskAPI::Ticket (class)">Ticket</a></span>, <span class='object_link'><a href="Ticket/Tag.html" title="ZendeskAPI::Ticket::Tag (class)">Ticket::Tag</a></span>, <span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">TicketField</a></span>, <span class='object_link'><a href="Topic.html" title="ZendeskAPI::Topic (class)">Topic</a></span>, <span class='object_link'><a href="TopicSubscription.html" title="ZendeskAPI::TopicSubscription (class)">TopicSubscription</a></span>, <span class='object_link'><a href="Trigger.html" title="ZendeskAPI::Trigger (class)">Trigger</a></span>, <span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">User</a></span>, <span class='object_link'><a href="User/Identity.html" title="ZendeskAPI::User::Identity (class)">User::Identity</a></span>, <span class='object_link'><a href="View.html" title="ZendeskAPI::View (class)">View</a></span></p>
128
+ </div>
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <h2>Instance Attribute Summary</h2>
136
+
137
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
138
+ <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>
139
+
140
+
141
+
142
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
143
+ <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>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <h2>Method Summary</h2>
154
+
155
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Read.html" title="ZendeskAPI::Read (module)">Read</a></span></h3>
156
+ <p class="inherited"><span class='object_link'><a href="Read.html#find-instance_method" title="ZendeskAPI::Read#find (method)">find</a></span></p>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span></h3>
173
+ <p class="inherited"><span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">#destroyed?</a></span></p>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
190
+ <p class="inherited"><span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">#clear_associations</a></span>, <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">#save</a></span>, <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">#save!</a></span>, <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">#save_associations</a></span></p>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
213
+ <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>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
224
+ <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>
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <div id="constructor_details" class="method_details_list">
232
+ <h2>Constructor Details</h2>
233
+
234
+ <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>
235
+
236
+ </div>
237
+ <div id="method_missing_details" class="method_details_list">
238
+ <h2>Dynamic Method Handling</h2>
239
+ <p class="notice super">
240
+ This class handles dynamic methods through the <tt>method_missing</tt> method
241
+
242
+ 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>
243
+
244
+ </p>
245
+
246
+ </div>
247
+
248
+
249
+ </div>
250
+
251
+ <div id="footer">
252
+ Generated on Mon Feb 11 17:45:36 2013 by
253
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
254
+ 0.8.4.1 (ruby-1.9.3).
255
+ </div>
256
+
257
+ </body>
258
+ </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::Role
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 (R)</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">Role</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::Role
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::Role</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>
@@ -0,0 +1,383 @@
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::RuleExecution
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 (R)</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">RuleExecution</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::RuleExecution
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="Data.html" title="ZendeskAPI::Data (class)">Data</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">ZendeskAPI::RuleExecution</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/zendesk_api/resources.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>Instance Attribute Summary</h2>
111
+
112
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
113
+ <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>
114
+
115
+
116
+
117
+ <h2>
118
+ Instance Method Summary
119
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
120
+ </h2>
121
+
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#custom_fields-instance_method" title="#custom_fields (instance method)">- (ZendeskAPI::TicketField) <strong>custom_fields</strong>(options = {}) </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'>
142
+ <p>The associated object.</p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ <li class="public ">
149
+ <span class="summary_signature">
150
+
151
+ <a href="#custom_fields%3D-instance_method" title="#custom_fields= (instance method)">- (ZendeskAPI::TicketField) <strong>custom_fields=</strong>(value) </a>
152
+
153
+
154
+
155
+ </span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>The associated object.</p>
167
+ </div></span>
168
+
169
+ </li>
170
+
171
+
172
+ </ul>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
185
+ <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>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <div id="constructor_details" class="method_details_list">
199
+ <h2>Constructor Details</h2>
200
+
201
+ <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>
202
+
203
+ </div>
204
+ <div id="method_missing_details" class="method_details_list">
205
+ <h2>Dynamic Method Handling</h2>
206
+ <p class="notice super">
207
+ This class handles dynamic methods through the <tt>method_missing</tt> method
208
+
209
+ 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>
210
+
211
+ </p>
212
+
213
+ </div>
214
+
215
+
216
+ <div id="instance_method_details" class="method_details_list">
217
+ <h2>Instance Method Details</h2>
218
+
219
+
220
+ <div class="method_details first">
221
+ <h3 class="signature first" id="custom_fields-instance_method">
222
+
223
+ - (<tt><span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">ZendeskAPI::TicketField</a></span></tt>) <strong>custom_fields</strong>(options = {})
224
+
225
+
226
+
227
+
228
+
229
+ </h3><div class="docstring">
230
+ <div class="discussion">
231
+
232
+ <p>The associated object</p>
233
+
234
+
235
+ </div>
236
+ </div>
237
+ <div class="tags">
238
+ <p class="tag_title">Parameters:</p>
239
+ <ul class="param">
240
+
241
+ <li>
242
+
243
+ <span class='name'>options</span>
244
+
245
+
246
+ <span class='type'>(<tt>Hash</tt>)</span>
247
+
248
+
249
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
250
+
251
+
252
+ &mdash;
253
+ <div class='inline'>
254
+ <p>Options to pass to the collection object</p>
255
+ </div>
256
+
257
+ </li>
258
+
259
+ </ul>
260
+
261
+ <p class="tag_title">Returns:</p>
262
+ <ul class="return">
263
+
264
+ <li>
265
+
266
+
267
+ <span class='type'>(<tt><span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">ZendeskAPI::TicketField</a></span></tt>)</span>
268
+
269
+
270
+
271
+ &mdash;
272
+ <div class='inline'>
273
+ <p>The associated object</p>
274
+ </div>
275
+
276
+ </li>
277
+
278
+ </ul>
279
+
280
+ </div><table class="source_code">
281
+ <tr>
282
+ <td>
283
+ <pre class="lines">
284
+
285
+
286
+ 280</pre>
287
+ </td>
288
+ <td>
289
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 280</span>
290
+
291
+ <span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:custom_fields</span><span class='comma'>,</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='const'>TicketField</span></pre>
292
+ </td>
293
+ </tr>
294
+ </table>
295
+ </div>
296
+
297
+ <div class="method_details ">
298
+ <h3 class="signature " id="custom_fields=-instance_method">
299
+
300
+ - (<tt><span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">ZendeskAPI::TicketField</a></span></tt>) <strong>custom_fields=</strong>(value)
301
+
302
+
303
+
304
+
305
+
306
+ </h3><div class="docstring">
307
+ <div class="discussion">
308
+
309
+ <p>The associated object</p>
310
+
311
+
312
+ </div>
313
+ </div>
314
+ <div class="tags">
315
+ <p class="tag_title">Parameters:</p>
316
+ <ul class="param">
317
+
318
+ <li>
319
+
320
+ <span class='name'>value</span>
321
+
322
+
323
+ <span class='type'>(<tt>Hash or <span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">ZendeskAPI::TicketField</a></span></tt>)</span>
324
+
325
+
326
+
327
+ &mdash;
328
+ <div class='inline'>
329
+ <p>The associated object or its attributes</p>
330
+ </div>
331
+
332
+ </li>
333
+
334
+ </ul>
335
+
336
+ <p class="tag_title">Returns:</p>
337
+ <ul class="return">
338
+
339
+ <li>
340
+
341
+
342
+ <span class='type'>(<tt><span class='object_link'><a href="TicketField.html" title="ZendeskAPI::TicketField (class)">ZendeskAPI::TicketField</a></span></tt>)</span>
343
+
344
+
345
+
346
+ &mdash;
347
+ <div class='inline'>
348
+ <p>The associated object</p>
349
+ </div>
350
+
351
+ </li>
352
+
353
+ </ul>
354
+
355
+ </div><table class="source_code">
356
+ <tr>
357
+ <td>
358
+ <pre class="lines">
359
+
360
+
361
+ 280</pre>
362
+ </td>
363
+ <td>
364
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 280</span>
365
+
366
+ <span class='id identifier rubyid_has_many'>has_many</span> <span class='symbol'>:custom_fields</span><span class='comma'>,</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='const'>TicketField</span></pre>
367
+ </td>
368
+ </tr>
369
+ </table>
370
+ </div>
371
+
372
+ </div>
373
+
374
+ </div>
375
+
376
+ <div id="footer">
377
+ Generated on Mon Feb 11 17:45:40 2013 by
378
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
379
+ 0.8.4.1 (ruby-1.9.3).
380
+ </div>
381
+
382
+ </body>
383
+ </html>