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,514 +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::Email::Offer
|
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::Email::Offer";
|
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 (O)</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="../Email.html" title="GandiV5::Email (class)">Email</a></span></span>
|
41
|
-
»
|
42
|
-
<span class="title">Offer</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::Email::Offer
|
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::Email::Offer</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)">Data</a></span></dd>
|
93
|
-
</dl>
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
<dl>
|
101
|
-
<dt>Defined in:</dt>
|
102
|
-
<dd>lib/gandi_v5/email/offer.rb</dd>
|
103
|
-
</dl>
|
104
|
-
|
105
|
-
</div>
|
106
|
-
|
107
|
-
<h2>Overview</h2><div class="docstring">
|
108
|
-
<div class="discussion">
|
109
|
-
|
110
|
-
<p>The current status of your mailbox offer.</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="#status-instance_method" title="#status (instance method)">#<strong>status</strong> ⇒ :active, :inactive </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="#version-instance_method" title="#version (instance method)">#<strong>version</strong> ⇒ 1, 2 </a>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
</span>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
<span class="note title readonly">readonly</span>
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
175
|
-
|
176
|
-
</li>
|
177
|
-
|
178
|
-
|
179
|
-
</ul>
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
<h2>
|
186
|
-
Class Method Summary
|
187
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
188
|
-
</h2>
|
189
|
-
|
190
|
-
<ul class="summary">
|
191
|
-
|
192
|
-
<li class="public ">
|
193
|
-
<span class="summary_signature">
|
194
|
-
|
195
|
-
<a href="#fetch-class_method" title="fetch (class method)">.<strong>fetch</strong>(fqdn) ⇒ GandiV5::Email::Offer </a>
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
</span>
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
<span class="summary_desc"><div class='inline'>
|
210
|
-
<p>Get the current status of your mailbox offer.</p>
|
211
|
-
</div></span>
|
212
|
-
|
213
|
-
</li>
|
214
|
-
|
215
|
-
|
216
|
-
</ul>
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">Data</a></span></h3>
|
229
|
-
<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>
|
230
|
-
|
231
|
-
<div id="instance_attr_details" class="attr_details">
|
232
|
-
<h2>Instance Attribute Details</h2>
|
233
|
-
|
234
|
-
|
235
|
-
<span id=""></span>
|
236
|
-
<div class="method_details first">
|
237
|
-
<h3 class="signature first" id="status-instance_method">
|
238
|
-
|
239
|
-
#<strong>status</strong> ⇒ <tt>:active</tt>, <tt>:inactive</tt> <span class="extras">(readonly)</span>
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
</h3><div class="docstring">
|
246
|
-
<div class="discussion">
|
247
|
-
|
248
|
-
|
249
|
-
</div>
|
250
|
-
</div>
|
251
|
-
<div class="tags">
|
252
|
-
|
253
|
-
<p class="tag_title">Returns:</p>
|
254
|
-
<ul class="return">
|
255
|
-
|
256
|
-
<li>
|
257
|
-
|
258
|
-
|
259
|
-
<span class='type'>(<tt>:active</tt>, <tt>:inactive</tt>)</span>
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
</li>
|
264
|
-
|
265
|
-
</ul>
|
266
|
-
|
267
|
-
</div><table class="source_code">
|
268
|
-
<tr>
|
269
|
-
<td>
|
270
|
-
<pre class="lines">
|
271
|
-
|
272
|
-
|
273
|
-
10
|
274
|
-
11
|
275
|
-
12
|
276
|
-
13
|
277
|
-
14
|
278
|
-
15
|
279
|
-
16
|
280
|
-
17
|
281
|
-
18
|
282
|
-
19
|
283
|
-
20
|
284
|
-
21
|
285
|
-
22
|
286
|
-
23
|
287
|
-
24
|
288
|
-
25</pre>
|
289
|
-
</td>
|
290
|
-
<td>
|
291
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/email/offer.rb', line 10</span>
|
292
|
-
|
293
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Offer (class)">Offer</a></span></span>
|
294
|
-
<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>
|
295
|
-
|
296
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:version</span>
|
297
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:status</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/Symbol.html" title="GandiV5::Data::Converter::Symbol (class)">Symbol</a></span></span>
|
298
|
-
|
299
|
-
<span class='comment'># Get the current status of your mailbox offer.
|
300
|
-
</span> <span class='comment'># @see https://api.gandi.net/docs/email#get-v5-email-offers-domain
|
301
|
-
</span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to get the offer for.
|
302
|
-
</span> <span class='comment'># @return [GandiV5::Email::Offer]
|
303
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
304
|
-
</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='rparen'>)</span>
|
305
|
-
<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_get'><span class='object_link'><a href="../../GandiV5.html#get-class_method" title="GandiV5.get (method)">get</a></span></span> <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'>email/offers/</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_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
306
|
-
<span class='id identifier rubyid_from_gandi'>from_gandi</span> <span class='id identifier rubyid_data'>data</span>
|
307
|
-
<span class='kw'>end</span>
|
308
|
-
<span class='kw'>end</span></pre>
|
309
|
-
</td>
|
310
|
-
</tr>
|
311
|
-
</table>
|
312
|
-
</div>
|
313
|
-
|
314
|
-
|
315
|
-
<span id=""></span>
|
316
|
-
<div class="method_details ">
|
317
|
-
<h3 class="signature " id="version-instance_method">
|
318
|
-
|
319
|
-
#<strong>version</strong> ⇒ <tt>1</tt>, <tt>2</tt> <span class="extras">(readonly)</span>
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
</h3><div class="docstring">
|
326
|
-
<div class="discussion">
|
327
|
-
|
328
|
-
|
329
|
-
</div>
|
330
|
-
</div>
|
331
|
-
<div class="tags">
|
332
|
-
|
333
|
-
<p class="tag_title">Returns:</p>
|
334
|
-
<ul class="return">
|
335
|
-
|
336
|
-
<li>
|
337
|
-
|
338
|
-
|
339
|
-
<span class='type'>(<tt>1</tt>, <tt>2</tt>)</span>
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
</li>
|
344
|
-
|
345
|
-
</ul>
|
346
|
-
|
347
|
-
</div><table class="source_code">
|
348
|
-
<tr>
|
349
|
-
<td>
|
350
|
-
<pre class="lines">
|
351
|
-
|
352
|
-
|
353
|
-
10
|
354
|
-
11
|
355
|
-
12
|
356
|
-
13
|
357
|
-
14
|
358
|
-
15
|
359
|
-
16
|
360
|
-
17
|
361
|
-
18
|
362
|
-
19
|
363
|
-
20
|
364
|
-
21
|
365
|
-
22
|
366
|
-
23
|
367
|
-
24
|
368
|
-
25</pre>
|
369
|
-
</td>
|
370
|
-
<td>
|
371
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/email/offer.rb', line 10</span>
|
372
|
-
|
373
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Offer (class)">Offer</a></span></span>
|
374
|
-
<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>
|
375
|
-
|
376
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:version</span>
|
377
|
-
<span class='id identifier rubyid_member'>member</span> <span class='symbol'>:status</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/Symbol.html" title="GandiV5::Data::Converter::Symbol (class)">Symbol</a></span></span>
|
378
|
-
|
379
|
-
<span class='comment'># Get the current status of your mailbox offer.
|
380
|
-
</span> <span class='comment'># @see https://api.gandi.net/docs/email#get-v5-email-offers-domain
|
381
|
-
</span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to get the offer for.
|
382
|
-
</span> <span class='comment'># @return [GandiV5::Email::Offer]
|
383
|
-
</span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
|
384
|
-
</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='rparen'>)</span>
|
385
|
-
<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_get'><span class='object_link'><a href="../../GandiV5.html#get-class_method" title="GandiV5.get (method)">get</a></span></span> <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'>email/offers/</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_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
386
|
-
<span class='id identifier rubyid_from_gandi'>from_gandi</span> <span class='id identifier rubyid_data'>data</span>
|
387
|
-
<span class='kw'>end</span>
|
388
|
-
<span class='kw'>end</span></pre>
|
389
|
-
</td>
|
390
|
-
</tr>
|
391
|
-
</table>
|
392
|
-
</div>
|
393
|
-
|
394
|
-
</div>
|
395
|
-
|
396
|
-
|
397
|
-
<div id="class_method_details" class="method_details_list">
|
398
|
-
<h2>Class Method Details</h2>
|
399
|
-
|
400
|
-
|
401
|
-
<div class="method_details first">
|
402
|
-
<h3 class="signature first" id="fetch-class_method">
|
403
|
-
|
404
|
-
.<strong>fetch</strong>(fqdn) ⇒ <tt><span class='object_link'><a href="" title="GandiV5::Email::Offer (class)">GandiV5::Email::Offer</a></span></tt>
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
</h3><div class="docstring">
|
411
|
-
<div class="discussion">
|
412
|
-
|
413
|
-
<p>Get the current status of your mailbox offer.</p>
|
414
|
-
|
415
|
-
|
416
|
-
</div>
|
417
|
-
</div>
|
418
|
-
<div class="tags">
|
419
|
-
<p class="tag_title">Parameters:</p>
|
420
|
-
<ul class="param">
|
421
|
-
|
422
|
-
<li>
|
423
|
-
|
424
|
-
<span class='name'>fqdn</span>
|
425
|
-
|
426
|
-
|
427
|
-
<span class='type'>(<tt>String</tt>, <tt>#to_s</tt>)</span>
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
—
|
432
|
-
<div class='inline'>
|
433
|
-
<p>the fully qualified domain name to get the offer for.</p>
|
434
|
-
</div>
|
435
|
-
|
436
|
-
</li>
|
437
|
-
|
438
|
-
</ul>
|
439
|
-
|
440
|
-
<p class="tag_title">Returns:</p>
|
441
|
-
<ul class="return">
|
442
|
-
|
443
|
-
<li>
|
444
|
-
|
445
|
-
|
446
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="GandiV5::Email::Offer (class)">GandiV5::Email::Offer</a></span></tt>)</span>
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
</li>
|
451
|
-
|
452
|
-
</ul>
|
453
|
-
<p class="tag_title">Raises:</p>
|
454
|
-
<ul class="raise">
|
455
|
-
|
456
|
-
<li>
|
457
|
-
|
458
|
-
|
459
|
-
<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>
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
—
|
464
|
-
<div class='inline'>
|
465
|
-
<p>if Gandi returns an error.</p>
|
466
|
-
</div>
|
467
|
-
|
468
|
-
</li>
|
469
|
-
|
470
|
-
</ul>
|
471
|
-
|
472
|
-
<p class="tag_title">See Also:</p>
|
473
|
-
<ul class="see">
|
474
|
-
|
475
|
-
<li><a href="https://api.gandi.net/docs/email#get-v5-email-offers-domain" target="_parent" title="https://api.gandi.net/docs/email#get-v5-email-offers-domain">https://api.gandi.net/docs/email#get-v5-email-offers-domain</a></li>
|
476
|
-
|
477
|
-
</ul>
|
478
|
-
|
479
|
-
</div><table class="source_code">
|
480
|
-
<tr>
|
481
|
-
<td>
|
482
|
-
<pre class="lines">
|
483
|
-
|
484
|
-
|
485
|
-
21
|
486
|
-
22
|
487
|
-
23
|
488
|
-
24</pre>
|
489
|
-
</td>
|
490
|
-
<td>
|
491
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5/email/offer.rb', line 21</span>
|
492
|
-
|
493
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn'>fqdn</span><span class='rparen'>)</span>
|
494
|
-
<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_get'><span class='object_link'><a href="../../GandiV5.html#get-class_method" title="GandiV5.get (method)">get</a></span></span> <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'>email/offers/</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_fqdn'>fqdn</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
495
|
-
<span class='id identifier rubyid_from_gandi'>from_gandi</span> <span class='id identifier rubyid_data'>data</span>
|
496
|
-
<span class='kw'>end</span></pre>
|
497
|
-
</td>
|
498
|
-
</tr>
|
499
|
-
</table>
|
500
|
-
</div>
|
501
|
-
|
502
|
-
</div>
|
503
|
-
|
504
|
-
</div>
|
505
|
-
|
506
|
-
<div id="footer">
|
507
|
-
Generated on Mon Jul 22 16:44:27 2019 by
|
508
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
509
|
-
0.9.19 (ruby-2.6.3).
|
510
|
-
</div>
|
511
|
-
|
512
|
-
</div>
|
513
|
-
</body>
|
514
|
-
</html>
|