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.
- data/.gitignore +2 -1
- data/Gemfile +7 -0
- data/Gemfile.lock +10 -2
- data/LICENSE +176 -19
- data/Readme.md +13 -5
- data/config/newrelic.yml +255 -0
- data/lib/zendesk_api/association.rb +1 -1
- data/lib/zendesk_api/associations.rb +129 -100
- data/lib/zendesk_api/client.rb +44 -25
- data/lib/zendesk_api/collection.rb +83 -58
- data/lib/zendesk_api/console/extensions.rb +47 -28
- data/lib/zendesk_api/server/base.rb +4 -0
- data/lib/zendesk_api/server/docs/account_settings.md +8 -0
- data/lib/zendesk_api/server/docs/automations.md +6 -0
- data/lib/zendesk_api/server/docs/changes_roadmap.md +76 -1
- data/lib/zendesk_api/server/docs/forum_subscriptions.md +2 -2
- data/lib/zendesk_api/server/docs/introduction.md +4 -2
- data/lib/zendesk_api/server/docs/macros.md +2 -0
- data/lib/zendesk_api/server/docs/organizations.md +3 -4
- data/lib/zendesk_api/server/docs/requests.md +21 -7
- data/lib/zendesk_api/server/docs/tickets.md +64 -8
- data/lib/zendesk_api/server/docs/topic_subscriptions.md +3 -3
- data/lib/zendesk_api/server/docs/topic_votes.md +0 -1
- data/lib/zendesk_api/server/docs/triggers.md +7 -0
- data/lib/zendesk_api/server/docs/users.md +4 -4
- data/lib/zendesk_api/server/docs/views.md +57 -8
- data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +131 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +362 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +462 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +1490 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +2825 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +1212 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +860 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +134 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +322 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +222 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +1432 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +348 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +216 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +307 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +245 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/FormatError.html +123 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +1196 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +361 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +1016 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +278 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +220 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +826 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +604 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +258 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +383 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +938 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +510 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +403 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +166 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +131 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +523 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +684 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +303 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +508 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/UserRequest.html +125 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +244 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +350 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +247 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +342 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +2731 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +385 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +636 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +205 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +1086 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +232 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +624 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +743 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +140 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +237 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +222 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +404 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +3611 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +563 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +194 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +338 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +1283 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +1342 -0
- data/lib/zendesk_api/server/public/doc/_index.html +799 -0
- data/lib/zendesk_api/server/public/doc/class_list.html +53 -0
- data/lib/zendesk_api/server/public/doc/css/common.css +1 -0
- data/lib/zendesk_api/server/public/doc/css/full_list.css +57 -0
- data/lib/zendesk_api/server/public/doc/css/style.css +328 -0
- data/lib/zendesk_api/server/public/doc/file.Readme.html +377 -0
- data/lib/zendesk_api/server/public/doc/file_list.html +55 -0
- data/lib/zendesk_api/server/public/doc/frames.html +28 -0
- data/lib/zendesk_api/server/public/doc/index.html +377 -0
- data/lib/zendesk_api/server/public/doc/js/app.js +214 -0
- data/lib/zendesk_api/server/public/doc/js/full_list.js +173 -0
- data/lib/zendesk_api/server/public/doc/js/jquery.js +4 -0
- data/lib/zendesk_api/server/public/doc/method_list.html +2540 -0
- data/lib/zendesk_api/server/public/doc/top-level-namespace.html +144 -0
- data/lib/zendesk_api/version.rb +1 -1
- data/zendesk_api.gemspec +1 -1
- metadata +96 -3
@@ -0,0 +1,222 @@
|
|
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::CreateResource
|
8
|
+
|
9
|
+
— 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 (C)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">CreateResource</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::CreateResource
|
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::CreateResource</li>
|
86
|
+
|
87
|
+
</ul>
|
88
|
+
<a href="#" class="inheritanceTree">show all</a>
|
89
|
+
|
90
|
+
</dd>
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dt class="r2">Includes:</dt>
|
98
|
+
<dd class="r2"><span class='object_link'><a href="Create.html" title="ZendeskAPI::Create (module)">Create</a></span></dd>
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
<dt class="r1 last">Defined in:</dt>
|
105
|
+
<dd class="r1 last">lib/zendesk_api/resource.rb</dd>
|
106
|
+
|
107
|
+
</dl>
|
108
|
+
<div class="clear"></div>
|
109
|
+
|
110
|
+
<h2>Overview</h2><div class="docstring">
|
111
|
+
<div class="discussion">
|
112
|
+
|
113
|
+
<p>Represents a resource that can only POST</p>
|
114
|
+
|
115
|
+
|
116
|
+
</div>
|
117
|
+
</div>
|
118
|
+
<div class="tags">
|
119
|
+
|
120
|
+
|
121
|
+
</div>
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
<h2>Instance Attribute Summary</h2>
|
128
|
+
|
129
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
|
130
|
+
<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>
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
|
135
|
+
<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>
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
<h2>Method Summary</h2>
|
152
|
+
|
153
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
|
154
|
+
<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>
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
|
171
|
+
<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>
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
|
188
|
+
<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>
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
<div id="constructor_details" class="method_details_list">
|
196
|
+
<h2>Constructor Details</h2>
|
197
|
+
|
198
|
+
<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>
|
199
|
+
|
200
|
+
</div>
|
201
|
+
<div id="method_missing_details" class="method_details_list">
|
202
|
+
<h2>Dynamic Method Handling</h2>
|
203
|
+
<p class="notice super">
|
204
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
205
|
+
|
206
|
+
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>
|
207
|
+
|
208
|
+
</p>
|
209
|
+
|
210
|
+
</div>
|
211
|
+
|
212
|
+
|
213
|
+
</div>
|
214
|
+
|
215
|
+
<div id="footer">
|
216
|
+
Generated on Mon Feb 11 17:45:36 2013 by
|
217
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
218
|
+
0.8.4.1 (ruby-1.9.3).
|
219
|
+
</div>
|
220
|
+
|
221
|
+
</body>
|
222
|
+
</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::CustomRole
|
8
|
+
|
9
|
+
— 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 (C)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">CustomRole</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::CustomRole
|
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::CustomRole</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,1432 @@
|
|
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::Data
|
8
|
+
|
9
|
+
— 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 (D)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Data</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::Data
|
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">Object</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">ZendeskAPI::Data</li>
|
82
|
+
|
83
|
+
</ul>
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
85
|
+
|
86
|
+
</dd>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
97
|
+
<dd class="r2 last">lib/zendesk_api/resource.rb<span class="defines">,<br />
|
98
|
+
lib/zendesk_api/console/extensions.rb</span>
|
99
|
+
</dd>
|
100
|
+
|
101
|
+
</dl>
|
102
|
+
<div class="clear"></div>
|
103
|
+
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
|
107
|
+
<p>Represents a resource that only holds data.</p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div><div id="subclasses">
|
116
|
+
<h2>Direct Known Subclasses</h2>
|
117
|
+
<p class="children"><span class='object_link'><a href="Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span>, <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span>, <span class='object_link'><a href="RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span>, <span class='object_link'><a href="Search/Result.html" title="ZendeskAPI::Search::Result (class)">Search::Result</a></span>, <span class='object_link'><a href="Ticket/Comment.html" title="ZendeskAPI::Ticket::Comment (class)">Ticket::Comment</a></span>, <span class='object_link'><a href="TopicComment.html" title="ZendeskAPI::TopicComment (class)">TopicComment</a></span>, <span class='object_link'><a href="Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span></p>
|
118
|
+
</div>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
<h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
124
|
+
<ul class="summary">
|
125
|
+
|
126
|
+
<li class="public ">
|
127
|
+
<span class="summary_signature">
|
128
|
+
|
129
|
+
<a href="#format_headers-class_method" title="format_headers (class method)">+ (Object) <strong>format_headers</strong> </a>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
</span>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<span class="summary_desc"><div class='inline'>
|
147
|
+
<p>Returns the value of attribute format_headers.</p>
|
148
|
+
</div></span>
|
149
|
+
|
150
|
+
</li>
|
151
|
+
|
152
|
+
|
153
|
+
</ul>
|
154
|
+
|
155
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
156
|
+
<ul class="summary">
|
157
|
+
|
158
|
+
<li class="public ">
|
159
|
+
<span class="summary_signature">
|
160
|
+
|
161
|
+
<a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
</span>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
<span class="summary_desc"><div class='inline'>
|
179
|
+
<p>The association.</p>
|
180
|
+
</div></span>
|
181
|
+
|
182
|
+
</li>
|
183
|
+
|
184
|
+
|
185
|
+
<li class="public ">
|
186
|
+
<span class="summary_signature">
|
187
|
+
|
188
|
+
<a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
(also: #to_param)
|
193
|
+
|
194
|
+
</span>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
<span class="note title readonly">readonly</span>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
<span class="summary_desc"><div class='inline'>
|
210
|
+
<p>The resource's attributes.</p>
|
211
|
+
</div></span>
|
212
|
+
|
213
|
+
</li>
|
214
|
+
|
215
|
+
|
216
|
+
<li class="public ">
|
217
|
+
<span class="summary_signature">
|
218
|
+
|
219
|
+
<a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
</span>
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
<span class="summary_desc"><div class='inline'>
|
237
|
+
<p>Place to dump the last response.</p>
|
238
|
+
</div></span>
|
239
|
+
|
240
|
+
</li>
|
241
|
+
|
242
|
+
|
243
|
+
</ul>
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
<h2>
|
250
|
+
Class Method Summary
|
251
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
252
|
+
</h2>
|
253
|
+
|
254
|
+
<ul class="summary">
|
255
|
+
|
256
|
+
<li class="public ">
|
257
|
+
<span class="summary_signature">
|
258
|
+
|
259
|
+
<a href="#format-class_method" title="format (class method)">+ (Object) <strong>format</strong>(client = nil, &block) </a>
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</span>
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
274
|
+
|
275
|
+
</li>
|
276
|
+
|
277
|
+
|
278
|
+
<li class="public ">
|
279
|
+
<span class="summary_signature">
|
280
|
+
|
281
|
+
<a href="#resource_name-class_method" title="resource_name (class method)">+ (Object) <strong>resource_name</strong> </a>
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
(also: model_key)
|
286
|
+
|
287
|
+
</span>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
<span class="summary_desc"><div class='inline'>
|
298
|
+
<p>The resource name taken from the class name (e.g. ZendeskAPI::Ticket ->
|
299
|
+
tickets).</p>
|
300
|
+
</div></span>
|
301
|
+
|
302
|
+
</li>
|
303
|
+
|
304
|
+
|
305
|
+
<li class="public ">
|
306
|
+
<span class="summary_signature">
|
307
|
+
|
308
|
+
<a href="#singular_resource_name-class_method" title="singular_resource_name (class method)">+ (Object) <strong>singular_resource_name</strong> </a>
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
</span>
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
<span class="summary_desc"><div class='inline'>
|
323
|
+
<p>The singular resource name taken from the class name (e.g.
|
324
|
+
ZendeskAPI::Ticket -> ticket).</p>
|
325
|
+
</div></span>
|
326
|
+
|
327
|
+
</li>
|
328
|
+
|
329
|
+
|
330
|
+
<li class="public ">
|
331
|
+
<span class="summary_signature">
|
332
|
+
|
333
|
+
<a href="#subclasses-class_method" title="subclasses (class method)">+ (Object) <strong>subclasses</strong> </a>
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
</span>
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
348
|
+
|
349
|
+
</li>
|
350
|
+
|
351
|
+
|
352
|
+
</ul>
|
353
|
+
|
354
|
+
<h2>
|
355
|
+
Instance Method Summary
|
356
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
357
|
+
</h2>
|
358
|
+
|
359
|
+
<ul class="summary">
|
360
|
+
|
361
|
+
<li class="public ">
|
362
|
+
<span class="summary_signature">
|
363
|
+
|
364
|
+
<a href="#%2F-instance_method" title="#/ (instance method)">- (Object) <strong>/</strong>(method) </a>
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
</span>
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
379
|
+
|
380
|
+
</li>
|
381
|
+
|
382
|
+
|
383
|
+
<li class="public ">
|
384
|
+
<span class="summary_signature">
|
385
|
+
|
386
|
+
<a href="#%3D%3D-instance_method" title="#== (instance method)">- (Object) <strong>==</strong>(other) </a>
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
(also: #eql)
|
391
|
+
|
392
|
+
</span>
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
<span class="summary_desc"><div class='inline'>
|
403
|
+
<p>Compares resources by class and id.</p>
|
404
|
+
</div></span>
|
405
|
+
|
406
|
+
</li>
|
407
|
+
|
408
|
+
|
409
|
+
<li class="public ">
|
410
|
+
<span class="summary_signature">
|
411
|
+
|
412
|
+
<a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
(also: #hash)
|
417
|
+
|
418
|
+
</span>
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
<span class="summary_desc"><div class='inline'>
|
429
|
+
<p>Returns the resource id of the object or nil.</p>
|
430
|
+
</div></span>
|
431
|
+
|
432
|
+
</li>
|
433
|
+
|
434
|
+
|
435
|
+
<li class="public ">
|
436
|
+
<span class="summary_signature">
|
437
|
+
|
438
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Data) <strong>initialize</strong>(client, attributes = {}) </a>
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
</span>
|
443
|
+
|
444
|
+
|
445
|
+
<span class="note title constructor">constructor</span>
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
<span class="summary_desc"><div class='inline'>
|
455
|
+
<p>Create a new resource instance.</p>
|
456
|
+
</div></span>
|
457
|
+
|
458
|
+
</li>
|
459
|
+
|
460
|
+
|
461
|
+
<li class="public ">
|
462
|
+
<span class="summary_signature">
|
463
|
+
|
464
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(*args, &block) </a>
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
</span>
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
<span class="summary_desc"><div class='inline'>
|
479
|
+
<p>Passes the method onto the attributes hash.</p>
|
480
|
+
</div></span>
|
481
|
+
|
482
|
+
</li>
|
483
|
+
|
484
|
+
|
485
|
+
<li class="public ">
|
486
|
+
<span class="summary_signature">
|
487
|
+
|
488
|
+
<a href="#new_record%3F-instance_method" title="#new_record? (instance method)">- (Boolean) <strong>new_record?</strong> </a>
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
</span>
|
493
|
+
|
494
|
+
|
495
|
+
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
<span class="summary_desc"><div class='inline'>
|
503
|
+
<p>Has this been object been created server-side? Does this by checking for an
|
504
|
+
id.</p>
|
505
|
+
</div></span>
|
506
|
+
|
507
|
+
</li>
|
508
|
+
|
509
|
+
|
510
|
+
<li class="public ">
|
511
|
+
<span class="summary_signature">
|
512
|
+
|
513
|
+
<a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong>(*args) </a>
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
</span>
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
<span class="summary_desc"><div class='inline'>
|
528
|
+
<p>Returns the path to the resource.</p>
|
529
|
+
</div></span>
|
530
|
+
|
531
|
+
</li>
|
532
|
+
|
533
|
+
|
534
|
+
<li class="public ">
|
535
|
+
<span class="summary_signature">
|
536
|
+
|
537
|
+
<a href="#to_json-instance_method" title="#to_json (instance method)">- (Object) <strong>to_json</strong>(*args) </a>
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
</span>
|
542
|
+
|
543
|
+
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
<span class="summary_desc"><div class='inline'>
|
552
|
+
<p>Passes #to_json to the underlying attributes hash.</p>
|
553
|
+
</div></span>
|
554
|
+
|
555
|
+
</li>
|
556
|
+
|
557
|
+
|
558
|
+
</ul>
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
<div id="constructor_details" class="method_details_list">
|
574
|
+
<h2>Constructor Details</h2>
|
575
|
+
|
576
|
+
<div class="method_details first">
|
577
|
+
<h3 class="signature first" id="initialize-instance_method">
|
578
|
+
|
579
|
+
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Data (class)">Data</a></span></tt>) <strong>initialize</strong>(client, attributes = {})
|
580
|
+
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
</h3><div class="docstring">
|
586
|
+
<div class="discussion">
|
587
|
+
|
588
|
+
<p>Create a new resource instance.</p>
|
589
|
+
|
590
|
+
|
591
|
+
</div>
|
592
|
+
</div>
|
593
|
+
<div class="tags">
|
594
|
+
<p class="tag_title">Parameters:</p>
|
595
|
+
<ul class="param">
|
596
|
+
|
597
|
+
<li>
|
598
|
+
|
599
|
+
<span class='name'>client</span>
|
600
|
+
|
601
|
+
|
602
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
—
|
607
|
+
<div class='inline'>
|
608
|
+
<p>The client to use</p>
|
609
|
+
</div>
|
610
|
+
|
611
|
+
</li>
|
612
|
+
|
613
|
+
<li>
|
614
|
+
|
615
|
+
<span class='name'>attributes</span>
|
616
|
+
|
617
|
+
|
618
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
619
|
+
|
620
|
+
|
621
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
622
|
+
|
623
|
+
|
624
|
+
—
|
625
|
+
<div class='inline'>
|
626
|
+
<p>The optional attributes that describe the resource</p>
|
627
|
+
</div>
|
628
|
+
|
629
|
+
</li>
|
630
|
+
|
631
|
+
</ul>
|
632
|
+
|
633
|
+
|
634
|
+
</div><table class="source_code">
|
635
|
+
<tr>
|
636
|
+
<td>
|
637
|
+
<pre class="lines">
|
638
|
+
|
639
|
+
|
640
|
+
57
|
641
|
+
58
|
642
|
+
59
|
643
|
+
60
|
644
|
+
61
|
645
|
+
62
|
646
|
+
63
|
647
|
+
64
|
648
|
+
65
|
649
|
+
66
|
650
|
+
67
|
651
|
+
68</pre>
|
652
|
+
</td>
|
653
|
+
<td>
|
654
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 57</span>
|
655
|
+
|
656
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
657
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Expected a Hash for attributes, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
658
|
+
<span class='ivar'>@association</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:association</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='const'>Association</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:class</span> <span class='op'>=></span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span>
|
659
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
660
|
+
<span class='ivar'>@attributes</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Trackie</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
661
|
+
|
662
|
+
<span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_associations'>associations</span><span class='period'>.</span><span class='id identifier rubyid_none?'>none?</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span><span class='rbrace'>}</span>
|
663
|
+
<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_check_deprecated_namespace_usage'>check_deprecated_namespace_usage</span> <span class='ivar'>@attributes</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span>
|
664
|
+
<span class='kw'>end</span>
|
665
|
+
|
666
|
+
<span class='ivar'>@attributes</span><span class='period'>.</span><span class='id identifier rubyid_clear_changes'>clear_changes</span> <span class='kw'>unless</span> <span class='id identifier rubyid_new_record?'>new_record?</span>
|
667
|
+
<span class='kw'>end</span></pre>
|
668
|
+
</td>
|
669
|
+
</tr>
|
670
|
+
</table>
|
671
|
+
</div>
|
672
|
+
|
673
|
+
</div>
|
674
|
+
<div id="method_missing_details" class="method_details_list">
|
675
|
+
<h2>Dynamic Method Handling</h2>
|
676
|
+
<p class="notice this">
|
677
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
678
|
+
|
679
|
+
</p>
|
680
|
+
|
681
|
+
<div class="method_details first">
|
682
|
+
<h3 class="signature first" id="method_missing-instance_method">
|
683
|
+
|
684
|
+
- (<tt>Object</tt>) <strong>method_missing</strong>(*args, &block)
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
</h3><div class="docstring">
|
691
|
+
<div class="discussion">
|
692
|
+
|
693
|
+
<p>Passes the method onto the attributes hash. If the attributes are nested
|
694
|
+
(e.g. { :tickets => { :id => 1 } }), passes the method onto the
|
695
|
+
nested hash.</p>
|
696
|
+
|
697
|
+
|
698
|
+
</div>
|
699
|
+
</div>
|
700
|
+
<div class="tags">
|
701
|
+
|
702
|
+
<p class="tag_title">Raises:</p>
|
703
|
+
<ul class="raise">
|
704
|
+
|
705
|
+
<li>
|
706
|
+
|
707
|
+
|
708
|
+
<span class='type'>(<tt>NoMethodError</tt>)</span>
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
</li>
|
713
|
+
|
714
|
+
</ul>
|
715
|
+
|
716
|
+
</div><table class="source_code">
|
717
|
+
<tr>
|
718
|
+
<td>
|
719
|
+
<pre class="lines">
|
720
|
+
|
721
|
+
|
722
|
+
72
|
723
|
+
73
|
724
|
+
74
|
725
|
+
75</pre>
|
726
|
+
</td>
|
727
|
+
<td>
|
728
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 72</span>
|
729
|
+
|
730
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
731
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NoMethodError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:save is not defined</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>==</span> <span class='symbol'>:save</span>
|
732
|
+
<span class='ivar'>@attributes</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
733
|
+
<span class='kw'>end</span></pre>
|
734
|
+
</td>
|
735
|
+
</tr>
|
736
|
+
</table>
|
737
|
+
</div>
|
738
|
+
|
739
|
+
</div>
|
740
|
+
|
741
|
+
<div id="class_attr_details" class="attr_details">
|
742
|
+
<h2>Class Attribute Details</h2>
|
743
|
+
|
744
|
+
|
745
|
+
<span id="format_headers=-class_method"></span>
|
746
|
+
<div class="method_details first">
|
747
|
+
<h3 class="signature first" id="format_headers-class_method">
|
748
|
+
|
749
|
+
+ (<tt>Object</tt>) <strong>format_headers</strong>
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
</h3><div class="docstring">
|
756
|
+
<div class="discussion">
|
757
|
+
|
758
|
+
<p>Returns the value of attribute format_headers</p>
|
759
|
+
|
760
|
+
|
761
|
+
</div>
|
762
|
+
</div>
|
763
|
+
<div class="tags">
|
764
|
+
|
765
|
+
|
766
|
+
</div><table class="source_code">
|
767
|
+
<tr>
|
768
|
+
<td>
|
769
|
+
<pre class="lines">
|
770
|
+
|
771
|
+
|
772
|
+
94
|
773
|
+
95
|
774
|
+
96</pre>
|
775
|
+
</td>
|
776
|
+
<td>
|
777
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 94</span>
|
778
|
+
|
779
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_headers'>format_headers</span>
|
780
|
+
<span class='ivar'>@format_headers</span>
|
781
|
+
<span class='kw'>end</span></pre>
|
782
|
+
</td>
|
783
|
+
</tr>
|
784
|
+
</table>
|
785
|
+
</div>
|
786
|
+
|
787
|
+
</div>
|
788
|
+
|
789
|
+
<div id="instance_attr_details" class="attr_details">
|
790
|
+
<h2>Instance Attribute Details</h2>
|
791
|
+
|
792
|
+
|
793
|
+
<span id="association=-instance_method"></span>
|
794
|
+
<div class="method_details first">
|
795
|
+
<h3 class="signature first" id="association-instance_method">
|
796
|
+
|
797
|
+
- (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong>
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
</h3><div class="docstring">
|
804
|
+
<div class="discussion">
|
805
|
+
|
806
|
+
<p>The association</p>
|
807
|
+
|
808
|
+
|
809
|
+
</div>
|
810
|
+
</div>
|
811
|
+
<div class="tags">
|
812
|
+
|
813
|
+
<p class="tag_title">Returns:</p>
|
814
|
+
<ul class="return">
|
815
|
+
|
816
|
+
<li>
|
817
|
+
|
818
|
+
|
819
|
+
<span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
—
|
824
|
+
<div class='inline'>
|
825
|
+
<p>The association</p>
|
826
|
+
</div>
|
827
|
+
|
828
|
+
</li>
|
829
|
+
|
830
|
+
</ul>
|
831
|
+
|
832
|
+
</div><table class="source_code">
|
833
|
+
<tr>
|
834
|
+
<td>
|
835
|
+
<pre class="lines">
|
836
|
+
|
837
|
+
|
838
|
+
49
|
839
|
+
50
|
840
|
+
51</pre>
|
841
|
+
</td>
|
842
|
+
<td>
|
843
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 49</span>
|
844
|
+
|
845
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_association'>association</span>
|
846
|
+
<span class='ivar'>@association</span>
|
847
|
+
<span class='kw'>end</span></pre>
|
848
|
+
</td>
|
849
|
+
</tr>
|
850
|
+
</table>
|
851
|
+
</div>
|
852
|
+
|
853
|
+
|
854
|
+
<span id=""></span>
|
855
|
+
<div class="method_details ">
|
856
|
+
<h3 class="signature " id="attributes-instance_method">
|
857
|
+
|
858
|
+
- (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span>
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
<span class="aliases">Also known as:
|
863
|
+
<span class="names"><span id='to_param-instance_method'>to_param</span></span>
|
864
|
+
</span>
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
</h3><div class="docstring">
|
869
|
+
<div class="discussion">
|
870
|
+
|
871
|
+
<p>The resource's attributes</p>
|
872
|
+
|
873
|
+
|
874
|
+
</div>
|
875
|
+
</div>
|
876
|
+
<div class="tags">
|
877
|
+
|
878
|
+
<p class="tag_title">Returns:</p>
|
879
|
+
<ul class="return">
|
880
|
+
|
881
|
+
<li>
|
882
|
+
|
883
|
+
|
884
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
—
|
889
|
+
<div class='inline'>
|
890
|
+
<p>The resource's attributes</p>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
</li>
|
894
|
+
|
895
|
+
</ul>
|
896
|
+
|
897
|
+
</div><table class="source_code">
|
898
|
+
<tr>
|
899
|
+
<td>
|
900
|
+
<pre class="lines">
|
901
|
+
|
902
|
+
|
903
|
+
47
|
904
|
+
48
|
905
|
+
49</pre>
|
906
|
+
</td>
|
907
|
+
<td>
|
908
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 47</span>
|
909
|
+
|
910
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_attributes'>attributes</span>
|
911
|
+
<span class='ivar'>@attributes</span>
|
912
|
+
<span class='kw'>end</span></pre>
|
913
|
+
</td>
|
914
|
+
</tr>
|
915
|
+
</table>
|
916
|
+
</div>
|
917
|
+
|
918
|
+
|
919
|
+
<span id="response=-instance_method"></span>
|
920
|
+
<div class="method_details ">
|
921
|
+
<h3 class="signature " id="response-instance_method">
|
922
|
+
|
923
|
+
- (<tt>Object</tt>) <strong>response</strong>
|
924
|
+
|
925
|
+
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
</h3><div class="docstring">
|
930
|
+
<div class="discussion">
|
931
|
+
|
932
|
+
<p>Place to dump the last response</p>
|
933
|
+
|
934
|
+
|
935
|
+
</div>
|
936
|
+
</div>
|
937
|
+
<div class="tags">
|
938
|
+
|
939
|
+
|
940
|
+
</div><table class="source_code">
|
941
|
+
<tr>
|
942
|
+
<td>
|
943
|
+
<pre class="lines">
|
944
|
+
|
945
|
+
|
946
|
+
52
|
947
|
+
53
|
948
|
+
54</pre>
|
949
|
+
</td>
|
950
|
+
<td>
|
951
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 52</span>
|
952
|
+
|
953
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
954
|
+
<span class='ivar'>@response</span>
|
955
|
+
<span class='kw'>end</span></pre>
|
956
|
+
</td>
|
957
|
+
</tr>
|
958
|
+
</table>
|
959
|
+
</div>
|
960
|
+
|
961
|
+
</div>
|
962
|
+
|
963
|
+
|
964
|
+
<div id="class_method_details" class="method_details_list">
|
965
|
+
<h2>Class Method Details</h2>
|
966
|
+
|
967
|
+
|
968
|
+
<div class="method_details first">
|
969
|
+
<h3 class="signature first" id="format-class_method">
|
970
|
+
|
971
|
+
+ (<tt>Object</tt>) <strong>format</strong>(client = nil, &block)
|
972
|
+
|
973
|
+
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
</h3><table class="source_code">
|
978
|
+
<tr>
|
979
|
+
<td>
|
980
|
+
<pre class="lines">
|
981
|
+
|
982
|
+
|
983
|
+
96
|
984
|
+
97
|
985
|
+
98
|
986
|
+
99
|
987
|
+
100
|
988
|
+
101
|
989
|
+
102
|
990
|
+
103
|
991
|
+
104
|
992
|
+
105
|
993
|
+
106
|
994
|
+
107
|
995
|
+
108</pre>
|
996
|
+
</td>
|
997
|
+
<td>
|
998
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 96</span>
|
999
|
+
|
1000
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format'>format</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
1001
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
1002
|
+
<span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
|
1003
|
+
<span class='id identifier rubyid_define_method'>define_method</span> <span class='symbol'>:format</span> <span class='kw'>do</span>
|
1004
|
+
<span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span>
|
1005
|
+
<span class='kw'>end</span>
|
1006
|
+
<span class='kw'>end</span>
|
1007
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_client'>client</span> <span class='op'>&&</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span>
|
1008
|
+
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1009
|
+
<span class='kw'>else</span>
|
1010
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='rbracket'>]</span>
|
1011
|
+
<span class='kw'>end</span>
|
1012
|
+
<span class='kw'>end</span></pre>
|
1013
|
+
</td>
|
1014
|
+
</tr>
|
1015
|
+
</table>
|
1016
|
+
</div>
|
1017
|
+
|
1018
|
+
<div class="method_details ">
|
1019
|
+
<h3 class="signature " id="resource_name-class_method">
|
1020
|
+
|
1021
|
+
+ (<tt>Object</tt>) <strong>resource_name</strong>
|
1022
|
+
|
1023
|
+
|
1024
|
+
|
1025
|
+
<span class="aliases">Also known as:
|
1026
|
+
<span class="names"><span id='model_key-class_method'>model_key</span></span>
|
1027
|
+
</span>
|
1028
|
+
|
1029
|
+
|
1030
|
+
|
1031
|
+
</h3><div class="docstring">
|
1032
|
+
<div class="discussion">
|
1033
|
+
|
1034
|
+
<p>The resource name taken from the class name (e.g. ZendeskAPI::Ticket ->
|
1035
|
+
tickets)</p>
|
1036
|
+
|
1037
|
+
|
1038
|
+
</div>
|
1039
|
+
</div>
|
1040
|
+
<div class="tags">
|
1041
|
+
|
1042
|
+
|
1043
|
+
</div><table class="source_code">
|
1044
|
+
<tr>
|
1045
|
+
<td>
|
1046
|
+
<pre class="lines">
|
1047
|
+
|
1048
|
+
|
1049
|
+
29
|
1050
|
+
30
|
1051
|
+
31</pre>
|
1052
|
+
</td>
|
1053
|
+
<td>
|
1054
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 29</span>
|
1055
|
+
|
1056
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resource_name'>resource_name</span>
|
1057
|
+
<span class='ivar'>@resource_name</span> <span class='op'>||=</span> <span class='const'>Inflection</span><span class='period'>.</span><span class='id identifier rubyid_plural'>plural</span><span class='lparen'>(</span><span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span><span class='rparen'>)</span>
|
1058
|
+
<span class='kw'>end</span></pre>
|
1059
|
+
</td>
|
1060
|
+
</tr>
|
1061
|
+
</table>
|
1062
|
+
</div>
|
1063
|
+
|
1064
|
+
<div class="method_details ">
|
1065
|
+
<h3 class="signature " id="singular_resource_name-class_method">
|
1066
|
+
|
1067
|
+
+ (<tt>Object</tt>) <strong>singular_resource_name</strong>
|
1068
|
+
|
1069
|
+
|
1070
|
+
|
1071
|
+
|
1072
|
+
|
1073
|
+
</h3><div class="docstring">
|
1074
|
+
<div class="discussion">
|
1075
|
+
|
1076
|
+
<p>The singular resource name taken from the class name (e.g.
|
1077
|
+
ZendeskAPI::Ticket -> ticket)</p>
|
1078
|
+
|
1079
|
+
|
1080
|
+
</div>
|
1081
|
+
</div>
|
1082
|
+
<div class="tags">
|
1083
|
+
|
1084
|
+
|
1085
|
+
</div><table class="source_code">
|
1086
|
+
<tr>
|
1087
|
+
<td>
|
1088
|
+
<pre class="lines">
|
1089
|
+
|
1090
|
+
|
1091
|
+
24
|
1092
|
+
25
|
1093
|
+
26</pre>
|
1094
|
+
</td>
|
1095
|
+
<td>
|
1096
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 24</span>
|
1097
|
+
|
1098
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span>
|
1099
|
+
<span class='ivar'>@singular_resource_name</span> <span class='op'>||=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Helpers</span><span class='period'>.</span><span class='id identifier rubyid_snakecase_string'>snakecase_string</span><span class='lparen'>(</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>::</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span>
|
1100
|
+
<span class='kw'>end</span></pre>
|
1101
|
+
</td>
|
1102
|
+
</tr>
|
1103
|
+
</table>
|
1104
|
+
</div>
|
1105
|
+
|
1106
|
+
<div class="method_details ">
|
1107
|
+
<h3 class="signature " id="subclasses-class_method">
|
1108
|
+
|
1109
|
+
+ (<tt>Object</tt>) <strong>subclasses</strong>
|
1110
|
+
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
|
1115
|
+
</h3><table class="source_code">
|
1116
|
+
<tr>
|
1117
|
+
<td>
|
1118
|
+
<pre class="lines">
|
1119
|
+
|
1120
|
+
|
1121
|
+
19
|
1122
|
+
20
|
1123
|
+
21</pre>
|
1124
|
+
</td>
|
1125
|
+
<td>
|
1126
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 19</span>
|
1127
|
+
|
1128
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_subclasses'>subclasses</span>
|
1129
|
+
<span class='ivar'>@subclasses</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
1130
|
+
<span class='kw'>end</span></pre>
|
1131
|
+
</td>
|
1132
|
+
</tr>
|
1133
|
+
</table>
|
1134
|
+
</div>
|
1135
|
+
|
1136
|
+
</div>
|
1137
|
+
|
1138
|
+
<div id="instance_method_details" class="method_details_list">
|
1139
|
+
<h2>Instance Method Details</h2>
|
1140
|
+
|
1141
|
+
|
1142
|
+
<div class="method_details first">
|
1143
|
+
<h3 class="signature first" id="/-instance_method">
|
1144
|
+
|
1145
|
+
- (<tt>Object</tt>) <strong>/</strong>(method)
|
1146
|
+
|
1147
|
+
|
1148
|
+
|
1149
|
+
|
1150
|
+
|
1151
|
+
</h3><table class="source_code">
|
1152
|
+
<tr>
|
1153
|
+
<td>
|
1154
|
+
<pre class="lines">
|
1155
|
+
|
1156
|
+
|
1157
|
+
79
|
1158
|
+
80
|
1159
|
+
81
|
1160
|
+
82
|
1161
|
+
83
|
1162
|
+
84
|
1163
|
+
85
|
1164
|
+
86
|
1165
|
+
87
|
1166
|
+
88
|
1167
|
+
89
|
1168
|
+
90
|
1169
|
+
91</pre>
|
1170
|
+
</td>
|
1171
|
+
<td>
|
1172
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 79</span>
|
1173
|
+
|
1174
|
+
<span class='kw'>def</span> <span class='op'>/</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
|
1175
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_method'>method</span> <span class='op'>==</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Console</span><span class='op'>::</span><span class='const'>ZD_DIRUP</span>
|
1176
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
|
1177
|
+
<span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
|
1178
|
+
<span class='kw'>elsif</span> <span class='lparen'>(</span><span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_resource_name'>resource_name</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span>
|
1179
|
+
<span class='id identifier rubyid_res'>res</span>
|
1180
|
+
<span class='kw'>else</span>
|
1181
|
+
<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span>
|
1182
|
+
<span class='kw'>end</span>
|
1183
|
+
<span class='kw'>else</span>
|
1184
|
+
<span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
|
1185
|
+
<span class='kw'>end</span>
|
1186
|
+
<span class='kw'>end</span></pre>
|
1187
|
+
</td>
|
1188
|
+
</tr>
|
1189
|
+
</table>
|
1190
|
+
</div>
|
1191
|
+
|
1192
|
+
<div class="method_details ">
|
1193
|
+
<h3 class="signature " id="==-instance_method">
|
1194
|
+
|
1195
|
+
- (<tt>Object</tt>) <strong>==</strong>(other)
|
1196
|
+
|
1197
|
+
|
1198
|
+
|
1199
|
+
<span class="aliases">Also known as:
|
1200
|
+
<span class="names"><span id='eql-instance_method'>eql</span></span>
|
1201
|
+
</span>
|
1202
|
+
|
1203
|
+
|
1204
|
+
|
1205
|
+
</h3><div class="docstring">
|
1206
|
+
<div class="discussion">
|
1207
|
+
|
1208
|
+
<p>Compares resources by class and id. If id is nil, then by object_id</p>
|
1209
|
+
|
1210
|
+
|
1211
|
+
</div>
|
1212
|
+
</div>
|
1213
|
+
<div class="tags">
|
1214
|
+
|
1215
|
+
|
1216
|
+
</div><table class="source_code">
|
1217
|
+
<tr>
|
1218
|
+
<td>
|
1219
|
+
<pre class="lines">
|
1220
|
+
|
1221
|
+
|
1222
|
+
112
|
1223
|
+
113
|
1224
|
+
114
|
1225
|
+
115</pre>
|
1226
|
+
</td>
|
1227
|
+
<td>
|
1228
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 112</span>
|
1229
|
+
|
1230
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
1231
|
+
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Trying to compare </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbrace'>}</span><span class='tstring_content'> to a Resource from </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_caller'>caller</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Data</span><span class='rparen'>)</span>
|
1232
|
+
<span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>&&</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>==</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span> <span class='op'>==</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_object_id'>object_id</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
1233
|
+
<span class='kw'>end</span></pre>
|
1234
|
+
</td>
|
1235
|
+
</tr>
|
1236
|
+
</table>
|
1237
|
+
</div>
|
1238
|
+
|
1239
|
+
<div class="method_details ">
|
1240
|
+
<h3 class="signature " id="id-instance_method">
|
1241
|
+
|
1242
|
+
- (<tt>Object</tt>) <strong>id</strong>
|
1243
|
+
|
1244
|
+
|
1245
|
+
|
1246
|
+
<span class="aliases">Also known as:
|
1247
|
+
<span class="names"><span id='hash-instance_method'>hash</span></span>
|
1248
|
+
</span>
|
1249
|
+
|
1250
|
+
|
1251
|
+
|
1252
|
+
</h3><div class="docstring">
|
1253
|
+
<div class="discussion">
|
1254
|
+
|
1255
|
+
<p>Returns the resource id of the object or nil</p>
|
1256
|
+
|
1257
|
+
|
1258
|
+
</div>
|
1259
|
+
</div>
|
1260
|
+
<div class="tags">
|
1261
|
+
|
1262
|
+
|
1263
|
+
</div><table class="source_code">
|
1264
|
+
<tr>
|
1265
|
+
<td>
|
1266
|
+
<pre class="lines">
|
1267
|
+
|
1268
|
+
|
1269
|
+
78
|
1270
|
+
79
|
1271
|
+
80</pre>
|
1272
|
+
</td>
|
1273
|
+
<td>
|
1274
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 78</span>
|
1275
|
+
|
1276
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
1277
|
+
<span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
1278
|
+
<span class='kw'>end</span></pre>
|
1279
|
+
</td>
|
1280
|
+
</tr>
|
1281
|
+
</table>
|
1282
|
+
</div>
|
1283
|
+
|
1284
|
+
<div class="method_details ">
|
1285
|
+
<h3 class="signature " id="new_record?-instance_method">
|
1286
|
+
|
1287
|
+
- (<tt>Boolean</tt>) <strong>new_record?</strong>
|
1288
|
+
|
1289
|
+
|
1290
|
+
|
1291
|
+
|
1292
|
+
|
1293
|
+
</h3><div class="docstring">
|
1294
|
+
<div class="discussion">
|
1295
|
+
|
1296
|
+
<p>Has this been object been created server-side? Does this by checking for an
|
1297
|
+
id.</p>
|
1298
|
+
|
1299
|
+
|
1300
|
+
</div>
|
1301
|
+
</div>
|
1302
|
+
<div class="tags">
|
1303
|
+
|
1304
|
+
<p class="tag_title">Returns:</p>
|
1305
|
+
<ul class="return">
|
1306
|
+
|
1307
|
+
<li>
|
1308
|
+
|
1309
|
+
|
1310
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1311
|
+
|
1312
|
+
|
1313
|
+
|
1314
|
+
</li>
|
1315
|
+
|
1316
|
+
</ul>
|
1317
|
+
|
1318
|
+
</div><table class="source_code">
|
1319
|
+
<tr>
|
1320
|
+
<td>
|
1321
|
+
<pre class="lines">
|
1322
|
+
|
1323
|
+
|
1324
|
+
83
|
1325
|
+
84
|
1326
|
+
85</pre>
|
1327
|
+
</td>
|
1328
|
+
<td>
|
1329
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 83</span>
|
1330
|
+
|
1331
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new_record?'>new_record?</span>
|
1332
|
+
<span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
1333
|
+
<span class='kw'>end</span></pre>
|
1334
|
+
</td>
|
1335
|
+
</tr>
|
1336
|
+
</table>
|
1337
|
+
</div>
|
1338
|
+
|
1339
|
+
<div class="method_details ">
|
1340
|
+
<h3 class="signature " id="path-instance_method">
|
1341
|
+
|
1342
|
+
- (<tt>Object</tt>) <strong>path</strong>(*args)
|
1343
|
+
|
1344
|
+
|
1345
|
+
|
1346
|
+
|
1347
|
+
|
1348
|
+
</h3><div class="docstring">
|
1349
|
+
<div class="discussion">
|
1350
|
+
|
1351
|
+
<p>Returns the path to the resource</p>
|
1352
|
+
|
1353
|
+
|
1354
|
+
</div>
|
1355
|
+
</div>
|
1356
|
+
<div class="tags">
|
1357
|
+
|
1358
|
+
|
1359
|
+
</div><table class="source_code">
|
1360
|
+
<tr>
|
1361
|
+
<td>
|
1362
|
+
<pre class="lines">
|
1363
|
+
|
1364
|
+
|
1365
|
+
96
|
1366
|
+
97
|
1367
|
+
98</pre>
|
1368
|
+
</td>
|
1369
|
+
<td>
|
1370
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 96</span>
|
1371
|
+
|
1372
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
1373
|
+
<span class='ivar'>@association</span><span class='period'>.</span><span class='id identifier rubyid_generate_path'>generate_path</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
1374
|
+
<span class='kw'>end</span></pre>
|
1375
|
+
</td>
|
1376
|
+
</tr>
|
1377
|
+
</table>
|
1378
|
+
</div>
|
1379
|
+
|
1380
|
+
<div class="method_details ">
|
1381
|
+
<h3 class="signature " id="to_json-instance_method">
|
1382
|
+
|
1383
|
+
- (<tt>Object</tt>) <strong>to_json</strong>(*args)
|
1384
|
+
|
1385
|
+
|
1386
|
+
|
1387
|
+
|
1388
|
+
|
1389
|
+
</h3><div class="docstring">
|
1390
|
+
<div class="discussion">
|
1391
|
+
|
1392
|
+
<p>Passes #to_json to the underlying attributes hash</p>
|
1393
|
+
|
1394
|
+
|
1395
|
+
</div>
|
1396
|
+
</div>
|
1397
|
+
<div class="tags">
|
1398
|
+
|
1399
|
+
|
1400
|
+
</div><table class="source_code">
|
1401
|
+
<tr>
|
1402
|
+
<td>
|
1403
|
+
<pre class="lines">
|
1404
|
+
|
1405
|
+
|
1406
|
+
101
|
1407
|
+
102
|
1408
|
+
103</pre>
|
1409
|
+
</td>
|
1410
|
+
<td>
|
1411
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/resource.rb', line 101</span>
|
1412
|
+
|
1413
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
1414
|
+
<span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='symbol'>:to_json</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
1415
|
+
<span class='kw'>end</span></pre>
|
1416
|
+
</td>
|
1417
|
+
</tr>
|
1418
|
+
</table>
|
1419
|
+
</div>
|
1420
|
+
|
1421
|
+
</div>
|
1422
|
+
|
1423
|
+
</div>
|
1424
|
+
|
1425
|
+
<div id="footer">
|
1426
|
+
Generated on Mon Feb 11 17:45:36 2013 by
|
1427
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1428
|
+
0.8.4.1 (ruby-1.9.3).
|
1429
|
+
</div>
|
1430
|
+
|
1431
|
+
</body>
|
1432
|
+
</html>
|