zendesk_api 0.2.6 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,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
|
+
Module: ZendeskAPI::Console::Eval
|
|
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 (E)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Console.html" title="ZendeskAPI::Console (module)">Console</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Eval</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Module: ZendeskAPI::Console::Eval
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<dt class="r1 last">Defined in:</dt>
|
|
82
|
+
<dd class="r1 last">lib/zendesk_api/console/console.rb</dd>
|
|
83
|
+
|
|
84
|
+
</dl>
|
|
85
|
+
<div class="clear"></div>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<h2>
|
|
96
|
+
Instance Method Summary
|
|
97
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
98
|
+
</h2>
|
|
99
|
+
|
|
100
|
+
<ul class="summary">
|
|
101
|
+
|
|
102
|
+
<li class="public ">
|
|
103
|
+
<span class="summary_signature">
|
|
104
|
+
|
|
105
|
+
<a href="#loop_eval-instance_method" title="#loop_eval (instance method)">- (Object) <strong>loop_eval</strong>(str) </a>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</span>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
120
|
+
|
|
121
|
+
</li>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</ul>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<div id="instance_method_details" class="method_details_list">
|
|
130
|
+
<h2>Instance Method Details</h2>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<div class="method_details first">
|
|
134
|
+
<h3 class="signature first" id="loop_eval-instance_method">
|
|
135
|
+
|
|
136
|
+
- (<tt>Object</tt>) <strong>loop_eval</strong>(str)
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</h3><table class="source_code">
|
|
143
|
+
<tr>
|
|
144
|
+
<td>
|
|
145
|
+
<pre class="lines">
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
11
|
|
149
|
+
12
|
|
150
|
+
13
|
|
151
|
+
14
|
|
152
|
+
15
|
|
153
|
+
16
|
|
154
|
+
17
|
|
155
|
+
18
|
|
156
|
+
19
|
|
157
|
+
20
|
|
158
|
+
21</pre>
|
|
159
|
+
</td>
|
|
160
|
+
<td>
|
|
161
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/console.rb', line 11</span>
|
|
162
|
+
|
|
163
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_loop_eval'>loop_eval</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
|
|
164
|
+
<span class='id identifier rubyid_split'>split</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*\/\s*</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
|
|
165
|
+
<span class='id identifier rubyid_split'>split</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_split'>split</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
|
|
166
|
+
<span class='id identifier rubyid_s'>s</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\d+</span><span class='regexp_end'>/</span></span> <span class='op'>?</span> <span class='id identifier rubyid_s'>s</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_s'>s</span><span class='rbrace'>}</span><span class='tstring_content'>\"</span><span class='tstring_end'>"</span></span>
|
|
167
|
+
<span class='kw'>end</span>
|
|
168
|
+
<span class='id identifier rubyid_split'>split</span> <span class='op'>=</span> <span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</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>
|
|
169
|
+
<span class='id identifier rubyid_split'>split</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span>
|
|
170
|
+
<span class='comment'># puts ZendeskAPI::Console::ZD_DIRUP
|
|
171
|
+
</span> <span class='id identifier rubyid_split'>split</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.\.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ZendeskAPI::Console::ZD_DIRUP</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
172
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_split'>split</span><span class='rparen'>)</span>
|
|
173
|
+
<span class='kw'>end</span></pre>
|
|
174
|
+
</td>
|
|
175
|
+
</tr>
|
|
176
|
+
</table>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
<div id="footer">
|
|
184
|
+
Generated on Mon Feb 11 17:45:36 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,134 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Module: ZendeskAPI::Create
|
|
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">Create</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Module: ZendeskAPI::Create
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<dt class="r1">Includes:</dt>
|
|
79
|
+
<dd class="r1"><span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></dd>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dt class="r2">Included in:</dt>
|
|
85
|
+
<dd class="r2"><span class='object_link'><a href="CreateResource.html" title="ZendeskAPI::CreateResource (class)">CreateResource</a></span>, <span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">Topic::TopicComment</a></span>, <span class='object_link'><a href="Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span></dd>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r1 last">Defined in:</dt>
|
|
90
|
+
<dd class="r1 last">lib/zendesk_api/actions.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Defined Under Namespace</h2>
|
|
96
|
+
<p class="children">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Create/ClassMethods.html" title="ZendeskAPI::Create::ClassMethods (module)">ClassMethods</a></span>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</p>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>Method Summary</h2>
|
|
120
|
+
|
|
121
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
|
|
122
|
+
<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>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
<div id="footer">
|
|
128
|
+
Generated on Mon Feb 11 17:45:36 2013 by
|
|
129
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
130
|
+
0.8.4.1 (ruby-1.9.3).
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
</body>
|
|
134
|
+
</html>
|
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Module: ZendeskAPI::Create::ClassMethods
|
|
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> » <span class='title'><span class='object_link'><a href="../Create.html" title="ZendeskAPI::Create (module)">Create</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">ClassMethods</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Module: ZendeskAPI::Create::ClassMethods
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<dt class="r1 last">Defined in:</dt>
|
|
82
|
+
<dd class="r1 last">lib/zendesk_api/actions.rb</dd>
|
|
83
|
+
|
|
84
|
+
</dl>
|
|
85
|
+
<div class="clear"></div>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<h2>
|
|
96
|
+
Instance Method Summary
|
|
97
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
98
|
+
</h2>
|
|
99
|
+
|
|
100
|
+
<ul class="summary">
|
|
101
|
+
|
|
102
|
+
<li class="public ">
|
|
103
|
+
<span class="summary_signature">
|
|
104
|
+
|
|
105
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(client, attributes = {}) </a>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</span>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<span class="summary_desc"><div class='inline'>
|
|
120
|
+
<p>Create a resource given the attributes passed in.</p>
|
|
121
|
+
</div></span>
|
|
122
|
+
|
|
123
|
+
</li>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<li class="public ">
|
|
127
|
+
<span class="summary_signature">
|
|
128
|
+
|
|
129
|
+
<a href="#create%21-instance_method" title="#create! (instance method)">- (Object) <strong>create!</strong>(client, attributes = {}) </a>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</span>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<span class="summary_desc"><div class='inline'>
|
|
144
|
+
<p>Creates the resource, raising an ArgumentError if it fails.</p>
|
|
145
|
+
</div></span>
|
|
146
|
+
|
|
147
|
+
</li>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</ul>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<div id="instance_method_details" class="method_details_list">
|
|
162
|
+
<h2>Instance Method Details</h2>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<div class="method_details first">
|
|
166
|
+
<h3 class="signature first" id="create-instance_method">
|
|
167
|
+
|
|
168
|
+
- (<tt>Object</tt>) <strong>create</strong>(client, attributes = {})
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
</h3><div class="docstring">
|
|
175
|
+
<div class="discussion">
|
|
176
|
+
|
|
177
|
+
<p>Create a resource given the attributes passed in.</p>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</div>
|
|
181
|
+
</div>
|
|
182
|
+
<div class="tags">
|
|
183
|
+
<p class="tag_title">Parameters:</p>
|
|
184
|
+
<ul class="param">
|
|
185
|
+
|
|
186
|
+
<li>
|
|
187
|
+
|
|
188
|
+
<span class='name'>client</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
—
|
|
196
|
+
<div class='inline'>
|
|
197
|
+
<p>The <span class='object_link'><a href="../Client.html" title="ZendeskAPI::Client (class)">ZendeskAPI::Client</a></span> object to be used</p>
|
|
198
|
+
</div>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
<li>
|
|
203
|
+
|
|
204
|
+
<span class='name'>attributes</span>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
—
|
|
214
|
+
<div class='inline'>
|
|
215
|
+
<p>The attributes to create.</p>
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
</li>
|
|
219
|
+
|
|
220
|
+
</ul>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</div><table class="source_code">
|
|
224
|
+
<tr>
|
|
225
|
+
<td>
|
|
226
|
+
<pre class="lines">
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
116
|
|
230
|
+
117
|
|
231
|
+
118
|
|
232
|
+
119
|
|
233
|
+
120
|
|
234
|
+
121</pre>
|
|
235
|
+
</td>
|
|
236
|
+
<td>
|
|
237
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 116</span>
|
|
238
|
+
|
|
239
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</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>
|
|
240
|
+
<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='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span>
|
|
241
|
+
<span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='id identifier rubyid_new'>new</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='rparen'>)</span>
|
|
242
|
+
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
243
|
+
<span class='id identifier rubyid_resource'>resource</span>
|
|
244
|
+
<span class='kw'>end</span></pre>
|
|
245
|
+
</td>
|
|
246
|
+
</tr>
|
|
247
|
+
</table>
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
<div class="method_details ">
|
|
251
|
+
<h3 class="signature " id="create!-instance_method">
|
|
252
|
+
|
|
253
|
+
- (<tt>Object</tt>) <strong>create!</strong>(client, attributes = {})
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
</h3><div class="docstring">
|
|
260
|
+
<div class="discussion">
|
|
261
|
+
|
|
262
|
+
<p>Creates the resource, raising an ArgumentError if it fails</p>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</div>
|
|
266
|
+
</div>
|
|
267
|
+
<div class="tags">
|
|
268
|
+
|
|
269
|
+
<p class="tag_title">Raises:</p>
|
|
270
|
+
<ul class="raise">
|
|
271
|
+
|
|
272
|
+
<li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
—
|
|
280
|
+
<div class='inline'>
|
|
281
|
+
<p>if the creation fails</p>
|
|
282
|
+
</div>
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
</ul>
|
|
287
|
+
|
|
288
|
+
</div><table class="source_code">
|
|
289
|
+
<tr>
|
|
290
|
+
<td>
|
|
291
|
+
<pre class="lines">
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
125
|
|
295
|
+
126
|
|
296
|
+
127
|
|
297
|
+
128</pre>
|
|
298
|
+
</td>
|
|
299
|
+
<td>
|
|
300
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 125</span>
|
|
301
|
+
|
|
302
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</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>
|
|
303
|
+
<span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='id identifier rubyid_create'>create</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='rparen'>)</span>
|
|
304
|
+
<span class='id identifier rubyid_c'>c</span> <span class='op'>||</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Create failed </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
305
|
+
<span class='kw'>end</span></pre>
|
|
306
|
+
</td>
|
|
307
|
+
</tr>
|
|
308
|
+
</table>
|
|
309
|
+
</div>
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
<div id="footer">
|
|
316
|
+
Generated on Mon Feb 11 17:45:36 2013 by
|
|
317
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
318
|
+
0.8.4.1 (ruby-1.9.3).
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</body>
|
|
322
|
+
</html>
|