zendesk_api 1.3.5 → 1.3.7
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.
- checksums.yaml +4 -4
- data/.travis.yml +2 -2
- data/.yardopts +0 -2
- data/Gemfile +4 -30
- data/Gemfile.lock +38 -80
- data/Rakefile +0 -5
- data/lib/zendesk_api/actions.rb +3 -2
- data/lib/zendesk_api/client.rb +4 -1
- data/lib/zendesk_api/collection.rb +4 -0
- data/lib/zendesk_api/configuration.rb +2 -0
- data/lib/zendesk_api/middleware/request/upload.rb +1 -1
- data/lib/zendesk_api/middleware/request/url_based_access_token.rb +26 -0
- data/lib/zendesk_api/resources.rb +25 -1
- data/lib/zendesk_api/version.rb +1 -1
- data/spec/core/client_spec.rb +1 -0
- data/spec/core/middleware/request/upload_spec.rb +26 -27
- data/spec/core/spec_helper.rb +27 -1
- data/spec/live/user_spec.rb +4 -2
- data/spec/live/user_view_spec.rb +16 -0
- data/spec/live/voice/phone_number_spec.rb +2 -0
- data/zendesk_api.gemspec +1 -4
- metadata +9 -191
- data/Procfile +0 -1
- data/bin/zendesk +0 -27
- data/config.ru +0 -6
- data/config/mongoid.yml +0 -81
- data/config/newrelic.yml +0 -255
- data/lib/zendesk_api/console/base.rb +0 -12
- data/lib/zendesk_api/console/console.rb +0 -144
- data/lib/zendesk_api/console/extensions.rb +0 -202
- data/lib/zendesk_api/console/options.rb +0 -41
- data/lib/zendesk_api/server/base.rb +0 -123
- data/lib/zendesk_api/server/docs/account_settings.md +0 -191
- data/lib/zendesk_api/server/docs/activity_stream.md +0 -121
- data/lib/zendesk_api/server/docs/attachments.md +0 -142
- data/lib/zendesk_api/server/docs/autocomplete.md +0 -29
- data/lib/zendesk_api/server/docs/automations.md +0 -256
- data/lib/zendesk_api/server/docs/categories.md +0 -193
- data/lib/zendesk_api/server/docs/changes_roadmap.md +0 -286
- data/lib/zendesk_api/server/docs/custom_roles.md +0 -88
- data/lib/zendesk_api/server/docs/forum_subscriptions.md +0 -139
- data/lib/zendesk_api/server/docs/forums.md +0 -229
- data/lib/zendesk_api/server/docs/group_memberships.md +0 -229
- data/lib/zendesk_api/server/docs/groups.md +0 -212
- data/lib/zendesk_api/server/docs/introduction.md +0 -165
- data/lib/zendesk_api/server/docs/job_statuses.md +0 -86
- data/lib/zendesk_api/server/docs/locales.md +0 -124
- data/lib/zendesk_api/server/docs/macros.md +0 -289
- data/lib/zendesk_api/server/docs/organizations.md +0 -271
- data/lib/zendesk_api/server/docs/problems.md +0 -117
- data/lib/zendesk_api/server/docs/requests.md +0 -274
- data/lib/zendesk_api/server/docs/satisfaction_ratings.md +0 -172
- data/lib/zendesk_api/server/docs/search.md +0 -106
- data/lib/zendesk_api/server/docs/sharing_agreements.md +0 -57
- data/lib/zendesk_api/server/docs/side_loading.md +0 -125
- data/lib/zendesk_api/server/docs/suspended_tickets.md +0 -184
- data/lib/zendesk_api/server/docs/tags.md +0 -145
- data/lib/zendesk_api/server/docs/ticket_audits.md +0 -688
- data/lib/zendesk_api/server/docs/ticket_export.md +0 -121
- data/lib/zendesk_api/server/docs/ticket_fields.md +0 -277
- data/lib/zendesk_api/server/docs/ticket_import.md +0 -65
- data/lib/zendesk_api/server/docs/ticket_metrics.md +0 -125
- data/lib/zendesk_api/server/docs/tickets.md +0 -696
- data/lib/zendesk_api/server/docs/topic_comments.md +0 -221
- data/lib/zendesk_api/server/docs/topic_subscriptions.md +0 -140
- data/lib/zendesk_api/server/docs/topic_votes.md +0 -153
- data/lib/zendesk_api/server/docs/topics.md +0 -335
- data/lib/zendesk_api/server/docs/triggers.md +0 -264
- data/lib/zendesk_api/server/docs/user_identities.md +0 -279
- data/lib/zendesk_api/server/docs/users.md +0 -455
- data/lib/zendesk_api/server/docs/views.md +0 -644
- data/lib/zendesk_api/server/helper.rb +0 -110
- data/lib/zendesk_api/server/html_renderer.rb +0 -98
- data/lib/zendesk_api/server/models/user_request.rb +0 -16
- data/lib/zendesk_api/server/models/zlib_json.rb +0 -13
- data/lib/zendesk_api/server/public/config.rb +0 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +0 -131
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +0 -979
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +0 -658
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +0 -805
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +0 -825
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +0 -1226
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +0 -2606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +0 -1302
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +0 -392
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +0 -283
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +0 -878
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +0 -1406
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +0 -823
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +0 -815
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +0 -357
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +0 -295
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error.html +0 -115
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +0 -127
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/NetworkError.html +0 -127
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +0 -371
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +0 -127
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +0 -1559
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +0 -979
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +0 -979
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +0 -598
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +0 -598
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +0 -805
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +0 -724
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +0 -810
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +0 -1379
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +0 -341
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +0 -797
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +0 -1189
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +0 -993
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +0 -1263
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +0 -610
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +0 -679
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +0 -1327
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +0 -494
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +0 -411
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +0 -462
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +0 -742
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +0 -598
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +0 -610
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +0 -911
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +0 -3094
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +0 -787
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +0 -1039
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +0 -782
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +0 -1449
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +0 -1122
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +0 -983
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +0 -1039
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +0 -979
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +0 -805
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +0 -392
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +0 -287
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +0 -878
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +0 -1176
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +0 -3974
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +0 -926
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +0 -656
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +0 -606
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +0 -332
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +0 -1650
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +0 -592
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +0 -1744
- data/lib/zendesk_api/server/public/doc/_index.html +0 -799
- data/lib/zendesk_api/server/public/doc/class_list.html +0 -53
- data/lib/zendesk_api/server/public/doc/css/common.css +0 -1
- data/lib/zendesk_api/server/public/doc/css/full_list.css +0 -57
- data/lib/zendesk_api/server/public/doc/css/style.css +0 -338
- data/lib/zendesk_api/server/public/doc/file.Readme.html +0 -137
- data/lib/zendesk_api/server/public/doc/file_list.html +0 -55
- data/lib/zendesk_api/server/public/doc/frames.html +0 -28
- data/lib/zendesk_api/server/public/doc/index.html +0 -137
- data/lib/zendesk_api/server/public/doc/js/app.js +0 -214
- data/lib/zendesk_api/server/public/doc/js/full_list.js +0 -173
- data/lib/zendesk_api/server/public/doc/js/jquery.js +0 -4
- data/lib/zendesk_api/server/public/doc/method_list.html +0 -2332
- data/lib/zendesk_api/server/public/doc/top-level-namespace.html +0 -112
- data/lib/zendesk_api/server/public/favicon.ico +0 -0
- data/lib/zendesk_api/server/public/images/glyphicons-halflings-white.png +0 -0
- data/lib/zendesk_api/server/public/images/glyphicons-halflings.png +0 -0
- data/lib/zendesk_api/server/public/images/spinner.gif +0 -0
- data/lib/zendesk_api/server/public/images/zendesk_developers_bg.png +0 -0
- data/lib/zendesk_api/server/public/images/zendesk_developers_header.png +0 -0
- data/lib/zendesk_api/server/public/javascripts/application.js +0 -186
- data/lib/zendesk_api/server/public/javascripts/bootstrap-alert.js +0 -90
- data/lib/zendesk_api/server/public/javascripts/bootstrap-button.js +0 -96
- data/lib/zendesk_api/server/public/javascripts/bootstrap-carousel.js +0 -169
- data/lib/zendesk_api/server/public/javascripts/bootstrap-collapse.js +0 -157
- data/lib/zendesk_api/server/public/javascripts/bootstrap-dropdown.js +0 -100
- data/lib/zendesk_api/server/public/javascripts/bootstrap-modal.js +0 -218
- data/lib/zendesk_api/server/public/javascripts/bootstrap-popover.js +0 -98
- data/lib/zendesk_api/server/public/javascripts/bootstrap-scrollspy.js +0 -151
- data/lib/zendesk_api/server/public/javascripts/bootstrap-tab.js +0 -135
- data/lib/zendesk_api/server/public/javascripts/bootstrap-tooltip.js +0 -275
- data/lib/zendesk_api/server/public/javascripts/bootstrap-transition.js +0 -61
- data/lib/zendesk_api/server/public/javascripts/bootstrap-typeahead.js +0 -285
- data/lib/zendesk_api/server/public/sass/screen.scss +0 -102
- data/lib/zendesk_api/server/public/sass/styles.scss +0 -5
- data/lib/zendesk_api/server/public/stylesheets/developer.screen.css +0 -836
- data/lib/zendesk_api/server/public/stylesheets/screen.css +0 -129
- data/lib/zendesk_api/server/public/stylesheets/styles.css +0 -6208
- data/lib/zendesk_api/server/templates/footer.haml +0 -13
- data/lib/zendesk_api/server/templates/header.haml +0 -20
- data/lib/zendesk_api/server/templates/index.haml +0 -68
- data/lib/zendesk_api/server/templates/layout.haml +0 -44
- data/lib/zendesk_api/server/templates/param.haml +0 -4
- data/lib/zendesk_api/server/templates/search.haml +0 -23
- data/lib/zendesk_api/server/templates/sidebar.haml +0 -7
- data/spec/server/app_spec.rb +0 -140
- data/spec/server/helper_spec.rb +0 -97
- data/spec/server/html_renderer_spec.rb +0 -130
- data/spec/server/spec_helper.rb +0 -43
|
@@ -1,2606 +0,0 @@
|
|
|
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::Collection
|
|
8
|
-
|
|
9
|
-
— Documentation by YARD 0.8.5.2
|
|
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">Collection</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::Collection
|
|
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::Collection</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/collection.rb</dd>
|
|
98
|
-
|
|
99
|
-
</dl>
|
|
100
|
-
<div class="clear"></div>
|
|
101
|
-
|
|
102
|
-
<h2>Overview</h2><div class="docstring">
|
|
103
|
-
<div class="discussion">
|
|
104
|
-
|
|
105
|
-
<p>Represents a collection of resources. Lazily loaded, resources aren't
|
|
106
|
-
actually fetched until explicitly needed (e.g. #each, <span class='object_link'><a href="#fetch-instance_method" title="ZendeskAPI::Collection#fetch (method)">#fetch</a></span>).</p>
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
</div>
|
|
110
|
-
</div>
|
|
111
|
-
<div class="tags">
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
</div>
|
|
115
|
-
<h2>Constant Summary</h2>
|
|
116
|
-
|
|
117
|
-
<dl class="constants">
|
|
118
|
-
|
|
119
|
-
<dt id="SPECIALLY_JOINED_PARAMS-constant" class="">SPECIALLY_JOINED_PARAMS =
|
|
120
|
-
<div class="docstring">
|
|
121
|
-
<div class="discussion">
|
|
122
|
-
|
|
123
|
-
<p>Options passed in that are automatically converted from an array to a
|
|
124
|
-
comma-separated list.</p>
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
</div>
|
|
128
|
-
</div>
|
|
129
|
-
<div class="tags">
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
</div>
|
|
133
|
-
</dt>
|
|
134
|
-
<dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:ids</span><span class='comma'>,</span> <span class='symbol'>:only</span><span class='rbracket'>]</span></pre></dd>
|
|
135
|
-
|
|
136
|
-
</dl>
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
143
|
-
<ul class="summary">
|
|
144
|
-
|
|
145
|
-
<li class="public ">
|
|
146
|
-
<span class="summary_signature">
|
|
147
|
-
|
|
148
|
-
<a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
</span>
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
<span class="note title readonly">readonly</span>
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
<span class="summary_desc"><div class='inline'>
|
|
168
|
-
<p>The class association.</p>
|
|
169
|
-
</div></span>
|
|
170
|
-
|
|
171
|
-
</li>
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
<li class="public ">
|
|
175
|
-
<span class="summary_signature">
|
|
176
|
-
|
|
177
|
-
<a href="#options-instance_method" title="#options (instance method)">- (Hash) <strong>options</strong> </a>
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
</span>
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
<span class="note title readonly">readonly</span>
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
<span class="summary_desc"><div class='inline'>
|
|
197
|
-
<p>Query options.</p>
|
|
198
|
-
</div></span>
|
|
199
|
-
|
|
200
|
-
</li>
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
<li class="public ">
|
|
204
|
-
<span class="summary_signature">
|
|
205
|
-
|
|
206
|
-
<a href="#response-instance_method" title="#response (instance method)">- (Faraday::Response) <strong>response</strong> </a>
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
</span>
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
<span class="note title readonly">readonly</span>
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
<span class="summary_desc"><div class='inline'>
|
|
226
|
-
<p>The last response.</p>
|
|
227
|
-
</div></span>
|
|
228
|
-
|
|
229
|
-
</li>
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
</ul>
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
<h2>
|
|
239
|
-
Instance Method Summary
|
|
240
|
-
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
241
|
-
</h2>
|
|
242
|
-
|
|
243
|
-
<ul class="summary">
|
|
244
|
-
|
|
245
|
-
<li class="public ">
|
|
246
|
-
<span class="summary_signature">
|
|
247
|
-
|
|
248
|
-
<a href="#%3C%3C-instance_method" title="#<< (instance method)">- (Object) <strong><<</strong>(item) </a>
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
</span>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
<span class="summary_desc"><div class='inline'>
|
|
263
|
-
<p>Adds an item to this collection.</p>
|
|
264
|
-
</div></span>
|
|
265
|
-
|
|
266
|
-
</li>
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
<li class="public ">
|
|
270
|
-
<span class="summary_signature">
|
|
271
|
-
|
|
272
|
-
<a href="#all-instance_method" title="#all (instance method)">- (Object) <strong>all</strong>(start_page = @options["page"], &block) </a>
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
</span>
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
<span class="summary_desc"><div class='inline'>
|
|
287
|
-
<p>Calls #each on every page with the passed in block.</p>
|
|
288
|
-
</div></span>
|
|
289
|
-
|
|
290
|
-
</li>
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
<li class="public ">
|
|
294
|
-
<span class="summary_signature">
|
|
295
|
-
|
|
296
|
-
<a href="#all%21-instance_method" title="#all! (instance method)">- (Object) <strong>all!</strong>(start_page = @options["page"], &block) </a>
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
</span>
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
<span class="summary_desc"><div class='inline'>
|
|
311
|
-
<p>Calls #each on every page with the passed in block.</p>
|
|
312
|
-
</div></span>
|
|
313
|
-
|
|
314
|
-
</li>
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
<li class="public ">
|
|
318
|
-
<span class="summary_signature">
|
|
319
|
-
|
|
320
|
-
<a href="#clear_cache-instance_method" title="#clear_cache (instance method)">- (Object) <strong>clear_cache</strong> </a>
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
</span>
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
<span class="summary_desc"><div class='inline'>
|
|
335
|
-
<p>Clears all cached resources and associated values.</p>
|
|
336
|
-
</div></span>
|
|
337
|
-
|
|
338
|
-
</li>
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
<li class="public ">
|
|
342
|
-
<span class="summary_signature">
|
|
343
|
-
|
|
344
|
-
<a href="#count-instance_method" title="#count (instance method)">- (Number) <strong>count</strong> </a>
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
</span>
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
<span class="summary_desc"><div class='inline'>
|
|
359
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
360
|
-
</div></span>
|
|
361
|
-
|
|
362
|
-
</li>
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
<li class="public ">
|
|
366
|
-
<span class="summary_signature">
|
|
367
|
-
|
|
368
|
-
<a href="#count%21-instance_method" title="#count! (instance method)">- (Number) <strong>count!</strong> </a>
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
</span>
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
<span class="summary_desc"><div class='inline'>
|
|
383
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
384
|
-
</div></span>
|
|
385
|
-
|
|
386
|
-
</li>
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
<li class="public ">
|
|
390
|
-
<span class="summary_signature">
|
|
391
|
-
|
|
392
|
-
<a href="#each_page-instance_method" title="#each_page (instance method)">- (Object) <strong>each_page</strong>(*args, &block) </a>
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
</span>
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
407
|
-
|
|
408
|
-
</li>
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
<li class="public ">
|
|
412
|
-
<span class="summary_signature">
|
|
413
|
-
|
|
414
|
-
<a href="#each_page%21-instance_method" title="#each_page! (instance method)">- (Object) <strong>each_page!</strong>(*args, &block) </a>
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
</span>
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
429
|
-
|
|
430
|
-
</li>
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
<li class="public ">
|
|
434
|
-
<span class="summary_signature">
|
|
435
|
-
|
|
436
|
-
<a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong>(*args) </a>
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
</span>
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
451
|
-
|
|
452
|
-
</li>
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
<li class="public ">
|
|
456
|
-
<span class="summary_signature">
|
|
457
|
-
|
|
458
|
-
<a href="#fetch%21-instance_method" title="#fetch! (instance method)">- (Object) <strong>fetch!</strong>(reload = false) </a>
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
</span>
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
<span class="summary_desc"><div class='inline'>
|
|
473
|
-
<p>Executes actual GET from API and loads resources into proper class.</p>
|
|
474
|
-
</div></span>
|
|
475
|
-
|
|
476
|
-
</li>
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
<li class="public ">
|
|
480
|
-
<span class="summary_signature">
|
|
481
|
-
|
|
482
|
-
<a href="#first_page%3F-instance_method" title="#first_page? (instance method)">- (Boolean) <strong>first_page?</strong> </a>
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
</span>
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
497
|
-
|
|
498
|
-
</li>
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
<li class="public ">
|
|
502
|
-
<span class="summary_signature">
|
|
503
|
-
|
|
504
|
-
<a href="#include-instance_method" title="#include (instance method)">- (Object) <strong>include</strong>(*sideloads) </a>
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
</span>
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
<span class="summary_desc"><div class='inline'>
|
|
519
|
-
<p>Adds an item (or items) to the list of side-loaded resources to request.</p>
|
|
520
|
-
</div></span>
|
|
521
|
-
|
|
522
|
-
</li>
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
<li class="public ">
|
|
526
|
-
<span class="summary_signature">
|
|
527
|
-
|
|
528
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Collection) <strong>initialize</strong>(client, resource, options = {}) </a>
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
</span>
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
<span class="note title constructor">constructor</span>
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
<span class="summary_desc"><div class='inline'>
|
|
545
|
-
<p>Creates a new Collection instance.</p>
|
|
546
|
-
</div></span>
|
|
547
|
-
|
|
548
|
-
</li>
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
<li class="public ">
|
|
552
|
-
<span class="summary_signature">
|
|
553
|
-
|
|
554
|
-
<a href="#last_page%3F-instance_method" title="#last_page? (instance method)">- (Boolean) <strong>last_page?</strong> </a>
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
</span>
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
569
|
-
|
|
570
|
-
</li>
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
<li class="public ">
|
|
574
|
-
<span class="summary_signature">
|
|
575
|
-
|
|
576
|
-
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(name, *args, &block) </a>
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
</span>
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
<span class="summary_desc"><div class='inline'>
|
|
591
|
-
<p>Sends methods to underlying array of resources.</p>
|
|
592
|
-
</div></span>
|
|
593
|
-
|
|
594
|
-
</li>
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
<li class="public ">
|
|
598
|
-
<span class="summary_signature">
|
|
599
|
-
|
|
600
|
-
<a href="#next-instance_method" title="#next (instance method)">- (Object) <strong>next</strong> </a>
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
</span>
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
<span class="summary_desc"><div class='inline'>
|
|
615
|
-
<p>Find the next page.</p>
|
|
616
|
-
</div></span>
|
|
617
|
-
|
|
618
|
-
</li>
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
<li class="public ">
|
|
622
|
-
<span class="summary_signature">
|
|
623
|
-
|
|
624
|
-
<a href="#page-instance_method" title="#page (instance method)">- (Collection) <strong>page</strong>(number) </a>
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
</span>
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
<span class="summary_desc"><div class='inline'>
|
|
639
|
-
<p>Changes the page option.</p>
|
|
640
|
-
</div></span>
|
|
641
|
-
|
|
642
|
-
</li>
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
<li class="public ">
|
|
646
|
-
<span class="summary_signature">
|
|
647
|
-
|
|
648
|
-
<a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a>
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
</span>
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
<span class="summary_desc"><div class='inline'>
|
|
663
|
-
<p>The API path to this collection.</p>
|
|
664
|
-
</div></span>
|
|
665
|
-
|
|
666
|
-
</li>
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
<li class="public ">
|
|
670
|
-
<span class="summary_signature">
|
|
671
|
-
|
|
672
|
-
<a href="#per_page-instance_method" title="#per_page (instance method)">- (Collection) <strong>per_page</strong>(count) </a>
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
</span>
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
<span class="summary_desc"><div class='inline'>
|
|
687
|
-
<p>Changes the per_page option.</p>
|
|
688
|
-
</div></span>
|
|
689
|
-
|
|
690
|
-
</li>
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
<li class="public ">
|
|
694
|
-
<span class="summary_signature">
|
|
695
|
-
|
|
696
|
-
<a href="#prev-instance_method" title="#prev (instance method)">- (Object) <strong>prev</strong> </a>
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
</span>
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
<span class="summary_desc"><div class='inline'>
|
|
711
|
-
<p>Find the previous page.</p>
|
|
712
|
-
</div></span>
|
|
713
|
-
|
|
714
|
-
</li>
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
<li class="public ">
|
|
718
|
-
<span class="summary_signature">
|
|
719
|
-
|
|
720
|
-
<a href="#replace-instance_method" title="#replace (instance method)">- (Object) <strong>replace</strong>(collection) </a>
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
</span>
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
<span class="summary_desc"><div class='inline'>
|
|
735
|
-
<p>Replaces the current (loaded or not) resources with the passed in
|
|
736
|
-
collection.</p>
|
|
737
|
-
</div></span>
|
|
738
|
-
|
|
739
|
-
</li>
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
<li class="public ">
|
|
743
|
-
<span class="summary_signature">
|
|
744
|
-
|
|
745
|
-
<a href="#save-instance_method" title="#save (instance method)">- (Collection) <strong>save</strong> </a>
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
</span>
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
<span class="summary_desc"><div class='inline'>
|
|
760
|
-
<p>Saves all newly created resources stored in this collection.</p>
|
|
761
|
-
</div></span>
|
|
762
|
-
|
|
763
|
-
</li>
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
<li class="public ">
|
|
767
|
-
<span class="summary_signature">
|
|
768
|
-
|
|
769
|
-
<a href="#save%21-instance_method" title="#save! (instance method)">- (Collection) <strong>save!</strong> </a>
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
</span>
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
<span class="summary_desc"><div class='inline'>
|
|
784
|
-
<p>Saves all newly created resources stored in this collection.</p>
|
|
785
|
-
</div></span>
|
|
786
|
-
|
|
787
|
-
</li>
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
<li class="public ">
|
|
791
|
-
<span class="summary_signature">
|
|
792
|
-
|
|
793
|
-
<a href="#to_a-instance_method" title="#to_a (instance method)">- (Object) <strong>to_a</strong> </a>
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
</span>
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
<span class="summary_desc"><div class='inline'>
|
|
808
|
-
<p>Alias for fetch(false).</p>
|
|
809
|
-
</div></span>
|
|
810
|
-
|
|
811
|
-
</li>
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
<li class="public ">
|
|
815
|
-
<span class="summary_signature">
|
|
816
|
-
|
|
817
|
-
<a href="#to_a%21-instance_method" title="#to_a! (instance method)">- (Object) <strong>to_a!</strong> </a>
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
</span>
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
<span class="summary_desc"><div class='inline'>
|
|
832
|
-
<p>Alias for fetch!(false).</p>
|
|
833
|
-
</div></span>
|
|
834
|
-
|
|
835
|
-
</li>
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
</ul>
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
<div id="constructor_details" class="method_details_list">
|
|
844
|
-
<h2>Constructor Details</h2>
|
|
845
|
-
|
|
846
|
-
<div class="method_details first">
|
|
847
|
-
<h3 class="signature first" id="initialize-instance_method">
|
|
848
|
-
|
|
849
|
-
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>initialize</strong>(client, resource, options = {})
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
</h3><div class="docstring">
|
|
856
|
-
<div class="discussion">
|
|
857
|
-
|
|
858
|
-
<p>Creates a new Collection instance. Does not fetch resources. Additional
|
|
859
|
-
options are: verb (default: GET), path (default: resource param), page,
|
|
860
|
-
per_page.</p>
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
</div>
|
|
864
|
-
</div>
|
|
865
|
-
<div class="tags">
|
|
866
|
-
<p class="tag_title">Parameters:</p>
|
|
867
|
-
<ul class="param">
|
|
868
|
-
|
|
869
|
-
<li>
|
|
870
|
-
|
|
871
|
-
<span class='name'>client</span>
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
—
|
|
879
|
-
<div class='inline'>
|
|
880
|
-
<p>The <span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">ZendeskAPI::Client</a></span> to use.</p>
|
|
881
|
-
</div>
|
|
882
|
-
|
|
883
|
-
</li>
|
|
884
|
-
|
|
885
|
-
<li>
|
|
886
|
-
|
|
887
|
-
<span class='name'>resource</span>
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
—
|
|
895
|
-
<div class='inline'>
|
|
896
|
-
<p>The resource being collected.</p>
|
|
897
|
-
</div>
|
|
898
|
-
|
|
899
|
-
</li>
|
|
900
|
-
|
|
901
|
-
<li>
|
|
902
|
-
|
|
903
|
-
<span class='name'>options</span>
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
—
|
|
913
|
-
<div class='inline'>
|
|
914
|
-
<p>Any additional options to be passed in.</p>
|
|
915
|
-
</div>
|
|
916
|
-
|
|
917
|
-
</li>
|
|
918
|
-
|
|
919
|
-
</ul>
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
</div><table class="source_code">
|
|
923
|
-
<tr>
|
|
924
|
-
<td>
|
|
925
|
-
<pre class="lines">
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
27
|
|
929
|
-
28
|
|
930
|
-
29
|
|
931
|
-
30
|
|
932
|
-
31
|
|
933
|
-
32
|
|
934
|
-
33
|
|
935
|
-
34
|
|
936
|
-
35
|
|
937
|
-
36
|
|
938
|
-
37
|
|
939
|
-
38
|
|
940
|
-
39
|
|
941
|
-
40
|
|
942
|
-
41
|
|
943
|
-
42
|
|
944
|
-
43
|
|
945
|
-
44</pre>
|
|
946
|
-
</td>
|
|
947
|
-
<td>
|
|
948
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 27</span>
|
|
949
|
-
|
|
950
|
-
<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_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
951
|
-
<span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@resource_class</span><span class='comma'>,</span> <span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_resource_name'>resource_name</span>
|
|
952
|
-
<span class='ivar'>@options</span> <span class='op'>=</span> <span class='const'>Hashie</span><span class='op'>::</span><span class='const'>Mash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
953
|
-
|
|
954
|
-
<span class='id identifier rubyid_set_association_from_options'>set_association_from_options</span>
|
|
955
|
-
<span class='id identifier rubyid_join_special_params'>join_special_params</span>
|
|
956
|
-
|
|
957
|
-
<span class='ivar'>@verb</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:verb</span><span class='rparen'>)</span>
|
|
958
|
-
<span class='ivar'>@includes</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
959
|
-
|
|
960
|
-
<span class='comment'># Used for Attachments, TicketComment
|
|
961
|
-
</span> <span class='kw'>if</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Class</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_superclass'>superclass</span> <span class='op'>==</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Data</span>
|
|
962
|
-
<span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
963
|
-
<span class='ivar'>@fetchable</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
964
|
-
<span class='kw'>else</span>
|
|
965
|
-
<span class='ivar'>@fetchable</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
966
|
-
<span class='kw'>end</span>
|
|
967
|
-
<span class='kw'>end</span></pre>
|
|
968
|
-
</td>
|
|
969
|
-
</tr>
|
|
970
|
-
</table>
|
|
971
|
-
</div>
|
|
972
|
-
|
|
973
|
-
</div>
|
|
974
|
-
<div id="method_missing_details" class="method_details_list">
|
|
975
|
-
<h2>Dynamic Method Handling</h2>
|
|
976
|
-
<p class="notice this">
|
|
977
|
-
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
978
|
-
|
|
979
|
-
</p>
|
|
980
|
-
|
|
981
|
-
<div class="method_details first">
|
|
982
|
-
<h3 class="signature first" id="method_missing-instance_method">
|
|
983
|
-
|
|
984
|
-
- (<tt>Object</tt>) <strong>method_missing</strong>(name, *args, &block)
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
</h3><div class="docstring">
|
|
991
|
-
<div class="discussion">
|
|
992
|
-
|
|
993
|
-
<p>Sends methods to underlying array of resources.</p>
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
</div>
|
|
997
|
-
</div>
|
|
998
|
-
<div class="tags">
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
</div><table class="source_code">
|
|
1002
|
-
<tr>
|
|
1003
|
-
<td>
|
|
1004
|
-
<pre class="lines">
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
245
|
|
1008
|
-
246
|
|
1009
|
-
247
|
|
1010
|
-
248
|
|
1011
|
-
249
|
|
1012
|
-
250
|
|
1013
|
-
251
|
|
1014
|
-
252
|
|
1015
|
-
253</pre>
|
|
1016
|
-
</td>
|
|
1017
|
-
<td>
|
|
1018
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 245</span>
|
|
1019
|
-
|
|
1020
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</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>
|
|
1021
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_resource_methods'>resource_methods</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
1022
|
-
<span class='id identifier rubyid_collection_method'>collection_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</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>
|
|
1023
|
-
<span class='kw'>elsif</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
1024
|
-
<span class='id identifier rubyid_array_method'>array_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</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>
|
|
1025
|
-
<span class='kw'>else</span>
|
|
1026
|
-
<span class='id identifier rubyid_next_collection'>next_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</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>
|
|
1027
|
-
<span class='kw'>end</span>
|
|
1028
|
-
<span class='kw'>end</span></pre>
|
|
1029
|
-
</td>
|
|
1030
|
-
</tr>
|
|
1031
|
-
</table>
|
|
1032
|
-
</div>
|
|
1033
|
-
|
|
1034
|
-
</div>
|
|
1035
|
-
|
|
1036
|
-
<div id="instance_attr_details" class="attr_details">
|
|
1037
|
-
<h2>Instance Attribute Details</h2>
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
<span id=""></span>
|
|
1041
|
-
<div class="method_details first">
|
|
1042
|
-
<h3 class="signature first" id="association-instance_method">
|
|
1043
|
-
|
|
1044
|
-
- (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong> <span class="extras">(readonly)</span>
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
</h3><div class="docstring">
|
|
1051
|
-
<div class="discussion">
|
|
1052
|
-
|
|
1053
|
-
<p>The class association</p>
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
</div>
|
|
1057
|
-
</div>
|
|
1058
|
-
<div class="tags">
|
|
1059
|
-
|
|
1060
|
-
<p class="tag_title">Returns:</p>
|
|
1061
|
-
<ul class="return">
|
|
1062
|
-
|
|
1063
|
-
<li>
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
<span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
—
|
|
1071
|
-
<div class='inline'>
|
|
1072
|
-
<p>The class association</p>
|
|
1073
|
-
</div>
|
|
1074
|
-
|
|
1075
|
-
</li>
|
|
1076
|
-
|
|
1077
|
-
</ul>
|
|
1078
|
-
|
|
1079
|
-
</div><table class="source_code">
|
|
1080
|
-
<tr>
|
|
1081
|
-
<td>
|
|
1082
|
-
<pre class="lines">
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
14
|
|
1086
|
-
15
|
|
1087
|
-
16</pre>
|
|
1088
|
-
</td>
|
|
1089
|
-
<td>
|
|
1090
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 14</span>
|
|
1091
|
-
|
|
1092
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_association'>association</span>
|
|
1093
|
-
<span class='ivar'>@association</span>
|
|
1094
|
-
<span class='kw'>end</span></pre>
|
|
1095
|
-
</td>
|
|
1096
|
-
</tr>
|
|
1097
|
-
</table>
|
|
1098
|
-
</div>
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
<span id=""></span>
|
|
1102
|
-
<div class="method_details ">
|
|
1103
|
-
<h3 class="signature " id="options-instance_method">
|
|
1104
|
-
|
|
1105
|
-
- (<tt>Hash</tt>) <strong>options</strong> <span class="extras">(readonly)</span>
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
</h3><div class="docstring">
|
|
1112
|
-
<div class="discussion">
|
|
1113
|
-
|
|
1114
|
-
<p>Query options</p>
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
</div>
|
|
1118
|
-
</div>
|
|
1119
|
-
<div class="tags">
|
|
1120
|
-
|
|
1121
|
-
<p class="tag_title">Returns:</p>
|
|
1122
|
-
<ul class="return">
|
|
1123
|
-
|
|
1124
|
-
<li>
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
—
|
|
1132
|
-
<div class='inline'>
|
|
1133
|
-
<p>query options</p>
|
|
1134
|
-
</div>
|
|
1135
|
-
|
|
1136
|
-
</li>
|
|
1137
|
-
|
|
1138
|
-
</ul>
|
|
1139
|
-
|
|
1140
|
-
</div><table class="source_code">
|
|
1141
|
-
<tr>
|
|
1142
|
-
<td>
|
|
1143
|
-
<pre class="lines">
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
20
|
|
1147
|
-
21
|
|
1148
|
-
22</pre>
|
|
1149
|
-
</td>
|
|
1150
|
-
<td>
|
|
1151
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 20</span>
|
|
1152
|
-
|
|
1153
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
|
|
1154
|
-
<span class='ivar'>@options</span>
|
|
1155
|
-
<span class='kw'>end</span></pre>
|
|
1156
|
-
</td>
|
|
1157
|
-
</tr>
|
|
1158
|
-
</table>
|
|
1159
|
-
</div>
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
<span id=""></span>
|
|
1163
|
-
<div class="method_details ">
|
|
1164
|
-
<h3 class="signature " id="response-instance_method">
|
|
1165
|
-
|
|
1166
|
-
- (<tt>Faraday::Response</tt>) <strong>response</strong> <span class="extras">(readonly)</span>
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
</h3><div class="docstring">
|
|
1173
|
-
<div class="discussion">
|
|
1174
|
-
|
|
1175
|
-
<p>The last response</p>
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
</div>
|
|
1179
|
-
</div>
|
|
1180
|
-
<div class="tags">
|
|
1181
|
-
|
|
1182
|
-
<p class="tag_title">Returns:</p>
|
|
1183
|
-
<ul class="return">
|
|
1184
|
-
|
|
1185
|
-
<li>
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
<span class='type'>(<tt>Faraday::Response</tt>)</span>
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
—
|
|
1193
|
-
<div class='inline'>
|
|
1194
|
-
<p>The last response</p>
|
|
1195
|
-
</div>
|
|
1196
|
-
|
|
1197
|
-
</li>
|
|
1198
|
-
|
|
1199
|
-
</ul>
|
|
1200
|
-
|
|
1201
|
-
</div><table class="source_code">
|
|
1202
|
-
<tr>
|
|
1203
|
-
<td>
|
|
1204
|
-
<pre class="lines">
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
17
|
|
1208
|
-
18
|
|
1209
|
-
19</pre>
|
|
1210
|
-
</td>
|
|
1211
|
-
<td>
|
|
1212
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 17</span>
|
|
1213
|
-
|
|
1214
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
|
1215
|
-
<span class='ivar'>@response</span>
|
|
1216
|
-
<span class='kw'>end</span></pre>
|
|
1217
|
-
</td>
|
|
1218
|
-
</tr>
|
|
1219
|
-
</table>
|
|
1220
|
-
</div>
|
|
1221
|
-
|
|
1222
|
-
</div>
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
<div id="instance_method_details" class="method_details_list">
|
|
1226
|
-
<h2>Instance Method Details</h2>
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
<div class="method_details first">
|
|
1230
|
-
<h3 class="signature first" id="<<-instance_method">
|
|
1231
|
-
|
|
1232
|
-
- (<tt>Object</tt>) <strong><<</strong>(item)
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
</h3><div class="docstring">
|
|
1239
|
-
<div class="discussion">
|
|
1240
|
-
|
|
1241
|
-
<p>Adds an item to this collection</p>
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
</div>
|
|
1245
|
-
</div>
|
|
1246
|
-
<div class="tags">
|
|
1247
|
-
<p class="tag_title">Parameters:</p>
|
|
1248
|
-
<ul class="param">
|
|
1249
|
-
|
|
1250
|
-
<li>
|
|
1251
|
-
|
|
1252
|
-
<span class='name'>item</span>
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
—
|
|
1260
|
-
<div class='inline'>
|
|
1261
|
-
<p>a customizable set of options</p>
|
|
1262
|
-
</div>
|
|
1263
|
-
|
|
1264
|
-
</li>
|
|
1265
|
-
|
|
1266
|
-
</ul>
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
<p class="tag_title">Options Hash (<tt>item</tt>):</p>
|
|
1272
|
-
<ul class="option">
|
|
1273
|
-
|
|
1274
|
-
<li>
|
|
1275
|
-
<span class="name">the</span>
|
|
1276
|
-
<span class="type">(<tt><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">ZendeskAPI::Data</a></span></tt>)</span>
|
|
1277
|
-
<span class="default">
|
|
1278
|
-
|
|
1279
|
-
</span>
|
|
1280
|
-
|
|
1281
|
-
— <div class='inline'>
|
|
1282
|
-
<p>resource to add</p>
|
|
1283
|
-
</div>
|
|
1284
|
-
|
|
1285
|
-
</li>
|
|
1286
|
-
|
|
1287
|
-
</ul>
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
<p class="tag_title">Raises:</p>
|
|
1291
|
-
<ul class="raise">
|
|
1292
|
-
|
|
1293
|
-
<li>
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
—
|
|
1301
|
-
<div class='inline'>
|
|
1302
|
-
<p>if the resource doesn't belong in this collection</p>
|
|
1303
|
-
</div>
|
|
1304
|
-
|
|
1305
|
-
</li>
|
|
1306
|
-
|
|
1307
|
-
</ul>
|
|
1308
|
-
|
|
1309
|
-
</div><table class="source_code">
|
|
1310
|
-
<tr>
|
|
1311
|
-
<td>
|
|
1312
|
-
<pre class="lines">
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
120
|
|
1316
|
-
121
|
|
1317
|
-
122
|
|
1318
|
-
123
|
|
1319
|
-
124
|
|
1320
|
-
125
|
|
1321
|
-
126
|
|
1322
|
-
127
|
|
1323
|
-
128
|
|
1324
|
-
129
|
|
1325
|
-
130
|
|
1326
|
-
131
|
|
1327
|
-
132</pre>
|
|
1328
|
-
</td>
|
|
1329
|
-
<td>
|
|
1330
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 120</span>
|
|
1331
|
-
|
|
1332
|
-
<span class='kw'>def</span> <span class='op'><<</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
|
|
1333
|
-
<span class='id identifier rubyid_fetch'>fetch</span>
|
|
1334
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Resource</span><span class='rparen'>)</span>
|
|
1335
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='ivar'>@resource_class</span><span class='rparen'>)</span>
|
|
1336
|
-
<span class='ivar'>@resources</span> <span class='op'><<</span> <span class='id identifier rubyid_item'>item</span>
|
|
1337
|
-
<span class='kw'>else</span>
|
|
1338
|
-
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>this collection is for </span><span class='embexpr_beg'>#{</span><span class='ivar'>@resource_class</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
1339
|
-
<span class='kw'>end</span>
|
|
1340
|
-
<span class='kw'>else</span>
|
|
1341
|
-
<span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=></span> <span class='ivar'>@association</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</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>
|
|
1342
|
-
<span class='ivar'>@resources</span> <span class='op'><<</span> <span class='ivar'>@resource_class</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='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
|
|
1343
|
-
<span class='kw'>end</span>
|
|
1344
|
-
<span class='kw'>end</span></pre>
|
|
1345
|
-
</td>
|
|
1346
|
-
</tr>
|
|
1347
|
-
</table>
|
|
1348
|
-
</div>
|
|
1349
|
-
|
|
1350
|
-
<div class="method_details ">
|
|
1351
|
-
<h3 class="signature " id="all-instance_method">
|
|
1352
|
-
|
|
1353
|
-
- (<tt>Object</tt>) <strong>all</strong>(start_page = @options["page"], &block)
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
</h3><div class="docstring">
|
|
1360
|
-
<div class="discussion">
|
|
1361
|
-
|
|
1362
|
-
<p>Calls #each on every page with the passed in block</p>
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
</div>
|
|
1366
|
-
</div>
|
|
1367
|
-
<div class="tags">
|
|
1368
|
-
<p class="tag_title">Parameters:</p>
|
|
1369
|
-
<ul class="param">
|
|
1370
|
-
|
|
1371
|
-
<li>
|
|
1372
|
-
|
|
1373
|
-
<span class='name'>block</span>
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
<span class='type'>(<tt>Block</tt>)</span>
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
—
|
|
1381
|
-
<div class='inline'>
|
|
1382
|
-
<p>Passed to #each</p>
|
|
1383
|
-
</div>
|
|
1384
|
-
|
|
1385
|
-
</li>
|
|
1386
|
-
|
|
1387
|
-
</ul>
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
</div><table class="source_code">
|
|
1391
|
-
<tr>
|
|
1392
|
-
<td>
|
|
1393
|
-
<pre class="lines">
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
179
|
|
1397
|
-
180
|
|
1398
|
-
181</pre>
|
|
1399
|
-
</td>
|
|
1400
|
-
<td>
|
|
1401
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 179</span>
|
|
1402
|
-
|
|
1403
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='id identifier rubyid_start_page'>start_page</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1404
|
-
<span class='id identifier rubyid__all'>_all</span><span class='lparen'>(</span><span class='id identifier rubyid_start_page'>start_page</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1405
|
-
<span class='kw'>end</span></pre>
|
|
1406
|
-
</td>
|
|
1407
|
-
</tr>
|
|
1408
|
-
</table>
|
|
1409
|
-
</div>
|
|
1410
|
-
|
|
1411
|
-
<div class="method_details ">
|
|
1412
|
-
<h3 class="signature " id="all!-instance_method">
|
|
1413
|
-
|
|
1414
|
-
- (<tt>Object</tt>) <strong>all!</strong>(start_page = @options["page"], &block)
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
</h3><div class="docstring">
|
|
1421
|
-
<div class="discussion">
|
|
1422
|
-
|
|
1423
|
-
<p>Calls #each on every page with the passed in block</p>
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
</div>
|
|
1427
|
-
</div>
|
|
1428
|
-
<div class="tags">
|
|
1429
|
-
<p class="tag_title">Parameters:</p>
|
|
1430
|
-
<ul class="param">
|
|
1431
|
-
|
|
1432
|
-
<li>
|
|
1433
|
-
|
|
1434
|
-
<span class='name'>block</span>
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
<span class='type'>(<tt>Block</tt>)</span>
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
—
|
|
1442
|
-
<div class='inline'>
|
|
1443
|
-
<p>Passed to #each</p>
|
|
1444
|
-
</div>
|
|
1445
|
-
|
|
1446
|
-
</li>
|
|
1447
|
-
|
|
1448
|
-
</ul>
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
</div><table class="source_code">
|
|
1452
|
-
<tr>
|
|
1453
|
-
<td>
|
|
1454
|
-
<pre class="lines">
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
173
|
|
1458
|
-
174
|
|
1459
|
-
175</pre>
|
|
1460
|
-
</td>
|
|
1461
|
-
<td>
|
|
1462
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 173</span>
|
|
1463
|
-
|
|
1464
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_all!'>all!</span><span class='lparen'>(</span><span class='id identifier rubyid_start_page'>start_page</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1465
|
-
<span class='id identifier rubyid__all'>_all</span><span class='lparen'>(</span><span class='id identifier rubyid_start_page'>start_page</span><span class='comma'>,</span> <span class='symbol'>:bang</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1466
|
-
<span class='kw'>end</span></pre>
|
|
1467
|
-
</td>
|
|
1468
|
-
</tr>
|
|
1469
|
-
</table>
|
|
1470
|
-
</div>
|
|
1471
|
-
|
|
1472
|
-
<div class="method_details ">
|
|
1473
|
-
<h3 class="signature " id="clear_cache-instance_method">
|
|
1474
|
-
|
|
1475
|
-
- (<tt>Object</tt>) <strong>clear_cache</strong>
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
</h3><div class="docstring">
|
|
1482
|
-
<div class="discussion">
|
|
1483
|
-
|
|
1484
|
-
<p>Clears all cached resources and associated values.</p>
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
</div>
|
|
1488
|
-
</div>
|
|
1489
|
-
<div class="tags">
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
</div><table class="source_code">
|
|
1493
|
-
<tr>
|
|
1494
|
-
<td>
|
|
1495
|
-
<pre class="lines">
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
234
|
|
1499
|
-
235
|
|
1500
|
-
236
|
|
1501
|
-
237
|
|
1502
|
-
238
|
|
1503
|
-
239</pre>
|
|
1504
|
-
</td>
|
|
1505
|
-
<td>
|
|
1506
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 234</span>
|
|
1507
|
-
|
|
1508
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_clear_cache'>clear_cache</span>
|
|
1509
|
-
<span class='ivar'>@resources</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1510
|
-
<span class='ivar'>@count</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1511
|
-
<span class='ivar'>@next_page</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1512
|
-
<span class='ivar'>@prev_page</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1513
|
-
<span class='kw'>end</span></pre>
|
|
1514
|
-
</td>
|
|
1515
|
-
</tr>
|
|
1516
|
-
</table>
|
|
1517
|
-
</div>
|
|
1518
|
-
|
|
1519
|
-
<div class="method_details ">
|
|
1520
|
-
<h3 class="signature " id="count-instance_method">
|
|
1521
|
-
|
|
1522
|
-
- (<tt>Number</tt>) <strong>count</strong>
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
</h3><div class="docstring">
|
|
1529
|
-
<div class="discussion">
|
|
1530
|
-
|
|
1531
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
</div>
|
|
1535
|
-
</div>
|
|
1536
|
-
<div class="tags">
|
|
1537
|
-
|
|
1538
|
-
<p class="tag_title">Returns:</p>
|
|
1539
|
-
<ul class="return">
|
|
1540
|
-
|
|
1541
|
-
<li>
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
<span class='type'>(<tt>Number</tt>)</span>
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
—
|
|
1549
|
-
<div class='inline'>
|
|
1550
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
1551
|
-
</div>
|
|
1552
|
-
|
|
1553
|
-
</li>
|
|
1554
|
-
|
|
1555
|
-
</ul>
|
|
1556
|
-
|
|
1557
|
-
</div><table class="source_code">
|
|
1558
|
-
<tr>
|
|
1559
|
-
<td>
|
|
1560
|
-
<pre class="lines">
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
64
|
|
1564
|
-
65
|
|
1565
|
-
66
|
|
1566
|
-
67</pre>
|
|
1567
|
-
</td>
|
|
1568
|
-
<td>
|
|
1569
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 64</span>
|
|
1570
|
-
|
|
1571
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
|
|
1572
|
-
<span class='id identifier rubyid_fetch'>fetch</span>
|
|
1573
|
-
<span class='ivar'>@count</span> <span class='op'>||</span> <span class='op'>-</span><span class='int'>1</span>
|
|
1574
|
-
<span class='kw'>end</span></pre>
|
|
1575
|
-
</td>
|
|
1576
|
-
</tr>
|
|
1577
|
-
</table>
|
|
1578
|
-
</div>
|
|
1579
|
-
|
|
1580
|
-
<div class="method_details ">
|
|
1581
|
-
<h3 class="signature " id="count!-instance_method">
|
|
1582
|
-
|
|
1583
|
-
- (<tt>Number</tt>) <strong>count!</strong>
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
</h3><div class="docstring">
|
|
1590
|
-
<div class="discussion">
|
|
1591
|
-
|
|
1592
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
</div>
|
|
1596
|
-
</div>
|
|
1597
|
-
<div class="tags">
|
|
1598
|
-
|
|
1599
|
-
<p class="tag_title">Returns:</p>
|
|
1600
|
-
<ul class="return">
|
|
1601
|
-
|
|
1602
|
-
<li>
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
<span class='type'>(<tt>Number</tt>)</span>
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
—
|
|
1610
|
-
<div class='inline'>
|
|
1611
|
-
<p>The total number of resources server-side (disregarding pagination).</p>
|
|
1612
|
-
</div>
|
|
1613
|
-
|
|
1614
|
-
</li>
|
|
1615
|
-
|
|
1616
|
-
</ul>
|
|
1617
|
-
|
|
1618
|
-
</div><table class="source_code">
|
|
1619
|
-
<tr>
|
|
1620
|
-
<td>
|
|
1621
|
-
<pre class="lines">
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
70
|
|
1625
|
-
71
|
|
1626
|
-
72
|
|
1627
|
-
73</pre>
|
|
1628
|
-
</td>
|
|
1629
|
-
<td>
|
|
1630
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 70</span>
|
|
1631
|
-
|
|
1632
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_count!'>count!</span>
|
|
1633
|
-
<span class='id identifier rubyid_fetch!'>fetch!</span>
|
|
1634
|
-
<span class='ivar'>@count</span> <span class='op'>||</span> <span class='op'>-</span><span class='int'>1</span>
|
|
1635
|
-
<span class='kw'>end</span></pre>
|
|
1636
|
-
</td>
|
|
1637
|
-
</tr>
|
|
1638
|
-
</table>
|
|
1639
|
-
</div>
|
|
1640
|
-
|
|
1641
|
-
<div class="method_details ">
|
|
1642
|
-
<h3 class="signature " id="each_page-instance_method">
|
|
1643
|
-
|
|
1644
|
-
- (<tt>Object</tt>) <strong>each_page</strong>(*args, &block)
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
</h3><table class="source_code">
|
|
1651
|
-
<tr>
|
|
1652
|
-
<td>
|
|
1653
|
-
<pre class="lines">
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
188
|
|
1657
|
-
189
|
|
1658
|
-
190
|
|
1659
|
-
191</pre>
|
|
1660
|
-
</td>
|
|
1661
|
-
<td>
|
|
1662
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 188</span>
|
|
1663
|
-
|
|
1664
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_each_page'>each_page</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>
|
|
1665
|
-
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ZendeskAPI::Collection#each_page is deprecated, please use ZendeskAPI::Collection#all</span><span class='tstring_end'>"</span></span>
|
|
1666
|
-
<span class='id identifier rubyid_all'>all</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>
|
|
1667
|
-
<span class='kw'>end</span></pre>
|
|
1668
|
-
</td>
|
|
1669
|
-
</tr>
|
|
1670
|
-
</table>
|
|
1671
|
-
</div>
|
|
1672
|
-
|
|
1673
|
-
<div class="method_details ">
|
|
1674
|
-
<h3 class="signature " id="each_page!-instance_method">
|
|
1675
|
-
|
|
1676
|
-
- (<tt>Object</tt>) <strong>each_page!</strong>(*args, &block)
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
</h3><table class="source_code">
|
|
1683
|
-
<tr>
|
|
1684
|
-
<td>
|
|
1685
|
-
<pre class="lines">
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
183
|
|
1689
|
-
184
|
|
1690
|
-
185
|
|
1691
|
-
186</pre>
|
|
1692
|
-
</td>
|
|
1693
|
-
<td>
|
|
1694
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 183</span>
|
|
1695
|
-
|
|
1696
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_each_page!'>each_page!</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>
|
|
1697
|
-
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ZendeskAPI::Collection#each_page! is deprecated, please use ZendeskAPI::Collection#all!</span><span class='tstring_end'>"</span></span>
|
|
1698
|
-
<span class='id identifier rubyid_all!'>all!</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>
|
|
1699
|
-
<span class='kw'>end</span></pre>
|
|
1700
|
-
</td>
|
|
1701
|
-
</tr>
|
|
1702
|
-
</table>
|
|
1703
|
-
</div>
|
|
1704
|
-
|
|
1705
|
-
<div class="method_details ">
|
|
1706
|
-
<h3 class="signature " id="fetch-instance_method">
|
|
1707
|
-
|
|
1708
|
-
- (<tt>Object</tt>) <strong>fetch</strong>(*args)
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
</h3><table class="source_code">
|
|
1715
|
-
<tr>
|
|
1716
|
-
<td>
|
|
1717
|
-
<pre class="lines">
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
155
|
|
1721
|
-
156
|
|
1722
|
-
157
|
|
1723
|
-
158
|
|
1724
|
-
159</pre>
|
|
1725
|
-
</td>
|
|
1726
|
-
<td>
|
|
1727
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 155</span>
|
|
1728
|
-
|
|
1729
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
|
1730
|
-
<span class='id identifier rubyid_fetch!'>fetch!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
|
|
1731
|
-
<span class='kw'>rescue</span> <span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>ClientError</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
|
1732
|
-
<span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
1733
|
-
<span class='kw'>end</span></pre>
|
|
1734
|
-
</td>
|
|
1735
|
-
</tr>
|
|
1736
|
-
</table>
|
|
1737
|
-
</div>
|
|
1738
|
-
|
|
1739
|
-
<div class="method_details ">
|
|
1740
|
-
<h3 class="signature " id="fetch!-instance_method">
|
|
1741
|
-
|
|
1742
|
-
- (<tt>Object</tt>) <strong>fetch!</strong>(reload = false)
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
</h3><div class="docstring">
|
|
1749
|
-
<div class="discussion">
|
|
1750
|
-
|
|
1751
|
-
<p>Executes actual GET from API and loads resources into proper class.</p>
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
</div>
|
|
1755
|
-
</div>
|
|
1756
|
-
<div class="tags">
|
|
1757
|
-
<p class="tag_title">Parameters:</p>
|
|
1758
|
-
<ul class="param">
|
|
1759
|
-
|
|
1760
|
-
<li>
|
|
1761
|
-
|
|
1762
|
-
<span class='name'>reload</span>
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
—
|
|
1772
|
-
<div class='inline'>
|
|
1773
|
-
<p>Whether to disregard cache</p>
|
|
1774
|
-
</div>
|
|
1775
|
-
|
|
1776
|
-
</li>
|
|
1777
|
-
|
|
1778
|
-
</ul>
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
</div><table class="source_code">
|
|
1782
|
-
<tr>
|
|
1783
|
-
<td>
|
|
1784
|
-
<pre class="lines">
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
141
|
|
1788
|
-
142
|
|
1789
|
-
143
|
|
1790
|
-
144
|
|
1791
|
-
145
|
|
1792
|
-
146
|
|
1793
|
-
147
|
|
1794
|
-
148
|
|
1795
|
-
149
|
|
1796
|
-
150
|
|
1797
|
-
151
|
|
1798
|
-
152
|
|
1799
|
-
153</pre>
|
|
1800
|
-
</td>
|
|
1801
|
-
<td>
|
|
1802
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 141</span>
|
|
1803
|
-
|
|
1804
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_fetch!'>fetch!</span><span class='lparen'>(</span><span class='id identifier rubyid_reload'>reload</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1805
|
-
<span class='kw'>if</span> <span class='ivar'>@resources</span> <span class='op'>&&</span> <span class='lparen'>(</span><span class='op'>!</span><span class='ivar'>@fetchable</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_reload'>reload</span><span class='rparen'>)</span>
|
|
1806
|
-
<span class='kw'>return</span> <span class='ivar'>@resources</span>
|
|
1807
|
-
<span class='kw'>elsif</span> <span class='id identifier rubyid_association'>association</span> <span class='op'>&&</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> <span class='op'>&&</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><span class='period'>.</span><span class='id identifier rubyid_new_record?'>new_record?</span>
|
|
1808
|
-
<span class='kw'>return</span> <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
1809
|
-
<span class='kw'>end</span>
|
|
1810
|
-
|
|
1811
|
-
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='ivar'>@query</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1812
|
-
<span class='id identifier rubyid_handle_response'>handle_response</span><span class='lparen'>(</span><span class='ivar'>@response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='rparen'>)</span>
|
|
1813
|
-
|
|
1814
|
-
<span class='ivar'>@query</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1815
|
-
<span class='ivar'>@resources</span>
|
|
1816
|
-
<span class='kw'>end</span></pre>
|
|
1817
|
-
</td>
|
|
1818
|
-
</tr>
|
|
1819
|
-
</table>
|
|
1820
|
-
</div>
|
|
1821
|
-
|
|
1822
|
-
<div class="method_details ">
|
|
1823
|
-
<h3 class="signature " id="first_page?-instance_method">
|
|
1824
|
-
|
|
1825
|
-
- (<tt>Boolean</tt>) <strong>first_page?</strong>
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
</h3><div class="docstring">
|
|
1832
|
-
<div class="discussion">
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
</div>
|
|
1836
|
-
</div>
|
|
1837
|
-
<div class="tags">
|
|
1838
|
-
|
|
1839
|
-
<p class="tag_title">Returns:</p>
|
|
1840
|
-
<ul class="return">
|
|
1841
|
-
|
|
1842
|
-
<li>
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
</li>
|
|
1850
|
-
|
|
1851
|
-
</ul>
|
|
1852
|
-
|
|
1853
|
-
</div><table class="source_code">
|
|
1854
|
-
<tr>
|
|
1855
|
-
<td>
|
|
1856
|
-
<pre class="lines">
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
91
|
|
1860
|
-
92
|
|
1861
|
-
93</pre>
|
|
1862
|
-
</td>
|
|
1863
|
-
<td>
|
|
1864
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 91</span>
|
|
1865
|
-
|
|
1866
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_first_page?'>first_page?</span>
|
|
1867
|
-
<span class='op'>!</span><span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'><=</span> <span class='int'>1</span>
|
|
1868
|
-
<span class='kw'>end</span></pre>
|
|
1869
|
-
</td>
|
|
1870
|
-
</tr>
|
|
1871
|
-
</table>
|
|
1872
|
-
</div>
|
|
1873
|
-
|
|
1874
|
-
<div class="method_details ">
|
|
1875
|
-
<h3 class="signature " id="include-instance_method">
|
|
1876
|
-
|
|
1877
|
-
- (<tt>Object</tt>) <strong>include</strong>(*sideloads)
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
</h3><div class="docstring">
|
|
1884
|
-
<div class="discussion">
|
|
1885
|
-
|
|
1886
|
-
<p>Adds an item (or items) to the list of side-loaded resources to request</p>
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
</div>
|
|
1890
|
-
</div>
|
|
1891
|
-
<div class="tags">
|
|
1892
|
-
<p class="tag_title">Parameters:</p>
|
|
1893
|
-
<ul class="param">
|
|
1894
|
-
|
|
1895
|
-
<li>
|
|
1896
|
-
|
|
1897
|
-
<span class='name'>sideloads</span>
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
—
|
|
1905
|
-
<div class='inline'>
|
|
1906
|
-
<p>a customizable set of options</p>
|
|
1907
|
-
</div>
|
|
1908
|
-
|
|
1909
|
-
</li>
|
|
1910
|
-
|
|
1911
|
-
</ul>
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
</div><table class="source_code">
|
|
1919
|
-
<tr>
|
|
1920
|
-
<td>
|
|
1921
|
-
<pre class="lines">
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
113
|
|
1925
|
-
114
|
|
1926
|
-
115</pre>
|
|
1927
|
-
</td>
|
|
1928
|
-
<td>
|
|
1929
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 113</span>
|
|
1930
|
-
|
|
1931
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sideloads'>sideloads</span><span class='rparen'>)</span>
|
|
1932
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='lbrace'>{</span> <span class='ivar'>@includes</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_sideloads'>sideloads</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1933
|
-
<span class='kw'>end</span></pre>
|
|
1934
|
-
</td>
|
|
1935
|
-
</tr>
|
|
1936
|
-
</table>
|
|
1937
|
-
</div>
|
|
1938
|
-
|
|
1939
|
-
<div class="method_details ">
|
|
1940
|
-
<h3 class="signature " id="last_page?-instance_method">
|
|
1941
|
-
|
|
1942
|
-
- (<tt>Boolean</tt>) <strong>last_page?</strong>
|
|
1943
|
-
|
|
1944
|
-
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
</h3><div class="docstring">
|
|
1949
|
-
<div class="discussion">
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
</div>
|
|
1953
|
-
</div>
|
|
1954
|
-
<div class="tags">
|
|
1955
|
-
|
|
1956
|
-
<p class="tag_title">Returns:</p>
|
|
1957
|
-
<ul class="return">
|
|
1958
|
-
|
|
1959
|
-
<li>
|
|
1960
|
-
|
|
1961
|
-
|
|
1962
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
</li>
|
|
1967
|
-
|
|
1968
|
-
</ul>
|
|
1969
|
-
|
|
1970
|
-
</div><table class="source_code">
|
|
1971
|
-
<tr>
|
|
1972
|
-
<td>
|
|
1973
|
-
<pre class="lines">
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
95
|
|
1977
|
-
96
|
|
1978
|
-
97</pre>
|
|
1979
|
-
</td>
|
|
1980
|
-
<td>
|
|
1981
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 95</span>
|
|
1982
|
-
|
|
1983
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_last_page?'>last_page?</span>
|
|
1984
|
-
<span class='op'>!</span><span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>*</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>per_page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>>=</span> <span class='id identifier rubyid_count'>count</span>
|
|
1985
|
-
<span class='kw'>end</span></pre>
|
|
1986
|
-
</td>
|
|
1987
|
-
</tr>
|
|
1988
|
-
</table>
|
|
1989
|
-
</div>
|
|
1990
|
-
|
|
1991
|
-
<div class="method_details ">
|
|
1992
|
-
<h3 class="signature " id="next-instance_method">
|
|
1993
|
-
|
|
1994
|
-
- (<tt>Object</tt>) <strong>next</strong>
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
</h3><div class="docstring">
|
|
2001
|
-
<div class="discussion">
|
|
2002
|
-
|
|
2003
|
-
<p>Find the next page. Does one of three things:</p>
|
|
2004
|
-
<ul><li>
|
|
2005
|
-
<p>If there is already a page number in the options hash, it increases it and
|
|
2006
|
-
invalidates the cache, returning the new page number.</p>
|
|
2007
|
-
</li><li>
|
|
2008
|
-
<p>If there is a next_page url cached, it executes a fetch on that url and
|
|
2009
|
-
returns the results.</p>
|
|
2010
|
-
</li><li>
|
|
2011
|
-
<p>Otherwise, returns an empty array.</p>
|
|
2012
|
-
</li></ul>
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
</div>
|
|
2016
|
-
</div>
|
|
2017
|
-
<div class="tags">
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
</div><table class="source_code">
|
|
2021
|
-
<tr>
|
|
2022
|
-
<td>
|
|
2023
|
-
<pre class="lines">
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
205
|
|
2027
|
-
206
|
|
2028
|
-
207
|
|
2029
|
-
208
|
|
2030
|
-
209
|
|
2031
|
-
210
|
|
2032
|
-
211
|
|
2033
|
-
212
|
|
2034
|
-
213
|
|
2035
|
-
214
|
|
2036
|
-
215</pre>
|
|
2037
|
-
</td>
|
|
2038
|
-
<td>
|
|
2039
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 205</span>
|
|
2040
|
-
|
|
2041
|
-
<span class='kw'>def</span> <span class='kw'>next</span>
|
|
2042
|
-
<span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
2043
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span>
|
|
2044
|
-
<span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>+=</span> <span class='int'>1</span>
|
|
2045
|
-
<span class='kw'>elsif</span> <span class='ivar'>@query</span> <span class='op'>=</span> <span class='ivar'>@next_page</span>
|
|
2046
|
-
<span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
|
|
2047
|
-
<span class='kw'>else</span>
|
|
2048
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span>
|
|
2049
|
-
<span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
2050
|
-
<span class='kw'>end</span>
|
|
2051
|
-
<span class='kw'>end</span></pre>
|
|
2052
|
-
</td>
|
|
2053
|
-
</tr>
|
|
2054
|
-
</table>
|
|
2055
|
-
</div>
|
|
2056
|
-
|
|
2057
|
-
<div class="method_details ">
|
|
2058
|
-
<h3 class="signature " id="page-instance_method">
|
|
2059
|
-
|
|
2060
|
-
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>page</strong>(number)
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
</h3><div class="docstring">
|
|
2067
|
-
<div class="discussion">
|
|
2068
|
-
|
|
2069
|
-
<p>Changes the page option. Returns self, so it can be chained. No execution.</p>
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
</div>
|
|
2073
|
-
</div>
|
|
2074
|
-
<div class="tags">
|
|
2075
|
-
|
|
2076
|
-
<p class="tag_title">Returns:</p>
|
|
2077
|
-
<ul class="return">
|
|
2078
|
-
|
|
2079
|
-
<li>
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
—
|
|
2087
|
-
<div class='inline'>
|
|
2088
|
-
<p>self</p>
|
|
2089
|
-
</div>
|
|
2090
|
-
|
|
2091
|
-
</li>
|
|
2092
|
-
|
|
2093
|
-
</ul>
|
|
2094
|
-
|
|
2095
|
-
</div><table class="source_code">
|
|
2096
|
-
<tr>
|
|
2097
|
-
<td>
|
|
2098
|
-
<pre class="lines">
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
85
|
|
2102
|
-
86
|
|
2103
|
-
87
|
|
2104
|
-
88
|
|
2105
|
-
89</pre>
|
|
2106
|
-
</td>
|
|
2107
|
-
<td>
|
|
2108
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 85</span>
|
|
2109
|
-
|
|
2110
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='id identifier rubyid_number'>number</span><span class='rparen'>)</span>
|
|
2111
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span> <span class='kw'>if</span> <span class='id identifier rubyid_number'>number</span>
|
|
2112
|
-
<span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_number'>number</span>
|
|
2113
|
-
<span class='kw'>self</span>
|
|
2114
|
-
<span class='kw'>end</span></pre>
|
|
2115
|
-
</td>
|
|
2116
|
-
</tr>
|
|
2117
|
-
</table>
|
|
2118
|
-
</div>
|
|
2119
|
-
|
|
2120
|
-
<div class="method_details ">
|
|
2121
|
-
<h3 class="signature " id="path-instance_method">
|
|
2122
|
-
|
|
2123
|
-
- (<tt>Object</tt>) <strong>path</strong>
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
</h3><div class="docstring">
|
|
2130
|
-
<div class="discussion">
|
|
2131
|
-
|
|
2132
|
-
<p>The API path to this collection</p>
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
</div>
|
|
2136
|
-
</div>
|
|
2137
|
-
<div class="tags">
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
</div><table class="source_code">
|
|
2141
|
-
<tr>
|
|
2142
|
-
<td>
|
|
2143
|
-
<pre class="lines">
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
135
|
|
2147
|
-
136
|
|
2148
|
-
137</pre>
|
|
2149
|
-
</td>
|
|
2150
|
-
<td>
|
|
2151
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 135</span>
|
|
2152
|
-
|
|
2153
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
|
|
2154
|
-
<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='symbol'>:with_parent</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
2155
|
-
<span class='kw'>end</span></pre>
|
|
2156
|
-
</td>
|
|
2157
|
-
</tr>
|
|
2158
|
-
</table>
|
|
2159
|
-
</div>
|
|
2160
|
-
|
|
2161
|
-
<div class="method_details ">
|
|
2162
|
-
<h3 class="signature " id="per_page-instance_method">
|
|
2163
|
-
|
|
2164
|
-
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>per_page</strong>(count)
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
</h3><div class="docstring">
|
|
2171
|
-
<div class="discussion">
|
|
2172
|
-
|
|
2173
|
-
<p>Changes the per_page option. Returns self, so it can be chained. No
|
|
2174
|
-
execution.</p>
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
</div>
|
|
2178
|
-
</div>
|
|
2179
|
-
<div class="tags">
|
|
2180
|
-
|
|
2181
|
-
<p class="tag_title">Returns:</p>
|
|
2182
|
-
<ul class="return">
|
|
2183
|
-
|
|
2184
|
-
<li>
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
—
|
|
2192
|
-
<div class='inline'>
|
|
2193
|
-
<p>self</p>
|
|
2194
|
-
</div>
|
|
2195
|
-
|
|
2196
|
-
</li>
|
|
2197
|
-
|
|
2198
|
-
</ul>
|
|
2199
|
-
|
|
2200
|
-
</div><table class="source_code">
|
|
2201
|
-
<tr>
|
|
2202
|
-
<td>
|
|
2203
|
-
<pre class="lines">
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
77
|
|
2207
|
-
78
|
|
2208
|
-
79
|
|
2209
|
-
80
|
|
2210
|
-
81</pre>
|
|
2211
|
-
</td>
|
|
2212
|
-
<td>
|
|
2213
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 77</span>
|
|
2214
|
-
|
|
2215
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='lparen'>(</span><span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
|
|
2216
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span>
|
|
2217
|
-
<span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>per_page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span>
|
|
2218
|
-
<span class='kw'>self</span>
|
|
2219
|
-
<span class='kw'>end</span></pre>
|
|
2220
|
-
</td>
|
|
2221
|
-
</tr>
|
|
2222
|
-
</table>
|
|
2223
|
-
</div>
|
|
2224
|
-
|
|
2225
|
-
<div class="method_details ">
|
|
2226
|
-
<h3 class="signature " id="prev-instance_method">
|
|
2227
|
-
|
|
2228
|
-
- (<tt>Object</tt>) <strong>prev</strong>
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
</h3><div class="docstring">
|
|
2235
|
-
<div class="discussion">
|
|
2236
|
-
|
|
2237
|
-
<p>Find the previous page. Does one of three things:</p>
|
|
2238
|
-
<ul><li>
|
|
2239
|
-
<p>If there is already a page number in the options hash, it increases it and
|
|
2240
|
-
invalidates the cache, returning the new page number.</p>
|
|
2241
|
-
</li><li>
|
|
2242
|
-
<p>If there is a prev_page url cached, it executes a fetch on that url and
|
|
2243
|
-
returns the results.</p>
|
|
2244
|
-
</li><li>
|
|
2245
|
-
<p>Otherwise, returns an empty array.</p>
|
|
2246
|
-
</li></ul>
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
</div>
|
|
2250
|
-
</div>
|
|
2251
|
-
<div class="tags">
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
</div><table class="source_code">
|
|
2255
|
-
<tr>
|
|
2256
|
-
<td>
|
|
2257
|
-
<pre class="lines">
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
221
|
|
2261
|
-
222
|
|
2262
|
-
223
|
|
2263
|
-
224
|
|
2264
|
-
225
|
|
2265
|
-
226
|
|
2266
|
-
227
|
|
2267
|
-
228
|
|
2268
|
-
229
|
|
2269
|
-
230
|
|
2270
|
-
231</pre>
|
|
2271
|
-
</td>
|
|
2272
|
-
<td>
|
|
2273
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 221</span>
|
|
2274
|
-
|
|
2275
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_prev'>prev</span>
|
|
2276
|
-
<span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>></span> <span class='int'>1</span>
|
|
2277
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span>
|
|
2278
|
-
<span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>-=</span> <span class='int'>1</span>
|
|
2279
|
-
<span class='kw'>elsif</span> <span class='ivar'>@query</span> <span class='op'>=</span> <span class='ivar'>@prev_page</span>
|
|
2280
|
-
<span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
|
|
2281
|
-
<span class='kw'>else</span>
|
|
2282
|
-
<span class='id identifier rubyid_clear_cache'>clear_cache</span>
|
|
2283
|
-
<span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
2284
|
-
<span class='kw'>end</span>
|
|
2285
|
-
<span class='kw'>end</span></pre>
|
|
2286
|
-
</td>
|
|
2287
|
-
</tr>
|
|
2288
|
-
</table>
|
|
2289
|
-
</div>
|
|
2290
|
-
|
|
2291
|
-
<div class="method_details ">
|
|
2292
|
-
<h3 class="signature " id="replace-instance_method">
|
|
2293
|
-
|
|
2294
|
-
- (<tt>Object</tt>) <strong>replace</strong>(collection)
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
</h3><div class="docstring">
|
|
2301
|
-
<div class="discussion">
|
|
2302
|
-
|
|
2303
|
-
<p>Replaces the current (loaded or not) resources with the passed in
|
|
2304
|
-
collection</p>
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
</div>
|
|
2308
|
-
</div>
|
|
2309
|
-
<div class="tags">
|
|
2310
|
-
<p class="tag_title">Parameters:</p>
|
|
2311
|
-
<ul class="param">
|
|
2312
|
-
|
|
2313
|
-
<li>
|
|
2314
|
-
|
|
2315
|
-
<span class='name'>collection</span>
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
—
|
|
2323
|
-
<div class='inline'>
|
|
2324
|
-
<p>a customizable set of options</p>
|
|
2325
|
-
</div>
|
|
2326
|
-
|
|
2327
|
-
</li>
|
|
2328
|
-
|
|
2329
|
-
</ul>
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
<p class="tag_title">Options Hash (<tt>collection</tt>):</p>
|
|
2335
|
-
<ul class="option">
|
|
2336
|
-
|
|
2337
|
-
<li>
|
|
2338
|
-
<span class="name">The</span>
|
|
2339
|
-
<span class="type">(<tt>Array</tt>)</span>
|
|
2340
|
-
<span class="default">
|
|
2341
|
-
|
|
2342
|
-
</span>
|
|
2343
|
-
|
|
2344
|
-
— <div class='inline'>
|
|
2345
|
-
<p>collection to replace this one with</p>
|
|
2346
|
-
</div>
|
|
2347
|
-
|
|
2348
|
-
</li>
|
|
2349
|
-
|
|
2350
|
-
</ul>
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
<p class="tag_title">Raises:</p>
|
|
2354
|
-
<ul class="raise">
|
|
2355
|
-
|
|
2356
|
-
<li>
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
—
|
|
2364
|
-
<div class='inline'>
|
|
2365
|
-
<p>if any resources passed in don't belong in this collection</p>
|
|
2366
|
-
</div>
|
|
2367
|
-
|
|
2368
|
-
</li>
|
|
2369
|
-
|
|
2370
|
-
</ul>
|
|
2371
|
-
|
|
2372
|
-
</div><table class="source_code">
|
|
2373
|
-
<tr>
|
|
2374
|
-
<td>
|
|
2375
|
-
<pre class="lines">
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
196
|
|
2379
|
-
197
|
|
2380
|
-
198
|
|
2381
|
-
199</pre>
|
|
2382
|
-
</td>
|
|
2383
|
-
<td>
|
|
2384
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 196</span>
|
|
2385
|
-
|
|
2386
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='rparen'>)</span>
|
|
2387
|
-
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>this collection is for </span><span class='embexpr_beg'>#{</span><span class='ivar'>@resource_class</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='op'>!</span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='ivar'>@resource_class</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
2388
|
-
<span class='ivar'>@resources</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span>
|
|
2389
|
-
<span class='kw'>end</span></pre>
|
|
2390
|
-
</td>
|
|
2391
|
-
</tr>
|
|
2392
|
-
</table>
|
|
2393
|
-
</div>
|
|
2394
|
-
|
|
2395
|
-
<div class="method_details ">
|
|
2396
|
-
<h3 class="signature " id="save-instance_method">
|
|
2397
|
-
|
|
2398
|
-
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>save</strong>
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
</h3><div class="docstring">
|
|
2405
|
-
<div class="discussion">
|
|
2406
|
-
|
|
2407
|
-
<p>Saves all newly created resources stored in this collection.</p>
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
</div>
|
|
2411
|
-
</div>
|
|
2412
|
-
<div class="tags">
|
|
2413
|
-
|
|
2414
|
-
<p class="tag_title">Returns:</p>
|
|
2415
|
-
<ul class="return">
|
|
2416
|
-
|
|
2417
|
-
<li>
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
—
|
|
2425
|
-
<div class='inline'>
|
|
2426
|
-
<p>self</p>
|
|
2427
|
-
</div>
|
|
2428
|
-
|
|
2429
|
-
</li>
|
|
2430
|
-
|
|
2431
|
-
</ul>
|
|
2432
|
-
|
|
2433
|
-
</div><table class="source_code">
|
|
2434
|
-
<tr>
|
|
2435
|
-
<td>
|
|
2436
|
-
<pre class="lines">
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
101
|
|
2440
|
-
102
|
|
2441
|
-
103</pre>
|
|
2442
|
-
</td>
|
|
2443
|
-
<td>
|
|
2444
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 101</span>
|
|
2445
|
-
|
|
2446
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span>
|
|
2447
|
-
<span class='id identifier rubyid__save'>_save</span>
|
|
2448
|
-
<span class='kw'>end</span></pre>
|
|
2449
|
-
</td>
|
|
2450
|
-
</tr>
|
|
2451
|
-
</table>
|
|
2452
|
-
</div>
|
|
2453
|
-
|
|
2454
|
-
<div class="method_details ">
|
|
2455
|
-
<h3 class="signature " id="save!-instance_method">
|
|
2456
|
-
|
|
2457
|
-
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>save!</strong>
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
</h3><div class="docstring">
|
|
2464
|
-
<div class="discussion">
|
|
2465
|
-
|
|
2466
|
-
<p>Saves all newly created resources stored in this collection.</p>
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
</div>
|
|
2470
|
-
</div>
|
|
2471
|
-
<div class="tags">
|
|
2472
|
-
|
|
2473
|
-
<p class="tag_title">Returns:</p>
|
|
2474
|
-
<ul class="return">
|
|
2475
|
-
|
|
2476
|
-
<li>
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
—
|
|
2484
|
-
<div class='inline'>
|
|
2485
|
-
<p>self</p>
|
|
2486
|
-
</div>
|
|
2487
|
-
|
|
2488
|
-
</li>
|
|
2489
|
-
|
|
2490
|
-
</ul>
|
|
2491
|
-
|
|
2492
|
-
</div><table class="source_code">
|
|
2493
|
-
<tr>
|
|
2494
|
-
<td>
|
|
2495
|
-
<pre class="lines">
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
107
|
|
2499
|
-
108
|
|
2500
|
-
109</pre>
|
|
2501
|
-
</td>
|
|
2502
|
-
<td>
|
|
2503
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 107</span>
|
|
2504
|
-
|
|
2505
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_save!'>save!</span>
|
|
2506
|
-
<span class='id identifier rubyid__save'>_save</span><span class='lparen'>(</span><span class='symbol'>:save!</span><span class='rparen'>)</span>
|
|
2507
|
-
<span class='kw'>end</span></pre>
|
|
2508
|
-
</td>
|
|
2509
|
-
</tr>
|
|
2510
|
-
</table>
|
|
2511
|
-
</div>
|
|
2512
|
-
|
|
2513
|
-
<div class="method_details ">
|
|
2514
|
-
<h3 class="signature " id="to_a-instance_method">
|
|
2515
|
-
|
|
2516
|
-
- (<tt>Object</tt>) <strong>to_a</strong>
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
</h3><div class="docstring">
|
|
2523
|
-
<div class="discussion">
|
|
2524
|
-
|
|
2525
|
-
<p>Alias for fetch(false)</p>
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
</div>
|
|
2529
|
-
</div>
|
|
2530
|
-
<div class="tags">
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
</div><table class="source_code">
|
|
2534
|
-
<tr>
|
|
2535
|
-
<td>
|
|
2536
|
-
<pre class="lines">
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
162
|
|
2540
|
-
163
|
|
2541
|
-
164</pre>
|
|
2542
|
-
</td>
|
|
2543
|
-
<td>
|
|
2544
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 162</span>
|
|
2545
|
-
|
|
2546
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span>
|
|
2547
|
-
<span class='id identifier rubyid_fetch'>fetch</span>
|
|
2548
|
-
<span class='kw'>end</span></pre>
|
|
2549
|
-
</td>
|
|
2550
|
-
</tr>
|
|
2551
|
-
</table>
|
|
2552
|
-
</div>
|
|
2553
|
-
|
|
2554
|
-
<div class="method_details ">
|
|
2555
|
-
<h3 class="signature " id="to_a!-instance_method">
|
|
2556
|
-
|
|
2557
|
-
- (<tt>Object</tt>) <strong>to_a!</strong>
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
</h3><div class="docstring">
|
|
2564
|
-
<div class="discussion">
|
|
2565
|
-
|
|
2566
|
-
<p>Alias for fetch!(false)</p>
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
</div>
|
|
2570
|
-
</div>
|
|
2571
|
-
<div class="tags">
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
</div><table class="source_code">
|
|
2575
|
-
<tr>
|
|
2576
|
-
<td>
|
|
2577
|
-
<pre class="lines">
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
167
|
|
2581
|
-
168
|
|
2582
|
-
169</pre>
|
|
2583
|
-
</td>
|
|
2584
|
-
<td>
|
|
2585
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 167</span>
|
|
2586
|
-
|
|
2587
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_to_a!'>to_a!</span>
|
|
2588
|
-
<span class='id identifier rubyid_fetch!'>fetch!</span>
|
|
2589
|
-
<span class='kw'>end</span></pre>
|
|
2590
|
-
</td>
|
|
2591
|
-
</tr>
|
|
2592
|
-
</table>
|
|
2593
|
-
</div>
|
|
2594
|
-
|
|
2595
|
-
</div>
|
|
2596
|
-
|
|
2597
|
-
</div>
|
|
2598
|
-
|
|
2599
|
-
<div id="footer">
|
|
2600
|
-
Generated on Wed May 15 18:59:36 2013 by
|
|
2601
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2602
|
-
0.8.5.2 (ruby-1.9.3).
|
|
2603
|
-
</div>
|
|
2604
|
-
|
|
2605
|
-
</body>
|
|
2606
|
-
</html>
|