gandi_v5 0.2.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (157) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -0
  3. data/.rubocop.yml +13 -3
  4. data/.travis.yml +15 -1
  5. data/CHANGELOG.md +63 -0
  6. data/FUNDING.yml +10 -0
  7. data/LICENSE.md +2 -6
  8. data/README.md +16 -21
  9. data/gandi_v5.gemspec +3 -2
  10. data/lib/gandi_v5.rb +64 -24
  11. data/lib/gandi_v5/billing.rb +0 -2
  12. data/lib/gandi_v5/billing/info.rb +0 -2
  13. data/lib/gandi_v5/data.rb +1 -4
  14. data/lib/gandi_v5/data/converter.rb +0 -4
  15. data/lib/gandi_v5/data/converter/integer.rb +26 -0
  16. data/lib/gandi_v5/domain.rb +167 -28
  17. data/lib/gandi_v5/domain/availability.rb +0 -3
  18. data/lib/gandi_v5/domain/availability/product.rb +0 -3
  19. data/lib/gandi_v5/domain/live_dns.rb +42 -0
  20. data/lib/gandi_v5/domain/renewal_information.rb +0 -3
  21. data/lib/gandi_v5/domain/sharing_space.rb +10 -2
  22. data/lib/gandi_v5/email.rb +0 -4
  23. data/lib/gandi_v5/email/forward.rb +102 -0
  24. data/lib/gandi_v5/email/mailbox.rb +57 -13
  25. data/lib/gandi_v5/email/slot.rb +11 -3
  26. data/lib/gandi_v5/error.rb +0 -2
  27. data/lib/gandi_v5/live_dns.rb +0 -16
  28. data/lib/gandi_v5/live_dns/domain.rb +221 -80
  29. data/lib/gandi_v5/live_dns/domain/dnssec_key.rb +115 -0
  30. data/lib/gandi_v5/live_dns/domain/record.rb +81 -0
  31. data/lib/gandi_v5/live_dns/domain/snapshot.rb +107 -0
  32. data/lib/gandi_v5/live_dns/domain/tsig_key.rb +71 -0
  33. data/lib/gandi_v5/organization.rb +38 -5
  34. data/lib/gandi_v5/organization/customer.rb +90 -0
  35. data/lib/gandi_v5/version.rb +1 -1
  36. data/spec/.rubocop.yml +9 -2
  37. data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
  38. data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +8 -0
  39. data/spec/fixtures/bodies/GandiV5_Domain/{fetch_contacts.yaml → fetch_contacts.yml} +0 -0
  40. data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml +7 -0
  41. data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml +6 -0
  42. data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml +2 -0
  43. data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml} +0 -3
  44. data/spec/fixtures/bodies/GandiV5_Domain/{restore_info.yaml → fetch_restore_info.yml} +0 -0
  45. data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml} +1 -0
  46. data/spec/fixtures/bodies/GandiV5_Domain_Availability/{fetch.yaml → fetch.yml} +0 -0
  47. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{fetch.yaml → fetch.yml} +0 -0
  48. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{list.yaml → list.yml} +0 -0
  49. data/spec/fixtures/bodies/GandiV5_Email_Forward/list.yml +6 -0
  50. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{get.yaml → fetch.yml} +0 -0
  51. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{list.yaml → list.yml} +0 -0
  52. data/spec/fixtures/bodies/GandiV5_Email_Slot/{get.yaml → fetch.yml} +0 -0
  53. data/spec/fixtures/bodies/GandiV5_Email_Slot/{list.yaml → list.yml} +0 -0
  54. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/fetch.yml +3 -0
  55. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
  56. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml +3 -0
  57. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml +3 -0
  58. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/fetch.yml +12 -0
  59. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/list.yml +9 -0
  60. data/spec/fixtures/bodies/{GandiV5_LiveDNS_Zone_Snapshot/fetch.yaml → GandiV5_LiveDNS_Domain_Snapshot/fetch.yml} +4 -3
  61. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/list.yml +5 -0
  62. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/fetch.yml +9 -0
  63. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml +4 -0
  64. data/spec/fixtures/bodies/GandiV5_Organization/{get.yaml → fetch.yml} +0 -0
  65. data/spec/fixtures/bodies/GandiV5_Organization/list.yml +7 -0
  66. data/spec/fixtures/bodies/GandiV5_Organization_Customer/list.yml +8 -0
  67. data/spec/spec_helper.rb +2 -2
  68. data/spec/units/gandi_v5/billing_spec.rb +2 -2
  69. data/spec/units/gandi_v5/data/converter/integer_spec.rb +16 -0
  70. data/spec/units/gandi_v5/domain/availability_spec.rb +1 -1
  71. data/spec/units/gandi_v5/domain/live_dns_spec.rb +45 -0
  72. data/spec/units/gandi_v5/domain/tld_spec.rb +2 -2
  73. data/spec/units/gandi_v5/domain_spec.rb +294 -65
  74. data/spec/units/gandi_v5/email/forward_spec.rb +92 -0
  75. data/spec/units/gandi_v5/email/mailbox_spec.rb +122 -40
  76. data/spec/units/gandi_v5/email/slot_spec.rb +13 -5
  77. data/spec/units/gandi_v5/live_dns/domain/dnssec_key_spec.rb +128 -0
  78. data/spec/units/gandi_v5/live_dns/{record_set_spec.rb → domain/record_spec.rb} +1 -1
  79. data/spec/units/gandi_v5/live_dns/domain/snapshot_spec.rb +101 -0
  80. data/spec/units/gandi_v5/live_dns/domain/tsig_key_spec.rb +78 -0
  81. data/spec/units/gandi_v5/live_dns/domain_spec.rb +299 -120
  82. data/spec/units/gandi_v5/live_dns_spec.rb +0 -12
  83. data/spec/units/gandi_v5/organization/customer_spec.rb +81 -0
  84. data/spec/units/gandi_v5/organization_spec.rb +52 -1
  85. data/spec/units/gandi_v5_spec.rb +139 -30
  86. metadata +68 -95
  87. data/doc/GandiV5.html +0 -1183
  88. data/doc/GandiV5/Billing.html +0 -293
  89. data/doc/GandiV5/Billing/Info.html +0 -641
  90. data/doc/GandiV5/Billing/Info/Prepaid.html +0 -817
  91. data/doc/GandiV5/Data.html +0 -785
  92. data/doc/GandiV5/Data/ClassMethods.html +0 -223
  93. data/doc/GandiV5/Data/Converter.html +0 -433
  94. data/doc/GandiV5/Data/Converter/ArrayOf.html +0 -413
  95. data/doc/GandiV5/Data/Converter/Symbol.html +0 -322
  96. data/doc/GandiV5/Data/Converter/Time.html +0 -330
  97. data/doc/GandiV5/Domain.html +0 -16847
  98. data/doc/GandiV5/Domain/AutoRenew.html +0 -1237
  99. data/doc/GandiV5/Domain/Availability.html +0 -1020
  100. data/doc/GandiV5/Domain/Availability/Product.html +0 -988
  101. data/doc/GandiV5/Domain/Availability/Product/Period.html +0 -220
  102. data/doc/GandiV5/Domain/Availability/Product/Price.html +0 -1031
  103. data/doc/GandiV5/Domain/Availability/Tax.html +0 -440
  104. data/doc/GandiV5/Domain/Contact.html +0 -4459
  105. data/doc/GandiV5/Domain/Contract.html +0 -520
  106. data/doc/GandiV5/Domain/Dates.html +0 -1313
  107. data/doc/GandiV5/Domain/RenewalInformation.html +0 -1147
  108. data/doc/GandiV5/Domain/RestoreInformation.html +0 -339
  109. data/doc/GandiV5/Domain/SharingSpace.html +0 -437
  110. data/doc/GandiV5/Domain/TLD.html +0 -1565
  111. data/doc/GandiV5/Email.html +0 -144
  112. data/doc/GandiV5/Email/Mailbox.html +0 -6307
  113. data/doc/GandiV5/Email/Mailbox/Responder.html +0 -1560
  114. data/doc/GandiV5/Email/Offer.html +0 -514
  115. data/doc/GandiV5/Email/Slot.html +0 -4244
  116. data/doc/GandiV5/Error.html +0 -151
  117. data/doc/GandiV5/Error/GandiError.html +0 -270
  118. data/doc/GandiV5/LiveDNS.html +0 -300
  119. data/doc/GandiV5/LiveDNS/Domain.html +0 -2984
  120. data/doc/GandiV5/LiveDNS/RecordSet.html +0 -1593
  121. data/doc/GandiV5/LiveDNS/Zone.html +0 -8891
  122. data/doc/GandiV5/LiveDNS/Zone/Snapshot.html +0 -1556
  123. data/doc/GandiV5/Organization.html +0 -2341
  124. data/doc/_index.html +0 -474
  125. data/doc/class_list.html +0 -51
  126. data/doc/css/common.css +0 -1
  127. data/doc/css/full_list.css +0 -58
  128. data/doc/css/style.css +0 -496
  129. data/doc/file.README.html +0 -175
  130. data/doc/file_list.html +0 -56
  131. data/doc/frames.html +0 -17
  132. data/doc/index.html +0 -175
  133. data/doc/js/app.js +0 -303
  134. data/doc/js/full_list.js +0 -216
  135. data/doc/js/jquery.js +0 -4
  136. data/doc/method_list.html +0 -2427
  137. data/doc/top-level-namespace.html +0 -110
  138. data/lib/gandi_v5/live_dns/record_set.rb +0 -79
  139. data/lib/gandi_v5/live_dns/zone.rb +0 -305
  140. data/lib/gandi_v5/live_dns/zone/snapshot.rb +0 -81
  141. data/spec/features/domain_spec.rb +0 -45
  142. data/spec/features/livedns_domain_spec.rb +0 -8
  143. data/spec/features/livedns_zone_spec.rb +0 -45
  144. data/spec/features/mailbox_spec.rb +0 -18
  145. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/get.yaml +0 -4
  146. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/get.yaml +0 -11
  147. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/list.yaml +0 -11
  148. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yaml +0 -3
  149. data/spec/fixtures/vcr/Domain_features/List_domains.yml +0 -54
  150. data/spec/fixtures/vcr/Domain_features/Renew_domain.yml +0 -133
  151. data/spec/fixtures/vcr/LiveDNS_Domain_features/List_domains.yml +0 -32
  152. data/spec/fixtures/vcr/LiveDNS_Zone_features/List_zones.yml +0 -42
  153. data/spec/fixtures/vcr/LiveDNS_Zone_features/Make_and_save_snapshot.yml +0 -72
  154. data/spec/fixtures/vcr/LiveDNS_Zone_features/Save_zone_to_file.yml +0 -28
  155. data/spec/fixtures/vcr/Mailbox_features/List_mailboxes.yml +0 -39
  156. data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +0 -66
  157. data/spec/units/gandi_v5/live_dns/zone_spec.rb +0 -347
