params.go raw
1 package namesilo
2
3 // AddAccountFundsParams Parameters for operation addAccountFunds.
4 type AddAccountFundsParams struct {
5 Amount string `url:"amount"`
6 PaymentID string `url:"payment_id"`
7 }
8
9 // AddAutoRenewalParams Parameters for operation addAutoRenewal.
10 type AddAutoRenewalParams struct {
11 Domain string `url:"domain"` // Required
12 }
13
14 // AddPrivacyParams Parameters for operation addPrivacy.
15 type AddPrivacyParams struct {
16 Domain string `url:"domain"` // Required
17 }
18
19 // AddRegisteredNameServerParams Parameters for operation addRegisteredNameServer.
20 type AddRegisteredNameServerParams struct {
21 Domain string `url:"domain"` // required
22 NewHost string `url:"new_host"` // Required
23 IP1 string `url:"ip1"` // Required
24
25 IP2 string `url:"ip2"` // Optional
26 IP3 string `url:"ip3"` // Optional
27 IP4 string `url:"ip4"` // Optional
28 IP5 string `url:"ip5"` // Optional
29 IP6 string `url:"ip6"` // Optional
30 IP7 string `url:"ip7"` // Optional
31 IP8 string `url:"ip8"` // Optional
32 IP9 string `url:"ip9"` // Optional
33 IP10 string `url:"ip10"` // Optional
34 IP11 string `url:"ip11"` // Optional
35 IP12 string `url:"ip12"` // Optional
36 IP13 string `url:"ip13"` // Optional
37 }
38
39 // BidAuctionParams Parameters for operation bidAuction.
40 type BidAuctionParams struct {
41 AuctionID string `url:"auctionId"` // Required
42 Bid string `url:"bid"` // Required
43 ProxyBid string `url:"proxyBid"` // Optional
44 }
45
46 // BuyNowAuctionParams Parameters for operation buyNowAuction.
47 type BuyNowAuctionParams struct {
48 AuctionID string `url:"auctionId"` // Required
49 }
50
51 // ChangeNameServersParams Parameters for operation changeNameServers.
52 type ChangeNameServersParams struct {
53 Domains string `url:"domain"` // Required (A comma-delimited list of up to 200 domains)
54
55 NameServer1 string `url:"ns1"` // Required
56 NameServer2 string `url:"ns2"` // Required
57
58 NameServer3 string `url:"ns3"`
59 NameServer4 string `url:"ns4"`
60 NameServer5 string `url:"ns5"`
61 NameServer6 string `url:"ns6"`
62 NameServer7 string `url:"ns7"`
63 NameServer8 string `url:"ns8"`
64 NameServer9 string `url:"ns9"`
65 NameServer10 string `url:"ns10"`
66 NameServer11 string `url:"ns11"`
67 NameServer12 string `url:"ns12"`
68 NameServer13 string `url:"ns13"`
69 }
70
71 // CheckRegisterAvailabilityParams Parameters for operation checkRegisterAvailability.
72 type CheckRegisterAvailabilityParams struct {
73 Domains string `url:"domains"` // Required (A comma-delimited list of domains to check)
74 }
75
76 // CheckTransferAvailabilityParams Parameters for operation checkTransferAvailability.
77 type CheckTransferAvailabilityParams struct {
78 Domains string `url:"domains"` // Required (A comma-delimited list of domains to check)
79 }
80
81 // CheckTransferStatusParams Parameters for operation checkTransferStatus.
82 type CheckTransferStatusParams struct {
83 Domain string `url:"domain"` // Required
84 }
85
86 // ConfigureEmailForwardParams Parameters for operation configureEmailForward.
87 type ConfigureEmailForwardParams struct {
88 Domain string `url:"domain"` // Required
89 Email string `url:"email"` // Required
90 Forward1 string `url:"forward1"` // Required
91
92 Forward2 string `url:"forward12"` // Optional
93 Forward3 string `url:"forward13"` // Optional
94 Forward4 string `url:"forward14"` // Optional
95 Forward5 string `url:"forward15"` // Optional
96 }
97
98 // ContactAddParams Parameters for operation contactAdd.
99 type ContactAddParams struct {
100 FirstName string `url:"fn"` // Contact Information
101 LastName string `url:"ln"` // Contact Information
102 MailingAddress string `url:"ad"` // Contact Information
103 MailingCity string `url:"cy"` // Contact Information
104 MailingStateProvinceTerritory string `url:"st"` // Contact Information
105 MailingZipPostalCode string `url:"zp"` // Contact Information
106 MailingCountry string `url:"ct"` // Contact Information
107 EmailAddress string `url:"em"` // Contact Information
108 PhoneNumber string `url:"ph"` // Contact Information
109
110 Company string `url:"cp"` // Contact Information
111 MailingAddress2 string `url:"ad2"` // Contact Information
112 Fax string `url:"fx"` // Contact Information
113
114 USNexusCategory string `url:"usnc"` // Contact Information
115 USApplicationPurpose string `url:"usap"` // Contact Information
116
117 CIRALegalForm string `url:"calf"` // CIRA
118 CIRALanguage string `url:"caln"` // CIRA
119 CIRAAgreementVersion string `url:"caag"` // CIRA
120 CIRAWHOISDisplay string `url:"cawd"` // CIRA
121 }
122
123 // ContactDeleteParams Parameters for operation contactDelete.
124 type ContactDeleteParams struct {
125 ContactID string `url:"contact_id"`
126 }
127
128 // ContactDomainAssociateParams Parameters for operation contactDomainAssociate.
129 type ContactDomainAssociateParams struct {
130 Domain string `url:"domain"` // Required
131
132 Registrant string `url:"registrant"` // Optional
133 Administrative string `url:"administrative"` // Optional
134 Billing string `url:"billing"` // Optional
135 Technical string `url:"technical"` // Optional
136
137 ContactID string `url:"contact_id"` // Contact ID
138 }
139
140 // ContactListParams Parameters for operation contactList.
141 type ContactListParams struct {
142 ContactID string `url:"contact_id"` // Optional
143 }
144
145 // ContactUpdateParams Parameters for operation contactUpdate.
146 type ContactUpdateParams struct {
147 FirstName string `url:"fn"` // Contact Information
148 LastName string `url:"ln"` // Contact Information
149 MailingAddress string `url:"ad"` // Contact Information
150 MailingCity string `url:"cy"` // Contact Information
151 MailingStateProvinceTerritory string `url:"st"` // Contact Information
152 MailingZipPostalCode string `url:"zp"` // Contact Information
153 MailingCountry string `url:"ct"` // Contact Information
154 EmailAddress string `url:"em"` // Contact Information
155 PhoneNumber string `url:"ph"` // Contact Information
156
157 Company string `url:"cp"` // Contact Information
158 MailingAddress2 string `url:"ad2"` // Contact Information
159 Fax string `url:"fx"` // Contact Information
160
161 USNexusCategory string `url:"usnc"` // Contact Information
162 USApplicationPurpose string `url:"usap"` // Contact Information
163
164 CIRALegalForm string `url:"calf"` // CIRA
165 CIRALanguage string `url:"caln"` // CIRA
166 CIRAAgreementVersion string `url:"caag"` // CIRA
167 CIRAWHOISDisplay string `url:"cawd"` // CIRA
168 }
169
170 // CountExpiringDomainsParams Parameters for operation countExpiringDomains.
171 type CountExpiringDomainsParams struct {
172 DaysCount int `url:"daysCount"` // Required
173 }
174
175 // DeleteEmailForwardParams Parameters for operation deleteEmailForward.
176 type DeleteEmailForwardParams struct {
177 Domain string `url:"domain"` // Required
178 Email string `url:"email"` // Required
179 }
180
181 // DeleteRegisteredNameServerParams Parameters for operation deleteRegisteredNameServer.
182 type DeleteRegisteredNameServerParams struct {
183 Domain string `url:"domain"` // required
184 CurrentHost string `url:"current_host"` // Required
185 }
186
187 // DnsAddRecordParams Parameters for operation dnsAddRecord.
188 type DnsAddRecordParams struct {
189 Domain string `url:"domain"` // Required
190
191 Type string `url:"rrtype"` // Possible values are "A", "AAAA", "CNAME", "MX" and "TXT"
192 Host string `url:"rrhost"`
193 Value string `url:"rrvalue"`
194 Distance int `url:"rrdistance"`
195 TTL int `url:"rrttl"`
196 }
197
198 // DnsDeleteRecordParams Parameters for operation dnsDeleteRecord.
199 type DnsDeleteRecordParams struct {
200 Domain string `url:"domain"` // Required
201
202 ID string `url:"rrid"`
203 }
204
205 // DnsListRecordsParams Parameters for operation dnsListRecords.
206 type DnsListRecordsParams struct {
207 Domain string `url:"domain"` // Required
208 }
209
210 // DnsSecAddRecordParams Parameters for operation dnsSecAddRecord.
211 type DnsSecAddRecordParams struct {
212 Domain string `url:"domain"` // Required
213
214 Digest string `url:"digest"`
215 KeyTag string `url:"keyTag"`
216 DigestType string `url:"digestType"`
217 Alg string `url:"alg"`
218 }
219
220 // DnsSecDeleteRecordParams Parameters for operation dnsSecDeleteRecord.
221 type DnsSecDeleteRecordParams struct {
222 Domain string `url:"domain"` // Required
223
224 Digest string `url:"digest"`
225 KeyTag string `url:"keyTag"`
226 DigestType string `url:"digestType"`
227 Alg string `url:"alg"`
228 }
229
230 // DnsSecListRecordsParams Parameters for operation dnsSecListRecords.
231 type DnsSecListRecordsParams struct {
232 Domain string `url:"domain"` // Required
233 }
234
235 // DnsUpdateRecordParams Parameters for operation dnsUpdateRecord.
236 type DnsUpdateRecordParams struct {
237 Domain string `url:"domain"` // Required
238
239 ID string `url:"rrid"`
240 Host string `url:"rrhost"`
241 Value string `url:"rrvalue"`
242 Distance int `url:"rrdistance"`
243 TTL int `url:"rrttl"`
244 }
245
246 // DomainForwardParams Parameters for operation domainForward.
247 type DomainForwardParams struct {
248 Domain string `url:"domain"` // Required
249 Protocol string `url:"protocol"` // Required
250 Address string `url:"address"` // Required
251 Method string `url:"method"` // Required
252
253 MetaTitle string `url:"meta_title"` // Optional
254 MetaDescription string `url:"meta_description"` // Optional
255 MetaKeywords string `url:"meta_keywords"` // Optional
256 }
257
258 // DomainForwardSubDomainParams Parameters for operation domainForwardSubDomain.
259 type DomainForwardSubDomainParams struct {
260 Domain string `url:"domain"` // Required
261 SubDomain string `url:"sub_domain"` // Required
262 Protocol string `url:"protocol"` // Required
263 Address string `url:"address"` // Required
264 Method string `url:"method"` // Required
265
266 MetaTitle string `url:"meta_title"` // Optional
267 MetaDescription string `url:"meta_description"` // Optional
268 MetaKeywords string `url:"meta_keywords"` // Optional
269 }
270
271 // DomainForwardSubDomainDeleteParams Parameters for operation domainForwardSubDomainDelete.
272 type DomainForwardSubDomainDeleteParams struct {
273 Domain string `url:"domain"` // Required
274 SubDomain string `url:"sub_domain"` // Required
275 }
276
277 // DomainLockParams Parameters for operation domainLock.
278 type DomainLockParams struct {
279 Domain string `url:"domain"` // Required
280 }
281
282 // DomainPushParams Parameters for operation domainPush.
283 type DomainPushParams struct {
284 RecipientLogin string `url:"recipientLogin"`
285 Domains []string `url:"domains,brackets"`
286 }
287
288 // DomainUnlockParams Parameters for operation domainUnlock.
289 type DomainUnlockParams struct {
290 Domain string `url:"domain"` // Required
291 }
292
293 // EmailVerificationParams Parameters for operation emailVerification.
294 type EmailVerificationParams struct {
295 Email string `url:"email"` // Required
296 }
297
298 // GetAccountBalanceParams Parameters for operation getAccountBalance.
299 type GetAccountBalanceParams struct{}
300
301 // GetDomainInfoParams Parameters for operation getDomainInfo.
302 type GetDomainInfoParams struct {
303 Domain string `url:"domain"` // Required
304 }
305
306 // GetPricesParams Parameters for operation getPrices.
307 type GetPricesParams struct {
308 RetailPrices string `url:"retail_prices"` // Required
309 RegistrationDomains string `url:"registration_domains"` // Required
310 }
311
312 // ListAuctionsParams Parameters for operation listAuctions.
313 type ListAuctionsParams struct {
314 DomainID string `url:"domainId"` // Optional
315 DomainName string `url:"domainName"` // Optional
316 TypeID string `url:"typeId"` // Optional
317 StatusID string `url:"statusId"` // Optional
318 BuyNow string `url:"buyNow"` // Optional
319 MinCurrentBid string `url:"minCurrentBid"` // Optional
320 MaxCurrentBid string `url:"maxCurrentBid"` // Optional
321 OrderBy string `url:"orderBy"` // Optional
322 OrderType string `url:"orderType"` // Optional
323 Page int `url:"page"` // Optional
324 PageSize int `url:"pageSize"` // Optional
325 Watchlist string `url:"watchlist"` // Optional
326 }
327
328 // ListDomainsParams Parameters for operation listDomains.
329 type ListDomainsParams struct {
330 Portfolio string `url:"portfolio"` // Optional
331 }
332
333 // ListEmailForwardsParams Parameters for operation listEmailForwards.
334 type ListEmailForwardsParams struct {
335 Domain string `url:"domain"` // Required
336 }
337
338 // ListExpiringDomainsParams Parameters for operation listExpiringDomains.
339 type ListExpiringDomainsParams struct {
340 DaysCount int `url:"daysCount"` // Required
341 Page int `url:"page"` // Optional
342 PageSize int `url:"pageSize"` // Optional
343 }
344
345 // ListOrdersParams Parameters for operation listOrders.
346 type ListOrdersParams struct{}
347
348 // ListRegisteredNameServersParams Parameters for operation listRegisteredNameServers.
349 type ListRegisteredNameServersParams struct {
350 Domain string `url:"domain"` // required
351 }
352
353 // MarketplaceActiveSalesOverviewParams Parameters for operation marketplaceActiveSalesOverview.
354 type MarketplaceActiveSalesOverviewParams struct{}
355
356 // MarketplaceAddOrModifySaleParams Parameters for operation marketplaceAddOrModifySale.
357 type MarketplaceAddOrModifySaleParams struct {
358 Domain string `url:"domain"` // Required
359 Action string `url:"action"` // Required
360 SaleType string `url:"sale_type"` // Required
361
362 Reserve string `url:"reserve"` // Optional
363 ShowReserve int32 `url:"show_reserve"` // Optional
364 BuyNow string `url:"buy_now"` // Optional
365 PaymentPlanOffered int32 `url:"payment_plan_offered"` // Optional
366 PaymentPlanMonths int32 `url:"payment_plan_months"` // Optional
367 PaymentPlanDownPayment string `url:"payment_plan_down_payment"` // Optional
368 EndDate string `url:"end_date"` // Optional
369 EndDateUseMaximum int32 `url:"end_date_use_maximum"` // Optional
370 NotifyBuyers int32 `url:"notify_buyers"` // Optional
371 Category1 string `url:"category1"` // Optional
372 Description string `url:"description"` // Optional
373 UseForSaleLandingPage int32 `url:"use_for_sale_landing_page"` // Optional
374 MpUseOurNameservers int32 `url:"mp_use_our_nameservers"` // Optional
375 Password string `url:"password"` // Optional
376 CancelSale int32 `url:"cancel_sale"` // Optional
377 }
378
379 // MarketplaceLandingPageUpdateParams Parameters for operation marketplaceLandingPageUpdate.
380 type MarketplaceLandingPageUpdateParams struct {
381 Domain string `url:"domain"` // Required
382
383 MpTemplate int32 `url:"mp_template"` // Optional
384 MpBgcolor string `url:"mp_bgcolor"` // Optional
385 MpTextcolor string `url:"mp_textcolor"` // Optional
386 MpShowBuyNow int32 `url:"mp_show_buy_now"` // Optional
387 MpShowMoreInfo int32 `url:"mp_show_more_info"` // Optional
388 MpShowRenewalPrice int32 `url:"mp_show_renewal_price"` // Optional
389 MpShowOtherForSale int32 `url:"mp_show_other_for_sale"` // Optional
390 MpOtherDomainLinks string `url:"mp_other_domain_links"` // Optional
391 MpMessage string `url:"mp_message"` // Optional
392 }
393
394 // ModifyRegisteredNameServerParams Parameters for operation modifyRegisteredNameServer.
395 type ModifyRegisteredNameServerParams struct {
396 Domain string `url:"domain"` // required
397 CurrentHost string `url:"current_host"` // Required
398 NewHost string `url:"new_host"` // Required
399 IP1 string `url:"ip1"` // Required
400
401 IP2 string `url:"ip2"` // Optional
402 IP3 string `url:"ip3"` // Optional
403 IP4 string `url:"ip4"` // Optional
404 IP5 string `url:"ip5"` // Optional
405 IP6 string `url:"ip6"` // Optional
406 IP7 string `url:"ip7"` // Optional
407 IP8 string `url:"ip8"` // Optional
408 IP9 string `url:"ip9"` // Optional
409 IP10 string `url:"ip10"` // Optional
410 IP11 string `url:"ip11"` // Optional
411 IP12 string `url:"ip12"` // Optional
412 IP13 string `url:"ip13"` // Optional
413 }
414
415 // OrderDetailsParams Parameters for operation orderDetails.
416 type OrderDetailsParams struct {
417 OrderNumber int `url:"order_number"`
418 }
419
420 // PortfolioAddParams Parameters for operation portfolioAdd.
421 type PortfolioAddParams struct {
422 Portfolio string `url:"portfolio"` // Required
423 }
424
425 // PortfolioDeleteParams Parameters for operation portfolioDelete.
426 type PortfolioDeleteParams struct {
427 Portfolio string `url:"portfolio"` // Required
428 }
429
430 // PortfolioDomainAssociateParams Parameters for operation portfolioDomainAssociate.
431 type PortfolioDomainAssociateParams struct {
432 Portfolio string `url:"portfolio"` // Required
433 Domains string `url:"domains"` // Required (Comma-delimited list)
434 }
435
436 // PortfolioListParams Parameters for operation portfolioList.
437 type PortfolioListParams struct{}
438
439 // RegisterDomainParams Parameters for operation registerDomain.
440 type RegisterDomainParams struct {
441 Domain string `url:"domain"` // Required
442 Years int32 `url:"years"` // Required
443
444 PaymentID string `url:"payment_id"` // Optional
445 Private int32 `url:"private"` // Optional
446 AutoRenew int32 `url:"auto_renew"` // Optional
447 Portfolio string `url:"portfolio"` // Optional
448 Coupon string `url:"coupon"` // Optional
449
450 NameServer1 string `url:"ns1"`
451 NameServer2 string `url:"ns2"`
452 NameServer3 string `url:"ns3"`
453 NameServer4 string `url:"ns4"`
454 NameServer5 string `url:"ns5"`
455 NameServer6 string `url:"ns6"`
456 NameServer7 string `url:"ns7"`
457 NameServer8 string `url:"ns8"`
458 NameServer9 string `url:"ns9"`
459 NameServer10 string `url:"ns10"`
460 NameServer11 string `url:"ns11"`
461 NameServer12 string `url:"ns12"`
462 NameServer13 string `url:"ns13"`
463
464 FirstName string `url:"fn"` // Contact Information
465 LastName string `url:"ln"` // Contact Information
466 MailingAddress string `url:"ad"` // Contact Information
467 MailingCity string `url:"cy"` // Contact Information
468 MailingStateProvinceTerritory string `url:"st"` // Contact Information
469 MailingZipPostalCode string `url:"zp"` // Contact Information
470 MailingCountry string `url:"ct"` // Contact Information
471 EmailAddress string `url:"em"` // Contact Information
472 PhoneNumber string `url:"ph"` // Contact Information
473
474 Company string `url:"cp"` // Contact Information
475 MailingAddress2 string `url:"ad2"` // Contact Information
476 Fax string `url:"fx"` // Contact Information
477
478 USNexusCategory string `url:"usnc"` // Contact Information
479 USApplicationPurpose string `url:"usap"` // Contact Information
480
481 ContactID string `url:"contact_id"` // Contact ID
482 }
483
484 // RegisterDomainDropParams Parameters for operation registerDomainDrop.
485 type RegisterDomainDropParams struct {
486 Domain string `url:"domain"` // Required
487 Years int32 `url:"years"` // Required
488
489 Private int32 `url:"private"` // Optional
490 AutoRenew int32 `url:"auto_renew"` // Optional
491 }
492
493 // RegistrantVerificationStatusParams Parameters for operation registrantVerificationStatus.
494 type RegistrantVerificationStatusParams struct{}
495
496 // RemoveAutoRenewalParams Parameters for operation removeAutoRenewal.
497 type RemoveAutoRenewalParams struct {
498 Domain string `url:"domain"` // Required
499 }
500
501 // RemovePrivacyParams Parameters for operation removePrivacy.
502 type RemovePrivacyParams struct {
503 Domain string `url:"domain"` // Required
504 }
505
506 // RenewDomainParams Parameters for operation renewDomain.
507 type RenewDomainParams struct {
508 Domain string `url:"domain"` // Required
509 Years int32 `url:"years"` // Required
510
511 PaymentID string `url:"payment_id"` // Optional
512 Coupon string `url:"coupon"` // Optional
513 }
514
515 // RetrieveAuthCodeParams Parameters for operation retrieveAuthCode.
516 type RetrieveAuthCodeParams struct {
517 Domain string `url:"domain"` // Required
518 }
519
520 // TransferDomainParams Parameters for operation transferDomain.
521 type TransferDomainParams struct {
522 Domain string `url:"domain"` // Required
523
524 PaymentID string `url:"payment_id"` // Optional
525 Auth string `url:"auth"` // Optional
526 Private int32 `url:"private"` // Optional
527 AutoRenew int32 `url:"auto_renew"` // Optional
528 Portfolio string `url:"portfolio"` // Optional
529 Coupon string `url:"coupon"` // Optional
530
531 FirstName string `url:"fn"` // Contact Information
532 LastName string `url:"ln"` // Contact Information
533 MailingAddress string `url:"ad"` // Contact Information
534 MailingCity string `url:"cy"` // Contact Information
535 MailingStateProvinceTerritory string `url:"st"` // Contact Information
536 MailingZipPostalCode string `url:"zp"` // Contact Information
537 MailingCountry string `url:"ct"` // Contact Information
538 EmailAddress string `url:"em"` // Contact Information
539 PhoneNumber string `url:"ph"` // Contact Information
540
541 Company string `url:"cp"` // Contact Information
542 MailingAddress2 string `url:"ad2"` // Contact Information
543 Fax string `url:"fx"` // Contact Information
544
545 USNexusCategory string `url:"usnc"` // Contact Information
546 USApplicationPurpose string `url:"usap"` // Contact Information
547
548 ContactID string `url:"contact_id"` // Contact ID
549 }
550
551 // TransferUpdateChangeEPPCodeParams Parameters for operation transferUpdateChangeEPPCode.
552 type TransferUpdateChangeEPPCodeParams struct {
553 Domain string `url:"domain"` // Required
554 Auth string `url:"auth"` // Required
555 }
556
557 // TransferUpdateResendAdminEmailParams Parameters for operation transferUpdateResendAdminEmail.
558 type TransferUpdateResendAdminEmailParams struct {
559 Domain string `url:"domain"` // Required
560 }
561
562 // TransferUpdateResubmitToRegistryParams Parameters for operation transferUpdateResubmitToRegistry.
563 type TransferUpdateResubmitToRegistryParams struct {
564 Domain string `url:"domain"` // Required
565 }
566
567 // ViewAuctionParams Parameters for operation viewAuction.
568 type ViewAuctionParams struct {
569 AuctionID string `url:"auctionId"` // Required
570 }
571
572 // ViewAuctionsParams Parameters for operation viewAuctions.
573 type ViewAuctionsParams struct {
574 AuctionIDs []string `url:"auctionIds,brackets"`
575 }
576
577 // ViewAuctionHistoryParams Parameters for operation viewAuctionHistory.
578 type ViewAuctionHistoryParams struct {
579 AuctionID string `url:"auctionId"` // Required
580 }
581
582 // WatchAuctionParams Parameters for operation watchAuction.
583 type WatchAuctionParams struct {
584 AuctionID string `url:"auctionId"` // Required
585 Watch string `url:"watch"` // Required
586 }
587
588 // WhoisInfoParams Parameters for operation whoisInfo.
589 type WhoisInfoParams struct {
590 Domain string `url:"domain"` // Required
591 }
592