gandi_v5 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/.rubocop.yml +1 -1
- data/.travis.yml +9 -0
- data/CHANGELOG.md +15 -0
- data/FUNDING.yml +10 -0
- data/README.md +7 -17
- data/gandi_v5.gemspec +3 -2
- data/lib/gandi_v5.rb +24 -10
- data/lib/gandi_v5/billing.rb +0 -2
- data/lib/gandi_v5/billing/info.rb +0 -2
- data/lib/gandi_v5/data.rb +0 -2
- data/lib/gandi_v5/data/converter.rb +0 -4
- data/lib/gandi_v5/domain.rb +159 -17
- data/lib/gandi_v5/domain/availability.rb +0 -3
- data/lib/gandi_v5/domain/availability/product.rb +0 -3
- data/lib/gandi_v5/domain/live_dns.rb +42 -0
- data/lib/gandi_v5/domain/renewal_information.rb +0 -3
- data/lib/gandi_v5/email.rb +0 -4
- data/lib/gandi_v5/email/forward.rb +108 -0
- data/lib/gandi_v5/email/mailbox.rb +0 -2
- data/lib/gandi_v5/error.rb +0 -2
- data/lib/gandi_v5/live_dns.rb +0 -4
- data/lib/gandi_v5/live_dns/domain.rb +1 -144
- data/lib/gandi_v5/live_dns/has_zone_records.rb +153 -0
- data/lib/gandi_v5/live_dns/zone.rb +1 -146
- data/lib/gandi_v5/organization.rb +28 -5
- data/lib/gandi_v5/version.rb +1 -1
- data/spec/.rubocop.yml +1 -1
- data/spec/features/domain_spec.rb +1 -1
- data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{fetch_contacts.yaml → fetch_contacts.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml +7 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml +6 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml +2 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml} +0 -3
- data/spec/fixtures/bodies/GandiV5_Domain/{restore_info.yaml → fetch_restore_info.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml} +1 -0
- data/spec/fixtures/bodies/GandiV5_Domain_Availability/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain_TLD/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain_TLD/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Forward/list.yml +6 -0
- data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Slot/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Slot/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Organization/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Organization/list.yml +7 -0
- data/spec/fixtures/vcr/Domain_features/List_domains.yml +2 -1
- data/spec/spec_helper.rb +2 -2
- data/spec/units/gandi_v5/billing_spec.rb +2 -2
- data/spec/units/gandi_v5/domain/availability_spec.rb +1 -1
- data/spec/units/gandi_v5/domain/live_dns_spec.rb +45 -0
- data/spec/units/gandi_v5/domain/tld_spec.rb +2 -2
- data/spec/units/gandi_v5/domain_spec.rb +241 -22
- data/spec/units/gandi_v5/email/forward_spec.rb +121 -0
- data/spec/units/gandi_v5/email/mailbox_spec.rb +3 -3
- data/spec/units/gandi_v5/email/slot_spec.rb +3 -3
- data/spec/units/gandi_v5/live_dns/domain_spec.rb +3 -3
- data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +2 -2
- data/spec/units/gandi_v5/live_dns/zone_spec.rb +2 -2
- data/spec/units/gandi_v5/organization_spec.rb +38 -1
- metadata +51 -77
- data/doc/GandiV5.html +0 -1183
- data/doc/GandiV5/Billing.html +0 -293
- data/doc/GandiV5/Billing/Info.html +0 -641
- data/doc/GandiV5/Billing/Info/Prepaid.html +0 -817
- data/doc/GandiV5/Data.html +0 -785
- data/doc/GandiV5/Data/ClassMethods.html +0 -223
- data/doc/GandiV5/Data/Converter.html +0 -433
- data/doc/GandiV5/Data/Converter/ArrayOf.html +0 -413
- data/doc/GandiV5/Data/Converter/Symbol.html +0 -322
- data/doc/GandiV5/Data/Converter/Time.html +0 -330
- data/doc/GandiV5/Domain.html +0 -16847
- data/doc/GandiV5/Domain/AutoRenew.html +0 -1237
- data/doc/GandiV5/Domain/Availability.html +0 -1020
- data/doc/GandiV5/Domain/Availability/Product.html +0 -988
- data/doc/GandiV5/Domain/Availability/Product/Period.html +0 -220
- data/doc/GandiV5/Domain/Availability/Product/Price.html +0 -1031
- data/doc/GandiV5/Domain/Availability/Tax.html +0 -440
- data/doc/GandiV5/Domain/Contact.html +0 -4459
- data/doc/GandiV5/Domain/Contract.html +0 -520
- data/doc/GandiV5/Domain/Dates.html +0 -1313
- data/doc/GandiV5/Domain/RenewalInformation.html +0 -1147
- data/doc/GandiV5/Domain/RestoreInformation.html +0 -339
- data/doc/GandiV5/Domain/SharingSpace.html +0 -437
- data/doc/GandiV5/Domain/TLD.html +0 -1565
- data/doc/GandiV5/Email.html +0 -144
- data/doc/GandiV5/Email/Mailbox.html +0 -6307
- data/doc/GandiV5/Email/Mailbox/Responder.html +0 -1560
- data/doc/GandiV5/Email/Offer.html +0 -514
- data/doc/GandiV5/Email/Slot.html +0 -4244
- data/doc/GandiV5/Error.html +0 -151
- data/doc/GandiV5/Error/GandiError.html +0 -270
- data/doc/GandiV5/LiveDNS.html +0 -300
- data/doc/GandiV5/LiveDNS/Domain.html +0 -2984
- data/doc/GandiV5/LiveDNS/RecordSet.html +0 -1593
- data/doc/GandiV5/LiveDNS/Zone.html +0 -8891
- data/doc/GandiV5/LiveDNS/Zone/Snapshot.html +0 -1556
- data/doc/GandiV5/Organization.html +0 -2341
- data/doc/_index.html +0 -474
- data/doc/class_list.html +0 -51
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -58
- data/doc/css/style.css +0 -496
- data/doc/file.README.html +0 -175
- data/doc/file_list.html +0 -56
- data/doc/frames.html +0 -17
- data/doc/index.html +0 -175
- data/doc/js/app.js +0 -303
- data/doc/js/full_list.js +0 -216
- data/doc/js/jquery.js +0 -4
- data/doc/method_list.html +0 -2427
- data/doc/top-level-namespace.html +0 -110
@@ -1,1237 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<title>
|
7
|
-
Class: GandiV5::Domain::AutoRenew
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.19
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
pathId = "GandiV5::Domain::AutoRenew";
|
19
|
-
relpath = '../../';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
|
23
|
-
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
24
|
-
|
25
|
-
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
26
|
-
|
27
|
-
|
28
|
-
</head>
|
29
|
-
<body>
|
30
|
-
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
32
|
-
<div id="resizer"></div>
|
33
|
-
</div>
|
34
|
-
|
35
|
-
<div id="main" tabindex="-1">
|
36
|
-
<div id="header">
|
37
|
-
<div id="menu">
|
38
|
-
|
39
|
-
<a href="../../_index.html">Index (A)</a> »
|
40
|
-
<span class='title'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span> » <span class='title'><span class='object_link'><a href="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span>
|
41
|
-
»
|
42
|
-
<span class="title">AutoRenew</span>
|
43
|
-
|
44
|
-
</div>
|
45
|
-
|
46
|
-
<div id="search">
|
47
|
-
|
48
|
-
<a class="full_list_link" id="class_list_link"
|
49
|
-
href="../../class_list.html">
|
50
|
-
|
51
|
-
<svg width="24" height="24">
|
52
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
-
</svg>
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<div id="content"><h1>Class: GandiV5::Domain::AutoRenew
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
</h1>
|
67
|
-
<div class="box_info">
|
68
|
-
|
69
|
-
<dl>
|
70
|
-
<dt>Inherits:</dt>
|
71
|
-
<dd>
|
72
|
-
<span class="inheritName">Object</span>
|
73
|
-
|
74
|
-
<ul class="fullTree">
|
75
|
-
<li>Object</li>
|
76
|
-
|
77
|
-
<li class="next">GandiV5::Domain::AutoRenew</li>
|
78
|
-
|
79
|
-
</ul>
|
80
|
-
<a href="#" class="inheritanceTree">show all</a>
|
81
|
-
|
82
|
-
</dd>
|
83
|
-
</dl>
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
<dl>
|
91
|
-
<dt>Includes:</dt>
|
92
|
-
<dd><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">GandiV5::Data</a></span></dd>
|
93
|
-
</dl>
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
<dl>
|
101
|
-
<dt>Defined in:</dt>
|
102
|
-
<dd>lib/gandi_v5/domain/auto_renew.rb</dd>
|
103
|
-
</dl>
|
104
|
-
|
105
|
-
</div>
|
106
|
-
|
107
|
-
<h2>Overview</h2><div class="docstring">
|
108
|
-
<div class="discussion">
|
109
|
-
|
110
|
-
<p>Automatic renewal information for a domain.</p>
|
111
|
-
|
112
|
-
|
113
|
-
</div>
|
114
|
-
</div>
|
115
|
-
<div class="tags">
|
116
|
-
|
117
|
-
|
118
|
-
</div>
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
123
|
-
<ul class="summary">
|
124
|
-
|
125
|
-
<li class="public ">
|
126
|
-
<span class="summary_signature">
|
127
|
-
|
128
|
-
<a href="#dates-instance_method" title="#dates (instance method)">#<strong>dates</strong> ⇒ nil, Array<Time> </a>
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
</span>
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
<span class="note title readonly">readonly</span>
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
148
|
-
|
149
|
-
</li>
|
150
|
-
|
151
|
-
|
152
|
-
<li class="public ">
|
153
|
-
<span class="summary_signature">
|
154
|
-
|
155
|
-
<a href="#domain-instance_method" title="#domain (instance method)">#<strong>domain</strong> ⇒ Object </a>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
</span>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
<span class="summary_desc"><div class='inline'>
|
173
|
-
<p>Returns the value of attribute domain.</p>
|
174
|
-
</div></span>
|
175
|
-
|
176
|
-
</li>
|
177
|
-
|
178
|
-
|
179
|
-
<li class="public ">
|
180
|
-
<span class="summary_signature">
|
181
|
-
|
182
|
-
<a href="#duration-instance_method" title="#duration (instance method)">#<strong>duration</strong> ⇒ nil, Integer </a>
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
</span>
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
<span class="note title readonly">readonly</span>
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
202
|
-
|
203
|
-
</li>
|
204
|
-
|
205
|
-
|
206
|
-
<li class="public ">
|
207
|
-
<span class="summary_signature">
|
208
|
-
|
209
|
-
<a href="#enabled-instance_method" title="#enabled (instance method)">#<strong>enabled</strong> ⇒ nil, Boolean </a>
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
</span>
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
<span class="note title readonly">readonly</span>
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
229
|
-
|
230
|
-
</li>
|
231
|
-
|
232
|
-
|
233
|
-
<li class="public ">
|
234
|
-
<span class="summary_signature">
|
235
|
-
|
236
|
-
<a href="#org_id-instance_method" title="#org_id (instance method)">#<strong>org_id</strong> ⇒ nil, String </a>
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
</span>
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
<span class="note title readonly">readonly</span>
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
256
|
-
|
257
|
-
</li>
|
258
|
-
|
259
|
-
|
260
|
-
</ul>
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
<h2>
|
267
|
-
Instance Method Summary
|
268
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
269
|
-
</h2>
|
270
|
-
|
271
|
-
<ul class="summary">
|
272
|
-
|
273
|
-
<li class="public ">
|
274
|
-
<span class="summary_signature">
|
275
|
-
|
276
|
-
<a href="#disable-instance_method" title="#disable (instance method)">#<strong>disable</strong> ⇒ String </a>
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
</span>
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
<span class="summary_desc"><div class='inline'>
|
291
|
-
<p>Disable auto renewal for the associated domain.</p>
|
292
|
-
</div></span>
|
293
|
-
|
294
|
-
</li>
|
295
|
-
|
296
|
-
|
297
|
-
<li class="public ">
|
298
|
-
<span class="summary_signature">
|
299
|
-
|
300
|
-
<a href="#enable-instance_method" title="#enable (instance method)">#<strong>enable</strong>(duration: self.duration || 1, org_id: self.org_id) ⇒ String </a>
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
</span>
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
<span class="summary_desc"><div class='inline'>
|
315
|
-
<p>Disable auto renewal for the associated domain.</p>
|
316
|
-
</div></span>
|
317
|
-
|
318
|
-
</li>
|
319
|
-
|
320
|
-
|
321
|
-
</ul>
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">GandiV5::Data</a></span></h3>
|
334
|
-
<p class="inherited"><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">#from_gandi</a></span>, <span class='object_link'><a href="../Data.html#included-class_method" title="GandiV5::Data.included (method)">included</a></span>, <span class='object_link'><a href="../Data.html#initialize-instance_method" title="GandiV5::Data#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Data.html#to_gandi-instance_method" title="GandiV5::Data#to_gandi (method)">#to_gandi</a></span>, <span class='object_link'><a href="../Data.html#to_h-instance_method" title="GandiV5::Data#to_h (method)">#to_h</a></span>, <span class='object_link'><a href="../Data.html#values_at-instance_method" title="GandiV5::Data#values_at (method)">#values_at</a></span></p>
|
335
|
-
|
336
|
-
<div id="instance_attr_details" class="attr_details">
|
337
|
-
<h2>Instance Attribute Details</h2>
|
338
|
-
|
339
|
-
|
340
|
-
<span id=""></span>
|
341
|
-
<div class="method_details first">
|
342
|
-
<h3 class="signature first" id="dates-instance_method">
|
343
|
-
|
344
|
-
#<strong>dates</strong> ⇒ <tt>nil</tt>, <tt>Array<Time></tt> <span class="extras">(readonly)</span>
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
</h3><div class="docstring">
|
351
|
-
<div class="discussion">
|
352
|
-
|
353
|
-
|
354
|
-
</div>
|
355
|
-
</div>
|
356
|
-
<div class="tags">
|
357
|
-
|
358
|
-
<p class="tag_title">Returns:</p>
|
359
|
-
<ul class="return">
|
360
|
-
|
361
|
-
<li>
|
362
|
-
|
363
|
-
|
364
|
-
<span class='type'>(<tt>nil</tt>, <tt>Array<Time></tt>)</span>
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
</li>
|
369
|
-
|
370
|
-
</ul>
|
371
|
-
|
372
|
-
</div><table class="source_code">
|
373
|
-
<tr>
|
374
|
-
<td>
|
375
|
-
<pre class="lines">
|
376
|
-
|
377
|
-
|
378
|
-
14
|
379
|
-
15
|
380
|
-
16
|
381
|
-
17
|
382
|
-
18
|
383
|
-
19
|
384
|
-
20
|
385
|
-
21
|
386
|
-
22
|
387
|
-
23
|
388
|
-
24
|
389
|
-
25
|
390
|
-
26
|
391
|
-
27
|
392
|
-
28
|
393
|
-
29
|
394
|
-
30
|
395
|
-
31
|
396
|
-
32
|
397
|
-
33
|
398
|
-
34
|
399
|
-
35
|
400
|
-
36
|
401
|
-
37
|
402
|
-
38
|
403
|
-
39
|
404
|
-
40
|
405
|
-
41
|
406
|
-
42
|
407
|
-
43
|
408
|
-
44
|
409
|
-
45
|
410
|
-
46
|
411
|
-
47
|
412
|
-
48
|
413
|
-
49
|
414
|
-
50
|
415
|
-
51
|
416
|
-
52
|
417
|
-
53
|
418
|
-
54
|
419
|
-
55
|
420
|
-
56
|
421
|
-
57
|
422
|
-
58
|
423
|
-
59
|
424
|
-
60
|
425
|
-
61
|
426
|
-
62</pre>
|
427
|
-
</td>
|
428
|
-
<td>
|
429
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 14</span>
|
430
|
-
|
431
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::AutoRenew (class)">AutoRenew</a></span></span>
|
432
|
-
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
|
433
|
-
|
434
|
-
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domain</span>
|
435
|
-
|
436
|
-
<span class='id identifier rubyid_members'>members</span> <span class='symbol'>:duration</span><span class='comma'>,</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:org_id</span>
|
437
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:dates</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
|
438
|
-
|
439
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
440
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
441
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
442
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
|
443
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
444
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
445
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
|
446
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
447
|
-
<span class='kw'>end</span>
|
448
|
-
|
449
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
450
|
-
</span> <span class='comment'># @param duration [Integer, #to_s] how long to renew for.
|
451
|
-
</span> <span class='comment'># @param org_id [String, #to_s] UUID of the organisation that should pay.
|
452
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
453
|
-
</span> <span class='comment'># @raise [ArgumentError] if duration is invalid (not 1 to 9 (inclusive)).
|
454
|
-
</span> <span class='comment'># @raise [ArgumentError] if org_id is not passed and not set for this domain.
|
455
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
456
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>duration:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>||</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>org_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
457
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be less than 1</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'><</span> <span class='int'>1</span>
|
458
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be more than 9</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'>></span> <span class='int'>9</span>
|
459
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>org_id is required</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_org_id'>org_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
460
|
-
|
461
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
462
|
-
<span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
463
|
-
<span class='label'>duration:</span> <span class='id identifier rubyid_duration'>duration</span><span class='comma'>,</span>
|
464
|
-
<span class='label'>org_id:</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
465
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
466
|
-
|
467
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
468
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
|
469
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>=</span> <span class='id identifier rubyid_duration'>duration</span>
|
470
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span> <span class='op'>=</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
471
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
472
|
-
<span class='kw'>end</span>
|
473
|
-
|
474
|
-
<span class='id identifier rubyid_private'>private</span>
|
475
|
-
|
476
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
477
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../GandiV5.html#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>domain/domains/</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span> <span class='id identifier rubyid_domain'>domain</span><span class='period'>.</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_content'>/autorenew</span><span class='tstring_end'>"</span></span>
|
478
|
-
<span class='kw'>end</span>
|
479
|
-
<span class='kw'>end</span></pre>
|
480
|
-
</td>
|
481
|
-
</tr>
|
482
|
-
</table>
|
483
|
-
</div>
|
484
|
-
|
485
|
-
|
486
|
-
<span id="domain=-instance_method"></span>
|
487
|
-
<div class="method_details ">
|
488
|
-
<h3 class="signature " id="domain-instance_method">
|
489
|
-
|
490
|
-
#<strong>domain</strong> ⇒ <tt>Object</tt>
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
</h3><div class="docstring">
|
497
|
-
<div class="discussion">
|
498
|
-
|
499
|
-
<p>Returns the value of attribute domain</p>
|
500
|
-
|
501
|
-
|
502
|
-
</div>
|
503
|
-
</div>
|
504
|
-
<div class="tags">
|
505
|
-
|
506
|
-
|
507
|
-
</div><table class="source_code">
|
508
|
-
<tr>
|
509
|
-
<td>
|
510
|
-
<pre class="lines">
|
511
|
-
|
512
|
-
|
513
|
-
17
|
514
|
-
18
|
515
|
-
19</pre>
|
516
|
-
</td>
|
517
|
-
<td>
|
518
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 17</span>
|
519
|
-
|
520
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_domain'>domain</span>
|
521
|
-
<span class='ivar'>@domain</span>
|
522
|
-
<span class='kw'>end</span></pre>
|
523
|
-
</td>
|
524
|
-
</tr>
|
525
|
-
</table>
|
526
|
-
</div>
|
527
|
-
|
528
|
-
|
529
|
-
<span id=""></span>
|
530
|
-
<div class="method_details ">
|
531
|
-
<h3 class="signature " id="duration-instance_method">
|
532
|
-
|
533
|
-
#<strong>duration</strong> ⇒ <tt>nil</tt>, <tt>Integer</tt> <span class="extras">(readonly)</span>
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
</h3><div class="docstring">
|
540
|
-
<div class="discussion">
|
541
|
-
|
542
|
-
|
543
|
-
</div>
|
544
|
-
</div>
|
545
|
-
<div class="tags">
|
546
|
-
|
547
|
-
<p class="tag_title">Returns:</p>
|
548
|
-
<ul class="return">
|
549
|
-
|
550
|
-
<li>
|
551
|
-
|
552
|
-
|
553
|
-
<span class='type'>(<tt>nil</tt>, <tt>Integer</tt>)</span>
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
</li>
|
558
|
-
|
559
|
-
</ul>
|
560
|
-
|
561
|
-
</div><table class="source_code">
|
562
|
-
<tr>
|
563
|
-
<td>
|
564
|
-
<pre class="lines">
|
565
|
-
|
566
|
-
|
567
|
-
14
|
568
|
-
15
|
569
|
-
16
|
570
|
-
17
|
571
|
-
18
|
572
|
-
19
|
573
|
-
20
|
574
|
-
21
|
575
|
-
22
|
576
|
-
23
|
577
|
-
24
|
578
|
-
25
|
579
|
-
26
|
580
|
-
27
|
581
|
-
28
|
582
|
-
29
|
583
|
-
30
|
584
|
-
31
|
585
|
-
32
|
586
|
-
33
|
587
|
-
34
|
588
|
-
35
|
589
|
-
36
|
590
|
-
37
|
591
|
-
38
|
592
|
-
39
|
593
|
-
40
|
594
|
-
41
|
595
|
-
42
|
596
|
-
43
|
597
|
-
44
|
598
|
-
45
|
599
|
-
46
|
600
|
-
47
|
601
|
-
48
|
602
|
-
49
|
603
|
-
50
|
604
|
-
51
|
605
|
-
52
|
606
|
-
53
|
607
|
-
54
|
608
|
-
55
|
609
|
-
56
|
610
|
-
57
|
611
|
-
58
|
612
|
-
59
|
613
|
-
60
|
614
|
-
61
|
615
|
-
62</pre>
|
616
|
-
</td>
|
617
|
-
<td>
|
618
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 14</span>
|
619
|
-
|
620
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::AutoRenew (class)">AutoRenew</a></span></span>
|
621
|
-
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
|
622
|
-
|
623
|
-
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domain</span>
|
624
|
-
|
625
|
-
<span class='id identifier rubyid_members'>members</span> <span class='symbol'>:duration</span><span class='comma'>,</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:org_id</span>
|
626
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:dates</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
|
627
|
-
|
628
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
629
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
630
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
631
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
|
632
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
633
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
634
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
|
635
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
636
|
-
<span class='kw'>end</span>
|
637
|
-
|
638
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
639
|
-
</span> <span class='comment'># @param duration [Integer, #to_s] how long to renew for.
|
640
|
-
</span> <span class='comment'># @param org_id [String, #to_s] UUID of the organisation that should pay.
|
641
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
642
|
-
</span> <span class='comment'># @raise [ArgumentError] if duration is invalid (not 1 to 9 (inclusive)).
|
643
|
-
</span> <span class='comment'># @raise [ArgumentError] if org_id is not passed and not set for this domain.
|
644
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
645
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>duration:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>||</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>org_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
646
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be less than 1</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'><</span> <span class='int'>1</span>
|
647
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be more than 9</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'>></span> <span class='int'>9</span>
|
648
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>org_id is required</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_org_id'>org_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
649
|
-
|
650
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
651
|
-
<span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
652
|
-
<span class='label'>duration:</span> <span class='id identifier rubyid_duration'>duration</span><span class='comma'>,</span>
|
653
|
-
<span class='label'>org_id:</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
654
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
655
|
-
|
656
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
657
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
|
658
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>=</span> <span class='id identifier rubyid_duration'>duration</span>
|
659
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span> <span class='op'>=</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
660
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
661
|
-
<span class='kw'>end</span>
|
662
|
-
|
663
|
-
<span class='id identifier rubyid_private'>private</span>
|
664
|
-
|
665
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
666
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../GandiV5.html#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>domain/domains/</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span> <span class='id identifier rubyid_domain'>domain</span><span class='period'>.</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_content'>/autorenew</span><span class='tstring_end'>"</span></span>
|
667
|
-
<span class='kw'>end</span>
|
668
|
-
<span class='kw'>end</span></pre>
|
669
|
-
</td>
|
670
|
-
</tr>
|
671
|
-
</table>
|
672
|
-
</div>
|
673
|
-
|
674
|
-
|
675
|
-
<span id=""></span>
|
676
|
-
<div class="method_details ">
|
677
|
-
<h3 class="signature " id="enabled-instance_method">
|
678
|
-
|
679
|
-
#<strong>enabled</strong> ⇒ <tt>nil</tt>, <tt>Boolean</tt> <span class="extras">(readonly)</span>
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
</h3><div class="docstring">
|
686
|
-
<div class="discussion">
|
687
|
-
|
688
|
-
|
689
|
-
</div>
|
690
|
-
</div>
|
691
|
-
<div class="tags">
|
692
|
-
|
693
|
-
<p class="tag_title">Returns:</p>
|
694
|
-
<ul class="return">
|
695
|
-
|
696
|
-
<li>
|
697
|
-
|
698
|
-
|
699
|
-
<span class='type'>(<tt>nil</tt>, <tt>Boolean</tt>)</span>
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
</li>
|
704
|
-
|
705
|
-
</ul>
|
706
|
-
|
707
|
-
</div><table class="source_code">
|
708
|
-
<tr>
|
709
|
-
<td>
|
710
|
-
<pre class="lines">
|
711
|
-
|
712
|
-
|
713
|
-
14
|
714
|
-
15
|
715
|
-
16
|
716
|
-
17
|
717
|
-
18
|
718
|
-
19
|
719
|
-
20
|
720
|
-
21
|
721
|
-
22
|
722
|
-
23
|
723
|
-
24
|
724
|
-
25
|
725
|
-
26
|
726
|
-
27
|
727
|
-
28
|
728
|
-
29
|
729
|
-
30
|
730
|
-
31
|
731
|
-
32
|
732
|
-
33
|
733
|
-
34
|
734
|
-
35
|
735
|
-
36
|
736
|
-
37
|
737
|
-
38
|
738
|
-
39
|
739
|
-
40
|
740
|
-
41
|
741
|
-
42
|
742
|
-
43
|
743
|
-
44
|
744
|
-
45
|
745
|
-
46
|
746
|
-
47
|
747
|
-
48
|
748
|
-
49
|
749
|
-
50
|
750
|
-
51
|
751
|
-
52
|
752
|
-
53
|
753
|
-
54
|
754
|
-
55
|
755
|
-
56
|
756
|
-
57
|
757
|
-
58
|
758
|
-
59
|
759
|
-
60
|
760
|
-
61
|
761
|
-
62</pre>
|
762
|
-
</td>
|
763
|
-
<td>
|
764
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 14</span>
|
765
|
-
|
766
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::AutoRenew (class)">AutoRenew</a></span></span>
|
767
|
-
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
|
768
|
-
|
769
|
-
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domain</span>
|
770
|
-
|
771
|
-
<span class='id identifier rubyid_members'>members</span> <span class='symbol'>:duration</span><span class='comma'>,</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:org_id</span>
|
772
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:dates</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
|
773
|
-
|
774
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
775
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
776
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
777
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
|
778
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
779
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
780
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
|
781
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
782
|
-
<span class='kw'>end</span>
|
783
|
-
|
784
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
785
|
-
</span> <span class='comment'># @param duration [Integer, #to_s] how long to renew for.
|
786
|
-
</span> <span class='comment'># @param org_id [String, #to_s] UUID of the organisation that should pay.
|
787
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
788
|
-
</span> <span class='comment'># @raise [ArgumentError] if duration is invalid (not 1 to 9 (inclusive)).
|
789
|
-
</span> <span class='comment'># @raise [ArgumentError] if org_id is not passed and not set for this domain.
|
790
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
791
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>duration:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>||</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>org_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
792
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be less than 1</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'><</span> <span class='int'>1</span>
|
793
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be more than 9</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'>></span> <span class='int'>9</span>
|
794
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>org_id is required</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_org_id'>org_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
795
|
-
|
796
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
797
|
-
<span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
798
|
-
<span class='label'>duration:</span> <span class='id identifier rubyid_duration'>duration</span><span class='comma'>,</span>
|
799
|
-
<span class='label'>org_id:</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
800
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
801
|
-
|
802
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
803
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
|
804
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>=</span> <span class='id identifier rubyid_duration'>duration</span>
|
805
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span> <span class='op'>=</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
806
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
807
|
-
<span class='kw'>end</span>
|
808
|
-
|
809
|
-
<span class='id identifier rubyid_private'>private</span>
|
810
|
-
|
811
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
812
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../GandiV5.html#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>domain/domains/</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span> <span class='id identifier rubyid_domain'>domain</span><span class='period'>.</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_content'>/autorenew</span><span class='tstring_end'>"</span></span>
|
813
|
-
<span class='kw'>end</span>
|
814
|
-
<span class='kw'>end</span></pre>
|
815
|
-
</td>
|
816
|
-
</tr>
|
817
|
-
</table>
|
818
|
-
</div>
|
819
|
-
|
820
|
-
|
821
|
-
<span id=""></span>
|
822
|
-
<div class="method_details ">
|
823
|
-
<h3 class="signature " id="org_id-instance_method">
|
824
|
-
|
825
|
-
#<strong>org_id</strong> ⇒ <tt>nil</tt>, <tt>String</tt> <span class="extras">(readonly)</span>
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
</h3><div class="docstring">
|
832
|
-
<div class="discussion">
|
833
|
-
|
834
|
-
|
835
|
-
</div>
|
836
|
-
</div>
|
837
|
-
<div class="tags">
|
838
|
-
|
839
|
-
<p class="tag_title">Returns:</p>
|
840
|
-
<ul class="return">
|
841
|
-
|
842
|
-
<li>
|
843
|
-
|
844
|
-
|
845
|
-
<span class='type'>(<tt>nil</tt>, <tt>String</tt>)</span>
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
</li>
|
850
|
-
|
851
|
-
</ul>
|
852
|
-
|
853
|
-
</div><table class="source_code">
|
854
|
-
<tr>
|
855
|
-
<td>
|
856
|
-
<pre class="lines">
|
857
|
-
|
858
|
-
|
859
|
-
14
|
860
|
-
15
|
861
|
-
16
|
862
|
-
17
|
863
|
-
18
|
864
|
-
19
|
865
|
-
20
|
866
|
-
21
|
867
|
-
22
|
868
|
-
23
|
869
|
-
24
|
870
|
-
25
|
871
|
-
26
|
872
|
-
27
|
873
|
-
28
|
874
|
-
29
|
875
|
-
30
|
876
|
-
31
|
877
|
-
32
|
878
|
-
33
|
879
|
-
34
|
880
|
-
35
|
881
|
-
36
|
882
|
-
37
|
883
|
-
38
|
884
|
-
39
|
885
|
-
40
|
886
|
-
41
|
887
|
-
42
|
888
|
-
43
|
889
|
-
44
|
890
|
-
45
|
891
|
-
46
|
892
|
-
47
|
893
|
-
48
|
894
|
-
49
|
895
|
-
50
|
896
|
-
51
|
897
|
-
52
|
898
|
-
53
|
899
|
-
54
|
900
|
-
55
|
901
|
-
56
|
902
|
-
57
|
903
|
-
58
|
904
|
-
59
|
905
|
-
60
|
906
|
-
61
|
907
|
-
62</pre>
|
908
|
-
</td>
|
909
|
-
<td>
|
910
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 14</span>
|
911
|
-
|
912
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::AutoRenew (class)">AutoRenew</a></span></span>
|
913
|
-
<span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
|
914
|
-
|
915
|
-
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domain</span>
|
916
|
-
|
917
|
-
<span class='id identifier rubyid_members'>members</span> <span class='symbol'>:duration</span><span class='comma'>,</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:org_id</span>
|
918
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:dates</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
|
919
|
-
|
920
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
921
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
922
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
923
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
|
924
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
925
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
926
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
|
927
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
928
|
-
<span class='kw'>end</span>
|
929
|
-
|
930
|
-
<span class='comment'># Disable auto renewal for the associated domain.
|
931
|
-
</span> <span class='comment'># @param duration [Integer, #to_s] how long to renew for.
|
932
|
-
</span> <span class='comment'># @param org_id [String, #to_s] UUID of the organisation that should pay.
|
933
|
-
</span> <span class='comment'># @return [String] The confirmation message from Gandi.
|
934
|
-
</span> <span class='comment'># @raise [ArgumentError] if duration is invalid (not 1 to 9 (inclusive)).
|
935
|
-
</span> <span class='comment'># @raise [ArgumentError] if org_id is not passed and not set for this domain.
|
936
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
937
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>duration:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>||</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>org_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
938
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be less than 1</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'><</span> <span class='int'>1</span>
|
939
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be more than 9</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'>></span> <span class='int'>9</span>
|
940
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>org_id is required</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_org_id'>org_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
941
|
-
|
942
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
943
|
-
<span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
944
|
-
<span class='label'>duration:</span> <span class='id identifier rubyid_duration'>duration</span><span class='comma'>,</span>
|
945
|
-
<span class='label'>org_id:</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
946
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
947
|
-
|
948
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
949
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
|
950
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>=</span> <span class='id identifier rubyid_duration'>duration</span>
|
951
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span> <span class='op'>=</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
952
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
953
|
-
<span class='kw'>end</span>
|
954
|
-
|
955
|
-
<span class='id identifier rubyid_private'>private</span>
|
956
|
-
|
957
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
958
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../GandiV5.html#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>domain/domains/</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span> <span class='id identifier rubyid_domain'>domain</span><span class='period'>.</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_content'>/autorenew</span><span class='tstring_end'>"</span></span>
|
959
|
-
<span class='kw'>end</span>
|
960
|
-
<span class='kw'>end</span></pre>
|
961
|
-
</td>
|
962
|
-
</tr>
|
963
|
-
</table>
|
964
|
-
</div>
|
965
|
-
|
966
|
-
</div>
|
967
|
-
|
968
|
-
|
969
|
-
<div id="instance_method_details" class="method_details_list">
|
970
|
-
<h2>Instance Method Details</h2>
|
971
|
-
|
972
|
-
|
973
|
-
<div class="method_details first">
|
974
|
-
<h3 class="signature first" id="disable-instance_method">
|
975
|
-
|
976
|
-
#<strong>disable</strong> ⇒ <tt>String</tt>
|
977
|
-
|
978
|
-
|
979
|
-
|
980
|
-
|
981
|
-
|
982
|
-
</h3><div class="docstring">
|
983
|
-
<div class="discussion">
|
984
|
-
|
985
|
-
<p>Disable auto renewal for the associated domain.</p>
|
986
|
-
|
987
|
-
|
988
|
-
</div>
|
989
|
-
</div>
|
990
|
-
<div class="tags">
|
991
|
-
|
992
|
-
<p class="tag_title">Returns:</p>
|
993
|
-
<ul class="return">
|
994
|
-
|
995
|
-
<li>
|
996
|
-
|
997
|
-
|
998
|
-
<span class='type'>(<tt>String</tt>)</span>
|
999
|
-
|
1000
|
-
|
1001
|
-
|
1002
|
-
—
|
1003
|
-
<div class='inline'>
|
1004
|
-
<p>The confirmation message from Gandi.</p>
|
1005
|
-
</div>
|
1006
|
-
|
1007
|
-
</li>
|
1008
|
-
|
1009
|
-
</ul>
|
1010
|
-
<p class="tag_title">Raises:</p>
|
1011
|
-
<ul class="raise">
|
1012
|
-
|
1013
|
-
<li>
|
1014
|
-
|
1015
|
-
|
1016
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>)</span>
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
—
|
1021
|
-
<div class='inline'>
|
1022
|
-
<p>if Gandi returns an error.</p>
|
1023
|
-
</div>
|
1024
|
-
|
1025
|
-
</li>
|
1026
|
-
|
1027
|
-
</ul>
|
1028
|
-
|
1029
|
-
</div><table class="source_code">
|
1030
|
-
<tr>
|
1031
|
-
<td>
|
1032
|
-
<pre class="lines">
|
1033
|
-
|
1034
|
-
|
1035
|
-
25
|
1036
|
-
26
|
1037
|
-
27
|
1038
|
-
28
|
1039
|
-
29
|
1040
|
-
30</pre>
|
1041
|
-
</td>
|
1042
|
-
<td>
|
1043
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 25</span>
|
1044
|
-
|
1045
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
|
1046
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
1047
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
1048
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
|
1049
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1050
|
-
<span class='kw'>end</span></pre>
|
1051
|
-
</td>
|
1052
|
-
</tr>
|
1053
|
-
</table>
|
1054
|
-
</div>
|
1055
|
-
|
1056
|
-
<div class="method_details ">
|
1057
|
-
<h3 class="signature " id="enable-instance_method">
|
1058
|
-
|
1059
|
-
#<strong>enable</strong>(duration: self.duration || 1, org_id: self.org_id) ⇒ <tt>String</tt>
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1064
|
-
|
1065
|
-
</h3><div class="docstring">
|
1066
|
-
<div class="discussion">
|
1067
|
-
|
1068
|
-
<p>Disable auto renewal for the associated domain.</p>
|
1069
|
-
|
1070
|
-
|
1071
|
-
</div>
|
1072
|
-
</div>
|
1073
|
-
<div class="tags">
|
1074
|
-
<p class="tag_title">Parameters:</p>
|
1075
|
-
<ul class="param">
|
1076
|
-
|
1077
|
-
<li>
|
1078
|
-
|
1079
|
-
<span class='name'>duration</span>
|
1080
|
-
|
1081
|
-
|
1082
|
-
<span class='type'>(<tt>Integer</tt>, <tt>#<span class='object_link'><a href="../Domain.html#to_s-instance_method" title="GandiV5::Domain#to_s (method)">to_s</a></span></tt>)</span>
|
1083
|
-
|
1084
|
-
|
1085
|
-
|
1086
|
-
—
|
1087
|
-
<div class='inline'>
|
1088
|
-
<p>how long to renew for.</p>
|
1089
|
-
</div>
|
1090
|
-
|
1091
|
-
</li>
|
1092
|
-
|
1093
|
-
<li>
|
1094
|
-
|
1095
|
-
<span class='name'>org_id</span>
|
1096
|
-
|
1097
|
-
|
1098
|
-
<span class='type'>(<tt>String</tt>, <tt>#<span class='object_link'><a href="../Domain.html#to_s-instance_method" title="GandiV5::Domain#to_s (method)">to_s</a></span></tt>)</span>
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
—
|
1103
|
-
<div class='inline'>
|
1104
|
-
<p>UUID of the organisation that should pay.</p>
|
1105
|
-
</div>
|
1106
|
-
|
1107
|
-
</li>
|
1108
|
-
|
1109
|
-
</ul>
|
1110
|
-
|
1111
|
-
<p class="tag_title">Returns:</p>
|
1112
|
-
<ul class="return">
|
1113
|
-
|
1114
|
-
<li>
|
1115
|
-
|
1116
|
-
|
1117
|
-
<span class='type'>(<tt>String</tt>)</span>
|
1118
|
-
|
1119
|
-
|
1120
|
-
|
1121
|
-
—
|
1122
|
-
<div class='inline'>
|
1123
|
-
<p>The confirmation message from Gandi.</p>
|
1124
|
-
</div>
|
1125
|
-
|
1126
|
-
</li>
|
1127
|
-
|
1128
|
-
</ul>
|
1129
|
-
<p class="tag_title">Raises:</p>
|
1130
|
-
<ul class="raise">
|
1131
|
-
|
1132
|
-
<li>
|
1133
|
-
|
1134
|
-
|
1135
|
-
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
1136
|
-
|
1137
|
-
|
1138
|
-
|
1139
|
-
—
|
1140
|
-
<div class='inline'>
|
1141
|
-
<p>if duration is invalid (not 1 to 9 (inclusive)).</p>
|
1142
|
-
</div>
|
1143
|
-
|
1144
|
-
</li>
|
1145
|
-
|
1146
|
-
<li>
|
1147
|
-
|
1148
|
-
|
1149
|
-
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
1150
|
-
|
1151
|
-
|
1152
|
-
|
1153
|
-
—
|
1154
|
-
<div class='inline'>
|
1155
|
-
<p>if org_id is not passed and not set for this domain.</p>
|
1156
|
-
</div>
|
1157
|
-
|
1158
|
-
</li>
|
1159
|
-
|
1160
|
-
<li>
|
1161
|
-
|
1162
|
-
|
1163
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>)</span>
|
1164
|
-
|
1165
|
-
|
1166
|
-
|
1167
|
-
—
|
1168
|
-
<div class='inline'>
|
1169
|
-
<p>if Gandi returns an error.</p>
|
1170
|
-
</div>
|
1171
|
-
|
1172
|
-
</li>
|
1173
|
-
|
1174
|
-
</ul>
|
1175
|
-
|
1176
|
-
</div><table class="source_code">
|
1177
|
-
<tr>
|
1178
|
-
<td>
|
1179
|
-
<pre class="lines">
|
1180
|
-
|
1181
|
-
|
1182
|
-
39
|
1183
|
-
40
|
1184
|
-
41
|
1185
|
-
42
|
1186
|
-
43
|
1187
|
-
44
|
1188
|
-
45
|
1189
|
-
46
|
1190
|
-
47
|
1191
|
-
48
|
1192
|
-
49
|
1193
|
-
50
|
1194
|
-
51
|
1195
|
-
52
|
1196
|
-
53
|
1197
|
-
54
|
1198
|
-
55</pre>
|
1199
|
-
</td>
|
1200
|
-
<td>
|
1201
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/auto_renew.rb', line 39</span>
|
1202
|
-
|
1203
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>duration:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>||</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>org_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
1204
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be less than 1</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'><</span> <span class='int'>1</span>
|
1205
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>duration can not be more than 9</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_duration'>duration</span> <span class='op'>></span> <span class='int'>9</span>
|
1206
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>org_id is required</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_org_id'>org_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
1207
|
-
|
1208
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1209
|
-
<span class='label'>enabled:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1210
|
-
<span class='label'>duration:</span> <span class='id identifier rubyid_duration'>duration</span><span class='comma'>,</span>
|
1211
|
-
<span class='label'>org_id:</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
1212
|
-
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
1213
|
-
|
1214
|
-
<span class='id identifier rubyid__response'>_response</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_patch'><span class='object_link'><a href="../../GandiV5.html#patch-class_method" title="GandiV5.patch (method)">patch</a></span></span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
|
1215
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
|
1216
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_duration'>duration</span> <span class='op'>=</span> <span class='id identifier rubyid_duration'>duration</span>
|
1217
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_org_id'>org_id</span> <span class='op'>=</span> <span class='id identifier rubyid_org_id'>org_id</span>
|
1218
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>message</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
1219
|
-
<span class='kw'>end</span></pre>
|
1220
|
-
</td>
|
1221
|
-
</tr>
|
1222
|
-
</table>
|
1223
|
-
</div>
|
1224
|
-
|
1225
|
-
</div>
|
1226
|
-
|
1227
|
-
</div>
|
1228
|
-
|
1229
|
-
<div id="footer">
|
1230
|
-
Generated on Mon Jul 22 16:44:33 2019 by
|
1231
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1232
|
-
0.9.19 (ruby-2.6.3).
|
1233
|
-
</div>
|
1234
|
-
|
1235
|
-
</div>
|
1236
|
-
</body>
|
1237
|
-
</html>
|