data/doc/GandiV5/Domain/Availability.html DELETED
@@ -1,1020 +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::Availability
8
-
9
- &mdash; 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::Availability";
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> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span>
41
- &raquo;
42
- <span class="title">Availability</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::Availability
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::Availability</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/availability.rb<span class="defines">,<br />
103
- lib/gandi_v5/domain/availability/tax.rb,<br /> lib/gandi_v5/domain/availability/product.rb,<br /> lib/gandi_v5/domain/availability/product/price.rb,<br /> lib/gandi_v5/domain/availability/product/period.rb</span>
104
- </dd>
105
- </dl>
106
-
107
- </div>
108
-
109
- <h2>Overview</h2><div class="docstring">
110
- <div class="discussion">
111
-
112
- <p>Information about the availabillity of processes on a domain.</p>
113
-
114
-
115
- </div>
116
- </div>
117
- <div class="tags">
118
-
119
-
120
- </div><h2>Defined Under Namespace</h2>
121
- <p class="children">
122
-
123
-
124
-
125
-
126
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">Product</a></span>, <span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">Tax</a></span>
127
-
128
-
129
- </p>
130
-
131
-
132
-
133
-
134
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
135
- <ul class="summary">
136
-
137
- <li class="public ">
138
- <span class="summary_signature">
139
-
140
- <a href="#currency-instance_method" title="#currency (instance method)">#<strong>currency</strong> &#x21d2; String </a>
141
-
142
-
143
-
144
- </span>
145
-
146
-
147
-
148
-
149
- <span class="note title readonly">readonly</span>
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
- <span class="summary_desc"><div class='inline'></div></span>
160
-
161
- </li>
162
-
163
-
164
- <li class="public ">
165
- <span class="summary_signature">
166
-
167
- <a href="#grid-instance_method" title="#grid (instance method)">#<strong>grid</strong> &#x21d2; String </a>
168
-
169
-
170
-
171
- </span>
172
-
173
-
174
-
175
-
176
- <span class="note title readonly">readonly</span>
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
- <span class="summary_desc"><div class='inline'></div></span>
187
-
188
- </li>
189
-
190
-
191
- <li class="public ">
192
- <span class="summary_signature">
193
-
194
- <a href="#products-instance_method" title="#products (instance method)">#<strong>products</strong> &#x21d2; Arrav&lt;GandiV5::Domain::Availability::Product&gt; </a>
195
-
196
-
197
-
198
- </span>
199
-
200
-
201
-
202
-
203
- <span class="note title readonly">readonly</span>
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
- <span class="summary_desc"><div class='inline'></div></span>
214
-
215
- </li>
216
-
217
-
218
- <li class="public ">
219
- <span class="summary_signature">
220
-
221
- <a href="#taxes-instance_method" title="#taxes (instance method)">#<strong>taxes</strong> &#x21d2; Array&lt;GandiV5::Domain::Availability::Tax&gt; </a>
222
-
223
-
224
-
225
- </span>
226
-
227
-
228
-
229
-
230
- <span class="note title readonly">readonly</span>
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
- <span class="summary_desc"><div class='inline'></div></span>
241
-
242
- </li>
243
-
244
-
245
- </ul>
246
-
247
-
248
-
249
-
250
-
251
- <h2>
252
- Class Method Summary
253
- <small><a href="#" class="summary_toggle">collapse</a></small>
254
- </h2>
255
-
256
- <ul class="summary">
257
-
258
- <li class="public ">
259
- <span class="summary_signature">
260
-
261
- <a href="#fetch-class_method" title="fetch (class method)">.<strong>fetch</strong>(fqdn, **options) &#x21d2; GandiV5::Domain::Availability </a>
262
-
263
-
264
-
265
- </span>
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
- <span class="summary_desc"><div class='inline'>
276
- <p>Check domain availability and pricing.</p>
277
- </div></span>
278
-
279
- </li>
280
-
281
-
282
- </ul>
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../Data.html" title="GandiV5::Data (module)">GandiV5::Data</a></span></h3>
295
- <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>
296
-
297
- <div id="instance_attr_details" class="attr_details">
298
- <h2>Instance Attribute Details</h2>
299
-
300
-
301
- <span id=""></span>
302
- <div class="method_details first">
303
- <h3 class="signature first" id="currency-instance_method">
304
-
305
- #<strong>currency</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
306
-
307
-
308
-
309
-
310
-
311
- </h3><div class="docstring">
312
- <div class="discussion">
313
-
314
-
315
- </div>
316
- </div>
317
- <div class="tags">
318
-
319
- <p class="tag_title">Returns:</p>
320
- <ul class="return">
321
-
322
- <li>
323
-
324
-
325
- <span class='type'>(<tt>String</tt>)</span>
326
-
327
-
328
-
329
- </li>
330
-
331
- </ul>
332
-
333
- </div><table class="source_code">
334
- <tr>
335
- <td>
336
- <pre class="lines">
337
-
338
-
339
- 17
340
- 18
341
- 19
342
- 20
343
- 21
344
- 22
345
- 23
346
- 24
347
- 25
348
- 26
349
- 27
350
- 28
351
- 29
352
- 30
353
- 31
354
- 32
355
- 33
356
- 34
357
- 35
358
- 36
359
- 37
360
- 38
361
- 39
362
- 40
363
- 41
364
- 42
365
- 43
366
- 44
367
- 45
368
- 46
369
- 47</pre>
370
- </td>
371
- <td>
372
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/availability.rb', line 17</span>
373
-
374
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span>
375
- <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>
376
-
377
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:currency</span><span class='comma'>,</span> <span class='symbol'>:grid</span>
378
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:products</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">Product</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
379
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:taxes</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">Tax</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
380
-
381
- <span class='comment'># Check domain availability and pricing.
382
- </span> <span class='comment'># @see https://api.gandi.net/docs/domains#get-v5-domain-check
383
- </span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to check.
384
- </span> <span class='comment'># @param country [String, #to_s] (optional)
385
- </span> <span class='comment'># ISO country code for which taxes are to be applied.
386
- </span> <span class='comment'># @param currency [String, #to_s] (optional) request price for a specific ISO currency code.
387
- </span> <span class='comment'># @param duration_unit [String, #to_s] (optional) define the unit for max_duration.
388
- </span> <span class='comment'># @param extension [String, #to_s] (optional) query a specific extension for product options.
389
- </span> <span class='comment'># @param grid [String, #to_s] (optional) request price for a specific rate.
390
- </span> <span class='comment'># @param lang [String, #to_s] (optional) language code.
391
- </span> <span class='comment'># @param max_duration [Integer, #to_s] (optional)
392
- </span> <span class='comment'># set a limit on the duration range for returned prices.
393
- </span> <span class='comment'># @param period [String, #to_s] (optional) specific registration period to query.
394
- </span> <span class='comment'># @param processes [Array&lt;:create, :renew, :transfer etc.&gt;] (optional default [:create])
395
- </span> <span class='comment'># list of at least 1 process for which pricing is to be made.
396
- </span> <span class='comment'># @param sharing_id [String, #to_s] (optional)
397
- </span> <span class='comment'># organization for which the pricing is to be made.
398
- </span> <span class='comment'># @return [GandiV5::Domain::Availability]
399
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
400
- </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='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
401
- <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='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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/check</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_fqdn'>fqdn</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
402
- <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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_gandi'><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">from_gandi</a></span></span> <span class='id identifier rubyid_data'>data</span>
403
- <span class='kw'>end</span>
404
- <span class='kw'>end</span></pre>
405
- </td>
406
- </tr>
407
- </table>
408
- </div>
409
-
410
-
411
- <span id=""></span>
412
- <div class="method_details ">
413
- <h3 class="signature " id="grid-instance_method">
414
-
415
- #<strong>grid</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
416
-
417
-
418
-
419
-
420
-
421
- </h3><div class="docstring">
422
- <div class="discussion">
423
-
424
-
425
- </div>
426
- </div>
427
- <div class="tags">
428
-
429
- <p class="tag_title">Returns:</p>
430
- <ul class="return">
431
-
432
- <li>
433
-
434
-
435
- <span class='type'>(<tt>String</tt>)</span>
436
-
437
-
438
-
439
- </li>
440
-
441
- </ul>
442
-
443
- </div><table class="source_code">
444
- <tr>
445
- <td>
446
- <pre class="lines">
447
-
448
-
449
- 17
450
- 18
451
- 19
452
- 20
453
- 21
454
- 22
455
- 23
456
- 24
457
- 25
458
- 26
459
- 27
460
- 28
461
- 29
462
- 30
463
- 31
464
- 32
465
- 33
466
- 34
467
- 35
468
- 36
469
- 37
470
- 38
471
- 39
472
- 40
473
- 41
474
- 42
475
- 43
476
- 44
477
- 45
478
- 46
479
- 47</pre>
480
- </td>
481
- <td>
482
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/availability.rb', line 17</span>
483
-
484
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span>
485
- <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>
486
-
487
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:currency</span><span class='comma'>,</span> <span class='symbol'>:grid</span>
488
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:products</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">Product</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
489
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:taxes</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">Tax</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
490
-
491
- <span class='comment'># Check domain availability and pricing.
492
- </span> <span class='comment'># @see https://api.gandi.net/docs/domains#get-v5-domain-check
493
- </span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to check.
494
- </span> <span class='comment'># @param country [String, #to_s] (optional)
495
- </span> <span class='comment'># ISO country code for which taxes are to be applied.
496
- </span> <span class='comment'># @param currency [String, #to_s] (optional) request price for a specific ISO currency code.
497
- </span> <span class='comment'># @param duration_unit [String, #to_s] (optional) define the unit for max_duration.
498
- </span> <span class='comment'># @param extension [String, #to_s] (optional) query a specific extension for product options.
499
- </span> <span class='comment'># @param grid [String, #to_s] (optional) request price for a specific rate.
500
- </span> <span class='comment'># @param lang [String, #to_s] (optional) language code.
501
- </span> <span class='comment'># @param max_duration [Integer, #to_s] (optional)
502
- </span> <span class='comment'># set a limit on the duration range for returned prices.
503
- </span> <span class='comment'># @param period [String, #to_s] (optional) specific registration period to query.
504
- </span> <span class='comment'># @param processes [Array&lt;:create, :renew, :transfer etc.&gt;] (optional default [:create])
505
- </span> <span class='comment'># list of at least 1 process for which pricing is to be made.
506
- </span> <span class='comment'># @param sharing_id [String, #to_s] (optional)
507
- </span> <span class='comment'># organization for which the pricing is to be made.
508
- </span> <span class='comment'># @return [GandiV5::Domain::Availability]
509
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
510
- </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='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
511
- <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='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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/check</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_fqdn'>fqdn</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
512
- <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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_gandi'><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">from_gandi</a></span></span> <span class='id identifier rubyid_data'>data</span>
513
- <span class='kw'>end</span>
514
- <span class='kw'>end</span></pre>
515
- </td>
516
- </tr>
517
- </table>
518
- </div>
519
-
520
-
521
- <span id=""></span>
522
- <div class="method_details ">
523
- <h3 class="signature " id="products-instance_method">
524
-
525
- #<strong>products</strong> &#x21d2; <tt>Arrav&lt;<span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">GandiV5::Domain::Availability::Product</a></span>&gt;</tt> <span class="extras">(readonly)</span>
526
-
527
-
528
-
529
-
530
-
531
- </h3><div class="docstring">
532
- <div class="discussion">
533
-
534
-
535
- </div>
536
- </div>
537
- <div class="tags">
538
-
539
- <p class="tag_title">Returns:</p>
540
- <ul class="return">
541
-
542
- <li>
543
-
544
-
545
- <span class='type'>(<tt>Arrav&lt;<span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">GandiV5::Domain::Availability::Product</a></span>&gt;</tt>)</span>
546
-
547
-
548
-
549
- </li>
550
-
551
- </ul>
552
-
553
- </div><table class="source_code">
554
- <tr>
555
- <td>
556
- <pre class="lines">
557
-
558
-
559
- 17
560
- 18
561
- 19
562
- 20
563
- 21
564
- 22
565
- 23
566
- 24
567
- 25
568
- 26
569
- 27
570
- 28
571
- 29
572
- 30
573
- 31
574
- 32
575
- 33
576
- 34
577
- 35
578
- 36
579
- 37
580
- 38
581
- 39
582
- 40
583
- 41
584
- 42
585
- 43
586
- 44
587
- 45
588
- 46
589
- 47</pre>
590
- </td>
591
- <td>
592
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/availability.rb', line 17</span>
593
-
594
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span>
595
- <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>
596
-
597
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:currency</span><span class='comma'>,</span> <span class='symbol'>:grid</span>
598
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:products</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">Product</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
599
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:taxes</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">Tax</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
600
-
601
- <span class='comment'># Check domain availability and pricing.
602
- </span> <span class='comment'># @see https://api.gandi.net/docs/domains#get-v5-domain-check
603
- </span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to check.
604
- </span> <span class='comment'># @param country [String, #to_s] (optional)
605
- </span> <span class='comment'># ISO country code for which taxes are to be applied.
606
- </span> <span class='comment'># @param currency [String, #to_s] (optional) request price for a specific ISO currency code.
607
- </span> <span class='comment'># @param duration_unit [String, #to_s] (optional) define the unit for max_duration.
608
- </span> <span class='comment'># @param extension [String, #to_s] (optional) query a specific extension for product options.
609
- </span> <span class='comment'># @param grid [String, #to_s] (optional) request price for a specific rate.
610
- </span> <span class='comment'># @param lang [String, #to_s] (optional) language code.
611
- </span> <span class='comment'># @param max_duration [Integer, #to_s] (optional)
612
- </span> <span class='comment'># set a limit on the duration range for returned prices.
613
- </span> <span class='comment'># @param period [String, #to_s] (optional) specific registration period to query.
614
- </span> <span class='comment'># @param processes [Array&lt;:create, :renew, :transfer etc.&gt;] (optional default [:create])
615
- </span> <span class='comment'># list of at least 1 process for which pricing is to be made.
616
- </span> <span class='comment'># @param sharing_id [String, #to_s] (optional)
617
- </span> <span class='comment'># organization for which the pricing is to be made.
618
- </span> <span class='comment'># @return [GandiV5::Domain::Availability]
619
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
620
- </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='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
621
- <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='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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/check</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_fqdn'>fqdn</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
622
- <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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_gandi'><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">from_gandi</a></span></span> <span class='id identifier rubyid_data'>data</span>
623
- <span class='kw'>end</span>
624
- <span class='kw'>end</span></pre>
625
- </td>
626
- </tr>
627
- </table>
628
- </div>
629
-
630
-
631
- <span id=""></span>
632
- <div class="method_details ">
633
- <h3 class="signature " id="taxes-instance_method">
634
-
635
- #<strong>taxes</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">GandiV5::Domain::Availability::Tax</a></span>&gt;</tt> <span class="extras">(readonly)</span>
636
-
637
-
638
-
639
-
640
-
641
- </h3><div class="docstring">
642
- <div class="discussion">
643
-
644
-
645
- </div>
646
- </div>
647
- <div class="tags">
648
-
649
- <p class="tag_title">Returns:</p>
650
- <ul class="return">
651
-
652
- <li>
653
-
654
-
655
- <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">GandiV5::Domain::Availability::Tax</a></span>&gt;</tt>)</span>
656
-
657
-
658
-
659
- </li>
660
-
661
- </ul>
662
-
663
- </div><table class="source_code">
664
- <tr>
665
- <td>
666
- <pre class="lines">
667
-
668
-
669
- 17
670
- 18
671
- 19
672
- 20
673
- 21
674
- 22
675
- 23
676
- 24
677
- 25
678
- 26
679
- 27
680
- 28
681
- 29
682
- 30
683
- 31
684
- 32
685
- 33
686
- 34
687
- 35
688
- 36
689
- 37
690
- 38
691
- 39
692
- 40
693
- 41
694
- 42
695
- 43
696
- 44
697
- 45
698
- 46
699
- 47</pre>
700
- </td>
701
- <td>
702
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/availability.rb', line 17</span>
703
-
704
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span>
705
- <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>
706
-
707
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:currency</span><span class='comma'>,</span> <span class='symbol'>:grid</span>
708
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:products</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Product.html" title="GandiV5::Domain::Availability::Product (class)">Product</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
709
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:taxes</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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Availability/Tax.html" title="GandiV5::Domain::Availability::Tax (class)">Tax</a></span></span><span class='comma'>,</span> <span class='label'>array:</span> <span class='kw'>true</span>
710
-
711
- <span class='comment'># Check domain availability and pricing.
712
- </span> <span class='comment'># @see https://api.gandi.net/docs/domains#get-v5-domain-check
713
- </span> <span class='comment'># @param fqdn [String, #to_s] the fully qualified domain name to check.
714
- </span> <span class='comment'># @param country [String, #to_s] (optional)
715
- </span> <span class='comment'># ISO country code for which taxes are to be applied.
716
- </span> <span class='comment'># @param currency [String, #to_s] (optional) request price for a specific ISO currency code.
717
- </span> <span class='comment'># @param duration_unit [String, #to_s] (optional) define the unit for max_duration.
718
- </span> <span class='comment'># @param extension [String, #to_s] (optional) query a specific extension for product options.
719
- </span> <span class='comment'># @param grid [String, #to_s] (optional) request price for a specific rate.
720
- </span> <span class='comment'># @param lang [String, #to_s] (optional) language code.
721
- </span> <span class='comment'># @param max_duration [Integer, #to_s] (optional)
722
- </span> <span class='comment'># set a limit on the duration range for returned prices.
723
- </span> <span class='comment'># @param period [String, #to_s] (optional) specific registration period to query.
724
- </span> <span class='comment'># @param processes [Array&lt;:create, :renew, :transfer etc.&gt;] (optional default [:create])
725
- </span> <span class='comment'># list of at least 1 process for which pricing is to be made.
726
- </span> <span class='comment'># @param sharing_id [String, #to_s] (optional)
727
- </span> <span class='comment'># organization for which the pricing is to be made.
728
- </span> <span class='comment'># @return [GandiV5::Domain::Availability]
729
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
730
- </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='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
731
- <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='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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/check</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_fqdn'>fqdn</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
732
- <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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_gandi'><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">from_gandi</a></span></span> <span class='id identifier rubyid_data'>data</span>
733
- <span class='kw'>end</span>
734
- <span class='kw'>end</span></pre>
735
- </td>
736
- </tr>
737
- </table>
738
- </div>
739
-
740
- </div>
741
-
742
-
743
- <div id="class_method_details" class="method_details_list">
744
- <h2>Class Method Details</h2>
745
-
746
-
747
- <div class="method_details first">
748
- <h3 class="signature first" id="fetch-class_method">
749
-
750
- .<strong>fetch</strong>(fqdn, **options) &#x21d2; <tt><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">GandiV5::Domain::Availability</a></span></tt>
751
-
752
-
753
-
754
-
755
-
756
- </h3><div class="docstring">
757
- <div class="discussion">
758
-
759
- <p>Check domain availability and pricing.</p>
760
-
761
-
762
- </div>
763
- </div>
764
- <div class="tags">
765
- <p class="tag_title">Parameters:</p>
766
- <ul class="param">
767
-
768
- <li>
769
-
770
- <span class='name'>fqdn</span>
771
-
772
-
773
- <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>
774
-
775
-
776
-
777
- &mdash;
778
- <div class='inline'>
779
- <p>the fully qualified domain name to check.</p>
780
- </div>
781
-
782
- </li>
783
-
784
- <li>
785
-
786
- <span class='name'>country</span>
787
-
788
-
789
- <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>
790
-
791
-
792
-
793
- &mdash;
794
- <div class='inline'>
795
- <p>(optional) ISO country code for which taxes are to be applied.</p>
796
- </div>
797
-
798
- </li>
799
-
800
- <li>
801
-
802
- <span class='name'>currency</span>
803
-
804
-
805
- <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>
806
-
807
-
808
-
809
- &mdash;
810
- <div class='inline'>
811
- <p>(optional) request price for a specific ISO currency code.</p>
812
- </div>
813
-
814
- </li>
815
-
816
- <li>
817
-
818
- <span class='name'>duration_unit</span>
819
-
820
-
821
- <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>
822
-
823
-
824
-
825
- &mdash;
826
- <div class='inline'>
827
- <p>(optional) define the unit for max_duration.</p>
828
- </div>
829
-
830
- </li>
831
-
832
- <li>
833
-
834
- <span class='name'>extension</span>
835
-
836
-
837
- <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>
838
-
839
-
840
-
841
- &mdash;
842
- <div class='inline'>
843
- <p>(optional) query a specific extension for product options.</p>
844
- </div>
845
-
846
- </li>
847
-
848
- <li>
849
-
850
- <span class='name'>grid</span>
851
-
852
-
853
- <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>
854
-
855
-
856
-
857
- &mdash;
858
- <div class='inline'>
859
- <p>(optional) request price for a specific rate.</p>
860
- </div>
861
-
862
- </li>
863
-
864
- <li>
865
-
866
- <span class='name'>lang</span>
867
-
868
-
869
- <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>
870
-
871
-
872
-
873
- &mdash;
874
- <div class='inline'>
875
- <p>(optional) language code.</p>
876
- </div>
877
-
878
- </li>
879
-
880
- <li>
881
-
882
- <span class='name'>max_duration</span>
883
-
884
-
885
- <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>
886
-
887
-
888
-
889
- &mdash;
890
- <div class='inline'>
891
- <p>(optional) set a limit on the duration range for returned prices.</p>
892
- </div>
893
-
894
- </li>
895
-
896
- <li>
897
-
898
- <span class='name'>period</span>
899
-
900
-
901
- <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>
902
-
903
-
904
-
905
- &mdash;
906
- <div class='inline'>
907
- <p>(optional) specific registration period to query.</p>
908
- </div>
909
-
910
- </li>
911
-
912
- <li>
913
-
914
- <span class='name'>processes</span>
915
-
916
-
917
- <span class='type'>(<tt>Array&lt;:create, :renew, :transfer etc.&gt;</tt>)</span>
918
-
919
-
920
-
921
- &mdash;
922
- <div class='inline'>
923
- <p>(optional default [:create]) list of at least 1 process for which pricing is to be made.</p>
924
- </div>
925
-
926
- </li>
927
-
928
- <li>
929
-
930
- <span class='name'>sharing_id</span>
931
-
932
-
933
- <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>
934
-
935
-
936
-
937
- &mdash;
938
- <div class='inline'>
939
- <p>(optional) organization for which the pricing is to be made.</p>
940
- </div>
941
-
942
- </li>
943
-
944
- </ul>
945
-
946
- <p class="tag_title">Returns:</p>
947
- <ul class="return">
948
-
949
- <li>
950
-
951
-
952
- <span class='type'>(<tt><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">GandiV5::Domain::Availability</a></span></tt>)</span>
953
-
954
-
955
-
956
- </li>
957
-
958
- </ul>
959
- <p class="tag_title">Raises:</p>
960
- <ul class="raise">
961
-
962
- <li>
963
-
964
-
965
- <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>
966
-
967
-
968
-
969
- &mdash;
970
- <div class='inline'>
971
- <p>if Gandi returns an error.</p>
972
- </div>
973
-
974
- </li>
975
-
976
- </ul>
977
-
978
- <p class="tag_title">See Also:</p>
979
- <ul class="see">
980
-
981
- <li><a href="https://api.gandi.net/docs/domains#get-v5-domain-check" target="_parent" title="https://api.gandi.net/docs/domains#get-v5-domain-check">https://api.gandi.net/docs/domains#get-v5-domain-check</a></li>
982
-
983
- </ul>
984
-
985
- </div><table class="source_code">
986
- <tr>
987
- <td>
988
- <pre class="lines">
989
-
990
-
991
- 43
992
- 44
993
- 45
994
- 46</pre>
995
- </td>
996
- <td>
997
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/domain/availability.rb', line 43</span>
998
-
999
- <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='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1000
- <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='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</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/check</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>params:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_fqdn'>fqdn</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
1001
- <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="../Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="GandiV5::Domain::Availability (class)">Availability</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_gandi'><span class='object_link'><a href="../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">from_gandi</a></span></span> <span class='id identifier rubyid_data'>data</span>
1002
- <span class='kw'>end</span></pre>
1003
- </td>
1004
- </tr>
1005
- </table>
1006
- </div>
1007
-
1008
- </div>
1009
-
1010
- </div>
1011
-
1012
- <div id="footer">
1013
- Generated on Mon Jul 22 16:44:33 2019 by
1014
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1015
- 0.9.19 (ruby-2.6.3).
1016
- </div>
1017
-
1018
- </div>
1019
- </body>
1020
- </html>