forked from InterNetX/js-domainrobot-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.d.ts
5254 lines (4906 loc) · 165 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export type TestType = 'blub'
export declare class DomainRobotService<T> {
constructor(domainRobotConfig: domainRobotConfig);
logRequest(callback: Function): T;
logResponse(callback: Function): T;
headers(headers: { [key: string]: string | number }): T;
mockResponse(response: Result): T;
}
export declare class CertificateService extends DomainRobotService<CertificateService>{
create(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
createDocumentSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
createCodeSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
createVMC(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
createRealtime(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataCertificate, number>>;
prepareOrder(model: DomainRobotModels.CertificateData): Promise<DomainRobotResult<JsonResponseDataCertificateData, number>>;
list(odel: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataCertificate, number>>;
info(id: number): Promise<DomainRobotResult<JsonResponseDataCertificate, number>>;
reissue(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
reissueDocumentSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
reissueCodeSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
reissueVMC(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
delete(id: number): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
renew(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
renewDocumentSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
renewCodeSigning(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
renewVMC(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
comment(model: DomainRobotModels.Certificate): Promise<DomainRobotResult<JsonResponseDataVoid, number>>;
convertCertificateToCertificateData(model: DomainRobotModels.Certificate): DomainRobotModels.CertificateData;
}
export declare class ContactService extends DomainRobotService<ContactService> {
create(model: DomainRobotModels.Contact): Promise<DomainRobotResult<JsonResponseDataContact, number>>;
update(model: DomainRobotModels.Contact): Promise<DomainRobotResult<JsonResponseDataContact, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataContact, number>>;
info(id: number): Promise<DomainRobotResult<JsonResponseDataContact, number>>;
delete(id: number): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
verificationInfo(reference: string): Promise<DomainRobotResult<JsonResponseDataContactVerification, number>>;
verificationConfirm(model: DomainRobotModels.ContactVerification): Promise<DomainRobotResult<JsonResponseDataContactVerification, number>>;
}
export declare class DomainService extends DomainRobotService<DomainService> {
create(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
update(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
transfer(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
updateStatus(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
renew(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
restore(model: DomainRobotModels.Domain): Promise<DomainRobotResult<JsonResponseDataObjectJob, number>>;
restoreList(model: DomainRobotModels.Domain, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataDomainRestore, number>>;
info(name: string): Promise<DomainRobotResult<JsonResponseDataDomain, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataDomain, number>>;
authInfo1Create(name: string): Promise<DomainRobotResult<JsonResponseDataDomain, number>>;
authInfo1Delete(name: string): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
authInfo2Create(name: string): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
cancelationCreate(model: DomainRobotModels.DomainCancelation): Promise<DomainRobotResult<JsonResponseDataDomainCancelation, number>>;
cancelationUpdate(model: DomainRobotModels.DomainCancelation): Promise<DomainRobotResult<JsonResponseDataDomainCancelation, number>>;
cancelationDelete(name: string): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
cancelationInfo(name: string): Promise<DomainRobotResult<JsonResponseDataDomainCancelation, number>>;
cancelationList(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataDomainCancelation, number>>;
}
export declare class SslContactService extends DomainRobotService<SslContactService>{
create(model: DomainRobotModels.SslContact): Promise<DomainRobotResult<JsonResponseDataSslContact, number>>;
update(model: DomainRobotModels.SslContact): Promise<DomainRobotResult<JsonResponseDataSslContact, number>>;
delete(id: number): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
info(id: number): Promise<DomainRobotResult<JsonResponseDataSslContact, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataSslContact, number>>;
}
export declare class ZoneService extends DomainRobotService<ZoneService>{
create(model: DomainRobotModels.Zone): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
update(model: DomainRobotModels.Zone, systemNameServer: string): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
delete(name: string, systemNameServer: string): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
info(name: string, systemNameServer: string): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
stream(name: string, model: DomainRobotModels.ZoneStream, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
import(name: string, model: DomainRobotModels.Zone, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataZone, number>>;
}
export declare class TradeMarkService extends DomainRobotService<TradeMarkService>{
get(reference: string): Promise<DomainRobotResult<JsonResponseDataContactTmchMark, number>>;
}
export declare class PollService extends DomainRobotService<PollService>{
info(): Promise<DomainRobotResult<JsonResponseDataPollMessage, number>>;
confirm(id: number): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
}
export declare class TransferOutService extends DomainRobotService<TransferOutService>{
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataTransferOut, number>>;
answer(domain: string, type: string): Promise<DomainRobotResult<JsonResponseDataTransferOut, number>>;
}
export declare class TrustedAppService extends DomainRobotService<TrustedAppService>{
create(model: DomainRobotModels.TrustedApplication): Promise<DomainRobotResult<JsonResponseDataTrustedApplication, number>>;
update(model: DomainRobotModels.TrustedApplication): Promise<DomainRobotResult<JsonResponseDataTrustedApplication, number>>;
delete(id: number): Promise<DomainRobotResult<JsonResponseDataJsonNoData, number>>;
info(id: number): Promise<DomainRobotResult<JsonResponseDataTrustedApplication, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataTrustedApplication, number>>;
}
export declare class DomainStudio extends DomainRobotService<DomainStudio>{
search(model: DomainRobotModels.DomainEnvelopeSearchRequest): Promise<DomainRobotResult<JsonResponseDataDomainEnvelope, number>>;
}
export declare class LoginService extends DomainRobotService<LoginService> {
sessionID(model: DomainRobotModels.LoginData, queryParams?: {
acl?: Boolean;
profile?: Boolean;
customer?: Boolean;
timeout?: number;
}): Promise<DomainRobotResult<JsonResponseDataUser, number>>;
}
export declare class UserService extends DomainRobotService<LoginService> {
create(model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
update(model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
delete(user: string, context: number): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
info(user: string, context: number, queries?: string[]): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
list(model: DomainRobotModels.Query, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
newPassword(model: DomainRobotModels.NewPassword): Promise<DomainRobotResult<JsonResponseDataVoid, number>>;
newPasswordVerify(token: string): Promise<DomainRobotResult<JsonResponseDataVoid, number>>;
ssoActionVerifiy(token: string): Promise<DomainRobotResult<JsonResponseDataUser, number>>;
userActionVerifiy(token: string): Promise<DomainRobotResult<JsonResponseDataUser, number>>;
billingObjectLimitInfo(keys?: string[], articleTypes?: string[]): Promise<DomainRobotResult<JsonResponseDataBillingLimit, number>>;
billingObjectTermsInfo(): Promise<DomainRobotResult<JsonResponseDataBillingObjectTerms, number>>;
updateLock(user: string, context: number, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
updateUnLock(user: string, context: number, keys?: string[]): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
aclInfo(user: string, context: number): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
aclUpdate(model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
copy(user: string, context: number, model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataBasicUser, number>>;
profileInfo(user: string, context: number, prefix?: string): Promise<DomainRobotResult<JsonResponseDataUserProfileViews, number>>;
profileUpdate(model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataUserProfileViews, number>>;
serviceProfileInfo(user: string, context: number, prefix?: string): Promise<DomainRobotResult<JsonResponseDataServiceUsersProfile, number>>;
serviceProfileUpdate(model: DomainRobotModels.User): Promise<DomainRobotResult<JsonResponseDataServiceUsersProfile, number>>;
}
export declare class WhoisService extends DomainRobotService<WhoisService>{
single(domain: string): Promise<DomainRobotResult<JsonResponseDataDomainEnvelope, number>>;
multi(domains: Array<string>): Promise<DomainRobotResult<JsonResponseDataDomainEnvelope, number>>;
}
export declare class DomainRobotResult<Result, Number> {
constructor(result: Result, status: Number);
isValid(): Boolean;
isValidResponse(): Boolean;
getHeaders(): ResultHeaders;
}
export interface DomainRobotResult<Result, Number> {
result: Result;
status: Number;
}
export interface ResultHeaders {
connection?: string;
date?: string;
server?: string;
'set-cookie'?: Array<string>;
'content-length'?: string;
'content-type'?: string;
'content-language'?: string;
'x-domainrobot-sessionid'?: string;
'x-domainrobot-stid'?: string;
}
export interface DomainRobotException {
type: string
error: {
stid: string;
// messages can vary depending on the task, so this is the closest
// defintion we can provide here
messages: Array<{
code: string;
text: string;
type: string;
}>;
status: {
code: string;
text: string;
type: string;
};
ctid: string;
};
status: number;
}
export interface ResponseStatus {
code: string;
text: string;
type: string;
object?: ResponseObject
objects?: ResponseObject[]
}
export interface ResponseObject {
type: string;
value: string;
summary?: number;
data?: string;
}
export interface Result {
stid: string;
status: ResponseStatus;
object?: ResponseObject;
ctid?: string;
data: Array<object | string>;
messages?: DomainRobotModels.Message[];
}
export interface BulkResponse<T>{
status: string
uniqEventId: string
data: {
response: T
isFinished?: boolean
}
}
export interface BulkError extends BulkResponse<DomainRobotException>{}
export interface BulkResult<T> extends BulkResponse<DomainRobotResult<T, number>>{}
// Service Response Definitions
export interface JsonResponseDataAccountingDocument extends Result {
data: DomainRobotModels.AccountingDocument[];
}
export interface JsonResponseDataContact extends Result {
data: DomainRobotModels.Contact[];
}
export interface JsonResponseDataCustomer extends Result {
data: DomainRobotModels.Customer[];
}
export interface JsonResponseDataBasicCustomer extends Result {
data: DomainRobotModels.BasicCustomer[];
}
export interface JsonResponseDataCustomerStatistics extends Result {
data: DomainRobotModels.CustomerStatistics;
}
export interface JsonResponseDataCustomerGroup extends Result {
data: DomainRobotModels.CustomerGroup[];
}
export interface JsonResponseDataDomain extends Result {
data: DomainRobotModels.Domain[];
}
export interface JsonResponseDataBasicUser extends Result {
data: DomainRobotModels.BasicUser[];
}
export interface JsonResponseDataBillingEvent extends Result {
data: DomainRobotModels.BillingEvent[];
}
export interface JsonResponseDataBillingEventBulk extends Result {
data: DomainRobotModels.BillingEvent[][];
}
export interface JsonResponseDataBillingLimit extends Result {
data: DomainRobotModels.BillingLimit[];
}
export interface JsonResponseDataBillingObjectTerms extends Result {
data: DomainRobotModels.BillingObjectTerms[];
}
export interface JsonResponseDataObjectJob extends Result {
data: DomainRobotModels.ObjectJob[];
}
export interface JsonResponseDataDomainRestore extends Result {
data: DomainRobotModels.DomainRestore[];
}
export interface JsonResponseData extends Result {
data: DomainRobotModels.JsonResponseData[];
}
export interface JsonResponseDataJsonNoData extends Result {
data: DomainRobotModels.JsonNoData[];
}
export interface JsonResponseDataInvoice extends Result {
data: DomainRobotModels.Invoice[];
}
export interface JsonResponseDataDomainCancelation extends Result {
data: DomainRobotModels.DomainCancelation[];
}
export interface JsonResponseDataCertificate extends Result {
data: DomainRobotModels.Certificate[];
}
export interface JsonResponseDataCertificateData extends Result {
data: DomainRobotModels.CertificateData[];
}
export interface JsonResponseDataVoid extends Result {
data: DomainRobotModels.Void[];
}
export interface JsonResponseDataSslContact extends Result {
data: DomainRobotModels.SslContact[];
}
export interface JsonResponseDataZone extends Result {
data: DomainRobotModels.Zone[];
}
export interface JsonResponseDataPeriodicBilling extends Result {
data: DomainRobotModels.PeriodicBilling[];
}
export interface JsonResponseDataPollMessage extends Result {
data: DomainRobotModels.PollMessage[];
}
export interface JsonResponseDataListJsonResponseDataPrice extends Result {
data: DomainRobotModels.JsonResponseDataPrice[];
}
export interface JsonResponseDataPrice extends Result {
data: DomainRobotModels.Price[];
}
export interface JsonResponseDataPurchasePriceClass extends Result {
data: DomainRobotModels.PurchasePriceClass[];
}
export interface JsonResponseDataTransferOut extends Result {
data: DomainRobotModels.TransferOut[];
}
export interface JsonResponseDataTrustedApplication extends Result {
data: DomainRobotModels.TrustedApplication[];
}
export interface JsonResponseDataDomainEnvelope extends Result {
data: DomainRobotModels.DomainEnvelope[];
}
export interface JsonResponseDataUser extends Result {
data: DomainRobotModels.User[];
}
export interface JsonResponseDataUserProfileViews extends Result {
data: DomainRobotModels.UserProfileViews[];
}
export interface JsonResponseDataServiceUsersProfile extends Result {
data: DomainRobotModels.ServiceUsersProfile[];
}
export interface JsonResponseDataSubjectProduct extends Result {
data: DomainRobotModels.SubjectProduct[];
}
export interface JsonResponseDataSubjectProductBulk extends Result {
data: DomainRobotModels.SubjectProduct[][];
}
export interface JsonResponseDataContactVerification extends Result {
data: DomainRobotModels.ContactVerification[];
}
export interface JsonResponseDataContactTmchMark extends Result {
data: DomainRobotModels.TmchMark[];
}
export interface JsonResponseDataTld extends Result {
data: DomainRobotModels.Tld[];
}
export interface JsonResponseDataTldGrouped extends Result {
data: DomainRobotModels.TldGrouped[];
}
export interface MockResponse {
data: Result,
status: number
}
export type domainRobotConfig = {
url?: string;
logRequestCallback?: Function,
logResponseCallback?: Function,
session_id?: string,
auth?: {
user: string;
password: string;
context?: number;
};
isMockRequest?: boolean
mockResponse?: undefined | MockResponse
headers?: { [key: string]: string}
};
export class DomainRobot {
constructor(domainRobotConfig: domainRobotConfig);
certificate(certificateModel?: DomainRobotModels.Certificate): CertificateService;
contact(contactModel?: DomainRobotModels.Contact): ContactService;
domain(): DomainService;
domainStudio(domainStudioEnvelopeSearchRequest: DomainRobotModels.DomainEnvelopeSearchRequest): DomainStudio;
poll(): PollService;
sslcontact(sslcontactModel?: DomainRobotModels.SslContact): SslContactService;
transferout(): TransferOutService;
trustedapp(trustedAppModel?: DomainRobotModels.TrustedApplication): TrustedAppService;
zone(zoneModel?: DomainRobotModels.Zone): ZoneService;
login(loginDataModel?: DomainRobotModels.LoginData): LoginService;
user(basicUserModel?: DomainRobotModels.BasicUser): UserService;
whois(): WhoisService;
tmch(): TradeMarkService;
}
export const DomainRobotHeaders: {
DOMAINROBOT_CONTENT_TYPE: string;
DOMAINROBOT_HEADER_2FA_TOKEN: string;
DOMAINROBOT_HEADER_BULK_LIMIT: string;
DOMAINROBOT_HEADER_CONTEXT: string;
DOMAINROBOT_HEADER_CTID: string;
DOMAINROBOT_HEADER_CUSTOMER: string;
DOMAINROBOT_HEADER_DEMO_MODE: string;
DOMAINROBOT_HEADER_DOMAINROBOT_STID: string;
DOMAINROBOT_HEADER_OWNER: string;
DOMAINROBOT_HEADER_OWNER_CONTEXT: string;
DOMAINROBOT_HEADER_OWNER_NAME: string;
DOMAINROBOT_HEADER_PIN: string;
DOMAINROBOT_HEADER_PRECEDENCE: string;
DOMAINROBOT_HEADER_PROFILE: string;
DOMAINROBOT_HEADER_SESSION_ID: string;
DOMAINROBOT_HEADER_SESSION_USER: string;
DOMAINROBOT_HEADER_WEBSOCKET: string;
DOMAINROBOT_HEADER_WEBSOCKET_TARGET: string;
DOMAINROBOT_USER_AGENT: string;
DOMAINROBOT_HEADER_DEMO: string;
};
// ENUM definitions
export type AccountingDocumentTypeConstants = "INVOICE" | "CREDIT" | "REFUND" | "CANCELED" | "CHARGE";
export type AccountStatusConstants = "SUCCESS" | "CANCELED" | "RESERVED" | "RESERVATION";
export type AuEligibilityIdTypeConstants = "ACN" | "ABN" | "VIC" | "NSW" | "SA" | "BN" | "NT" | "WA" | "TAS" | "ACT" | "QLD" | "TM" | "OTHER";
export type AuEligibilityTypeConstants = "COMPANY" | "REGISTERED_BUSINESS" | "SOLE_TRADER" | "PARTNERSHIP" | "TRADEMARK_OWNER" | "PENDING_TM_OWNER" | "CITIZEN_RESIDENT" | "INCORPORATED_ASSOCIATION" | "UNINCORPORATED_ASSOCIATION" | "CLUB" | "NON_PROFIT_ORGANISATION" | "CHARITY" | "TRADE_UNION" | "INDUSTRY_BODY" | "COMMERCIAL_STATUTORY_BODY" | "POLITICAL_PARTY" | "RELIGIOUS_CHURCH_GROUPS" | "OTHER" | "REGISTRABLE_BODY" | "INDIGENOUS_CORPORATION" | "REGISTERED_ORGANISATION" | "COOPERATIVE" | "TRUST" | "EDUCATIONAL_INSTITUTION" | "COMMONWEALTH_ENTITY" | "STATUTORY_BODY" | "TRADING_COOPERATIVE" | "COMPANY_LIMITED_BY_GUARANTEE" | "NON_DISTRIBUTING_COOPERATIVE" | "NON_TRADING_COOPERATIVE" | "CHARITABLE_TRUST" | "PUBLIC_PRIVATE_ANCILLARY_FUND" | "PEAK_STATE_TERRITORY_BODY" | "NOT_FOR_PROFIT_COMMUNITY_GROUP" | "FOREIGN_EMBASSY_OR_CONSULATE";
export type AuRegistrantIdTypeConstants = "ACN" | "ABN" | "OTHER" | "TAS" | "VIC" | "NSW" | "ACT" | "QLD" | "NT" | "WA" | "SA";
export type AuthMethodConstants = "DNS" | "EMAIL" | "FILE" | "ORG";
export type AuthType = "PASSWORD" | "PASSWORD_TOKEN" | "ALIAS";
export type AuthenticateStatus = "COMPLETED" | "ADDITIONAL_INFORMATION_REQUIRED" | "IN_PROGRESS" | "COMMUNICATION_SENT_TO_CUSTOMER" | "ATTEMPTED_TO_REACH_CUSTOMER" | "PENDING_CUSTOMER_APPROVAL" | "NOT_COMPLETED" | "COMPLETED_PASSED" | "COMPLETED_FAILED" | "UNABLE_TO_COMPLETE" | "NOT_STARTED";
export type AuthenticationStep = "DOMAIN_VERIFICATION" | "VERIFICATION_CALL" | "ORGANIZATION_VERIFICATION" | "CONSUMER_AUTHENTICATION" | "CERTIFICATE" | "CONTACT_CONFIRMED" | "VERIFICATION" | "CSR_CHECK" | "DCV_CHECK" | "OV_CALLBACK" | "FREE_DVUP" | "EV_CLICKTROUGH";
export type AutoDeleteStatus = "CONFIRMED" | "DELETED" | "NOTIFY" | "NOTIFY_5" | "NOTIFY_10" | "NOTIFY_15" | "NOTIFY_20" | "NOTIFY_30" | "NOTIFY_35" | "NOTIFY_45" | "PENDING" | "RENEWED" | "RESTORED" | "CANCELED";
export type AutoRenewStatusConstants = "TRUE" | "FALSE" | "ONCE";
export type BillingStatus = "ADD" | "REMOVE" | "UPDATE" | "IGNORE" | "CUSTOMER_CHANGED" | "USER_CHANGED" | "UPGRADE" | "ACTIVE" | "CANCELED" | "CANCELED_EXPIRE" | "RESTORE" | "AUTODELETE" | "REMOVED" | "DROP";
export type BusinessCategory = "PRIVATE_ORGANIZATION" | "GOVERNMENT_ENTITY" | "BUSINESS_ENTITY";
export type CancelationStatusConstants = "DELETE" | "DELETE_EXPIRE" | "TRANSIT" | "TRANSIT_EXPIRE" | "PREACK" | "PREACK_EXPIRE";
export type CancelationTypeConstants = "DELETE" | "TRANSIT" | "PREACK";
export type CardStatus = "LOST" | "EXPIRED" | "ACTIVE";
export type CertificateTransparencyPrivacyConstants = "PUBLIC" | "REDACTED";
export type CertificateType = "FQDN" | "MAIL" | "CODE";
export type CiraCprConstants = "CCT" | "RES" | "CCO" | "ABO" | "TDM" | "MAJ" | "GOV" | "LGR" | "TRS" | "PRT" | "ASS" | "TRD" | "PLT" | "EDU" | "LAM" | "HOP" | "INB" | "OMK";
export type CnAuditDocumentType = "ID_CARD" | "PASSPORT" | "CN_MAINLAND_TRAVEL_PERMIT_HK_MO" | "CN_MAINLAND_TRAVEL_PERMIT_TW" | "PERMANENT_RESIDENCE_PERMIT_FOREIGNERS" | "CN_RESIDENCE_PERMIT_HK_MO" | "CN_RESIDENCE_PERMIT_TW" | "MILITARY_ID_CARD" | "OTHER_ID_CARD" | "CN_ORG_ID" | "CN_BUSINESS_ID" | "CN_SOCIAL_CREDIT_LICENCE" | "MILITARY_UNIT_CODE" | "MILITARY_UNIT_EXTERNAL_PERMIT" | "INSTITUION_LEGAL_PERSON" | "CN_FOREIGN_ENTERPRISE_REGISTRATION" | "SOCIAL_ORG_LEGAL_PERSON" | "RELIGIOS_ACTIVITY" | "PRIVATE_NON_ENTERPRISE_REGISTRATION" | "FOUNDATION_LEGAL_PERSON" | "LAW_FIRM_LICENCE" | "CN_FOREIGN_CULTURAL_CENTER" | "CN_FOREIGN_TOURISM_DEPARTMENT_REGISTRATION" | "FORENSIC_EXPERTISE_LICENCE" | "SOCIAL_AGENCY_CERTIFICATE" | "PRIVATE_SCHOOL_PERMIT" | "MEDICAL_INSTITUION_LICENCE" | "NOTARY_ORG_LICENCE" | "CN_FOREIGN_EMBASSY_CHILDREN_PERMIT_BEIJING" | "OTHER_ORG_DOC" | "ORG_CERTIFICATE";
export type ClearAccountPeriod = "DAY" | "MONTH" | "BILL" | "WEEK" | "NONE";
export type CodeSigningType = "JAVASOFT" | "MS_AUTHENTICODE" | "VBA" | "ADOBE_AIR" | "APPLE";
export type CommonLogSource = "SMTP" | "HTTP" | "EPP" | "DAEMON" | "AUTODNS2" | "IRTP" | "JOB" | "WHOIS" | "AXFR" | "VIGO" | "SWEB" | "SCHLUND_TECH" | "ISAC" | "PHOENIX" | "DOMAINROBOT" | "OTHER";
export type ConditionType = "AND" | "OR";
export type ContactProtectionConstants = "SHOW_ALL" | "SHOW_NONE";
export type ContactReferenceType = "ALL" | "OWNERC" | "ADMINC" | "TECHC" | "ZONEC" | "BILLINGC";
export type ContactType = "PRIMARY" | "BILLING" | "TECH" | "LEGAL" | "DOMAIN" | "SSL" | "SERVER" | "ABUSE";
export type ContactTypeConstants = "PERSON" | "ORG" | "ROLE";
export type CreditCardVendor = "MC" | "VISA" | "AMEX" | "DIC" | "DISC" | "CB";
export type CryptoFormatConstants = "SHA1" | "SHA256" | "SHA512";
export type CustomerType = "PERSON" | "ORGANIZATION";
export type CodeSigningProvisioningMethod = "EMAIL" | "SOFTWARE" | "SHIPPING";
export type CodeSigningHardwarePlatform = "AEP_KEYPER" | "ARX_PRIVATE_SERVER" | "BULL_TRUSTWAY_CRYPTO_PCI" | "E_PASS_3003" | "SAFE_NET_E_TOKEN_5100" | "SAFE_NET_E_TOKEN_5105" | "SAFE_NET_E_TOKEN_5110" | "SAFE_NET_E_TOKEN_5110_FIPS" | "SAFE_NET_E_TOKEN_5200" | "SAFE_NET_E_TOKEN_5205" | "SAFE_NET_E_TOKEN_PRO_72K" | "SAFE_NET_E_TOKEN_PRO_ANYWHERE" | "SAFE_NET_I_KEY_4000" | "SAFE_NET_LUNA" | "THALES_N_SHIELD" | "ULTIMACO_CRYPTO_SERVER" | "OTHER";
export type CsrHashAlgorithmConstants = "ECC" | "RSA" | "DSA";
export type DcvValidationScope = "FQDN" | "BASEDOMAIN";
export type DigiCertCodeSigningHardwarePlatform = "SAFE_NET_E_TOKEN_5110_FIPS" | "SAFE_NET_E_TOKEN_5110_CC" | "SAFE_NET_E_TOKEN_5110_PLUS_FIPS" | "OTHER";
export type DigiCertCodeSigningProvisioningMethod = "SOFTWARE" | "SHIPPING";
export type DNSCheck = "SOA" | "NS" | "ALL" | "NONE";
export type DeliveryStatus = "PENDING" | "SUCCESS" | "FAILED" | "EXPIRED" | "ATTEMPTING" | "PARTIAL";
export type DocumentTypeConstants = "TM_LICENSEE_DECL" | "TM_ASSIGNEE_DECL" | "TM_OTHER" | "DECL_PROOF_OF_USE_ONE_SAMPLE" | "PROOF_OF_USE_OTHER" | "COPY_OF_COURT_ORDER" | "TMCH_AGENT_AUTHORISATION_FORM" | "TM_OTHER_COPY_OF_TM_CERTIFICATE" | "TM_OTHER_COPY_OF_RENEWAL_REQUEST" | "TM_OTHER_COPY_OF_TREATY_OR_STATUTE" | "TM_OTHER_COPY_OF_CERTIFICATE";
export type DomainActionConstants = "CREATE" | "UPDATE" | "UPDATE_OWNER_CHANGE" | "UPDATE_DNSSEC" | "UPDATE_NAMESERVER" | "DELETE" | "TRANSIT" | "TRANSFER" | "TRANSFER_INTERN" | "TRANSFER_INTERN_REGISTRAR_CHANGE" | "TRANSFER_INTERN_REGISTRAR_CHANGE_RUNTIME_TAKEOVER" | "IMPORT" | "MIGRATE" | "RESTORE" | "RESTORE_NE" | "RESTORE_RENEW" | "RESTORE_ARGP" | "RENEW" | "AUTHINFO" | "AUTHINFO_2" | "UPDATE_STATUS" | "REGISTRAR_UPDATE_STATUS" | "UPDATE_COMMENT" | "AUTOUPDATE_DNS" | "OWNERCHANGE" | "OWNERCHANGE_TRANSFER" | "OWNERCHANGE_TRANSFER_INTERN" | "OWNERCHANGE_TRANSFER_INTERN_REGISTRAR_CHANGE" | "PREACK" | "WHOIS_REGISTRY_STATUS" | "DOMAIN_AWAY" | "TRANSFER_OUT_AUTOACK" | "DROP" | "AUTHINFO_CREATE" | "AUTHINFO_DELETE" | "AUTOUPDATE_DEFERRED" | "DOMAIN_BUY";
export type DomainEnvelopeSearchService = "WHOIS" | "PRICE" | "ESTIMATION";
export type DomainPreregStatusConstants = "PENDING" | "PENDING_SENT" | "PENDING_DOCUMENT_SENT" | "PENDING_PROGRESS" | "PENDING_UPDATE" | "PENDING_SENT_UPDATE" | "TIMEOUT" | "ACCEPT" | "DECLINE" | "INVALID_NAME" | "FAILED" | "CANCEL" | "AUTO_CANCEL" | "ACTIVE" | "SENT" | "OPEN" | "TMCH_CLAIM" | "TMCH_CLAIM_CONFIRMED" | "TMCH_CLAIM_REJECTED" | "TMCH_CLAIM_EXPIRED" | "TMCH_CLAIM_PENDING" | "TMCH_CLAIM_FAILED" | "FAILED_REF";
export type DomainStudioDomainSource = "INITIAL" | "SUGGESTION" | "PREMIUM" | "GEO" | "SIMILAR" | "RECOMMENDED" | "CUSTOM" | "ONLINE_PRESENCE" | "SPIN_WORD" | "PERSONAL_NAMES" | "UPCOMING";
export type DomainStudioDomainStatus = "FREE" | "ASSIGNED" | "MARKET" | "PREMIUM" | "INVALID" | "ERROR" | "TIMEOUT" | "RESERVED" | "PREMIUM_CLAIM" | "CLAIM";
export type DomainStudioServiceStatus = "RUNNING" | "SUCCESS" | "FAILED" | "TIMEOUT";
export type ExchangeCurrency = 'EUR' | 'USD' | 'GBP' | 'CNY' | 'JPY' | 'CHF';
export type ExecutionTypeConstants = "DATE" | "EXPIRE" | "NOW";
export type GenderConstants = "RUNNING" | "SUCCESS" | "FAILED" | "TIMEOUT";
export type GenericStatusConstants = "PENDING" | "SUCCESS" | "FAILED" | "NOT_SET";
export type GlobalSignPickupMethod = "EDGE_IE_COMPATIBILITY_MODE" | "FORTIFY";
export type HkDocumentTypeConstants = "HKID" | "OTHID" | "PASSNO" | "BIRTHCERT" | "OTHIDV" | "BR" | "CI" | "CRS" | "HKSARG" | "HKORDINANCE" | "OTHORG";
export type HkIndustryTypeConstants = "_0" | "_010100" | "_010200" | "_010300" | "_010400" | "_010500" | "_020100" | "_020200" | "_020300" | "_020400" | "_020500" | "_030100" | "_030200" | "_040100" | "_040200" | "_040300" | "_040400" | "_040500" | "_040600" | "_040700" | "_050100" | "_050200" | "_050300" | "_050400" | "_050500" | "_050600" | "_050700" | "_060100" | "_060200" | "_060300" | "_070100" | "_070200" | "_070300" | "_070400" | "_070500" | "_070600" | "_070700" | "_070800" | "_070900" | "_080100" | "_080200" | "_080300" | "_080400" | "_080500" | "_080600" | "_080700" | "_080800" | "_080900" | "_081000" | "_081100" | "_090100" | "_090200" | "_090300" | "_090400" | "_090500" | "_100100" | "_100200" | "_100300" | "_100400" | "_100500" | "_110100" | "_110200" | "_110300" | "_110400" | "_110500" | "_110600" | "_120100" | "_120200" | "_120300" | "_120400" | "_120500" | "_120600" | "_120700" | "_120800" | "_120900" | "_130100" | "_130200" | "_130300" | "_130400" | "_130500" | "_130600" | "_130700" | "_130800" | "_140101" | "_140102" | "_140103" | "_140200" | "_140300" | "_140400" | "_140500" | "_140600" | "_140700";
export type Id4MeAgentStatus = "PENDING" | "PENDING_SSL" | "PENDING_SSL_VERIFY" | "SUCCESS" | "FAILED";
export type IdentityStatus = "VERIFY" | "SUCCESS";
export type InvoiceStatusConstants = "CREATED" | "SIGNED" | "SENT" | "RESEND" | "FINISHED" | "LIVECONFIRMED" | "LIVEPENDING" | "POSTPENDING" | "POSTCONFIRMED";
export type IpRestrictionTypeConstants = "CLONE" | "USER" | "CONTEXT";
export type ItEntityTypeConstants = "ITALIAN_AND_FOREIGN_NATURAL_PERSONS" | "ITALIAN_COMPANIES_ONE_MAN_COMPANIES" | "ITALIAN_FREELANCE_WORKERS_PROFESSIONALS" | "ITALIAN_NON_PROFIT_ORGANIZATIONS" | "ITALIAN_PUBLIC_ORGANIZATIONS" | "ITALIAN_OTHER_SUBJECTS" | "FOREIGN_NON_NATURAL_PERSONS";
export type IeEntityTypeConstants = "COM" | "OTH";
export type JobStatusConstants = "RUNNING" | "SUCCESS" | "FAILED" | "CANCELED" | "SUPPORT" | "DEFERRED" | "NOT_SET" | "WAIT";
export type MessageTypeConstants = "INITIAL" | "FIRST_REMINDER" | "SECOND_REMINDER" | "LAST_REMINDER";
export type ModifierConstants = "TTL" | "MX" | "A" | "AAAA" | "SOA_EMAIL" | "NSERVER" | "CNAME" | "TXT" | "ALL" | "MAIN_IP" | "OWNERC" | "ADMINC" | "TECHC" | "ZONEC" | "BILLINGC" | "ALIAS";
export type NameserverActionConstants = "PRIMARY" | "SECONDARY" | "COMPLETE" | "HIDDEN" | "NONE" | "AUTO";
export type NameServerMode = "MASTER" | "SLAVE" | "MASTER_SLAVE" | "COMPLETE" | "ANYCAST"
export type NiccomSourceConstants = "NIC_REQUEST" | "NIC_RESPONSE" | "NIC_NOTIFY" | "A3_REQUEST" | "A3_RESPONSE";
export type ObjectAssignmentMode = "ASSIGN" | "DELETE";
export type ObjectStatus = "SPOOL" | "REQUEST" | "PENDING_NOTIFY" | "PENDING" | "FAILED" | "SUCCESS" | "PENDING_DOMAIN" | "CONNECT";
export type Operator = "EQUAL" | "NOT_EQUAL" | "NOT_LIKE" | "LIKE" | "ILIKE" | "GREATER" | "GREATER_EQUAL" | "LESS" | "LESS_EQUAL" | "IS_NULL" | "IS_NOT_NULL" | "IN";
export type OrderType = "DESC" | "ASC";
export type ParkingProviderConstants = "SEDO" | "NAMEDRIVE" | "PARKINGCREW";
export type ParkingDomainStatus = "SUCCESS" | "PENDING" | "FAILED";
export type ParkingAccountStatus = "ACTIVE" | "PENDING" | "NOT_SET" | "FAILED";
export type ParkingAccountType = "SEDO" | "PARKING_CREW";
export type PaymentConstants = "PRE" | "POST" | "LIVE";
export type PolicyMode = "DISABLED" | "QUARANTINE" | "DISCARD" | "ACCEPT";
export type PriceMarkupType = "PERCENT" | "ABSOLUTE";
export type PriceTypeConstants = "GROSS" | "NET";
export type PriceChangeStatusConstants = "FINISHED" | "PENDING" | "SUCCESS" | "FAILED" | "NOT_SET" | "CONFIRMED";
export type PriceChangeTypeConstants = "CUSTOMER" | "GENERAL" | "GENERAL_DISCOUNT" | "GENERAL_NEW_ARTICLE" | "PROMO" | "PRIMARY";
export type PriceRoundingConstants = "NONE" | "ROUND_X0" | "ROUND_00" | "ROUND_X9" | "ROUND_99" | "ROUND_COMMERCIAL";
export type PriorityConstants = "DEFAULT" | "OFFER" | "PROTECTED" | "PROMO";
export type ProtectionConstants = "HIGH" | "MEDIUM" | "LOW" | "OFF" | "CUSTOM";
export type ProtocolTypeConstants = "TOTP" | "HOTP";
export type Provider = "IPAYMENT" | "PAYPAL";
export type PurgeTypes = "AUTO" | "DISABLED" | "SCHEDULED";
export type RddsOptInConstants = "NOT_SET" | "OWNERC" | "ADMINC" | "OWNERC_ADMINC" | "TECHC" | "OWNERC_TECHC" | "ADMINC_TECHC" | "ALL";
export type RecipientRole = "TO" | "CC" | "BCC";
export type RedirectModeConstants = "CATCHALL" | "FRAME" | "HTTP" | "SINGLE" | "HTTPS";
export type RedirectTypeConstants = "DOMAIN" | "EMAIL";
export type RegistrationTypeConstants = "FCFS" | "APPLICATION" | "OTHER";
export type RegistryStatusConstants = "ACTIVE" | "HOLD" | "LOCK" | "HOLD_LOCK" | "AUTO" | "LOCK_OWNER" | "LOCK_UPDATE" | "PENDING" | "NONE";
export type RelativeConstants = "FIX" | 'RELATIVE_PERCENT' | 'RELATIVE_AMOUNT' | 'DELETE';
export type RenewStatusConstants = "AUTO" | "CANCELED" | "ONCE";
export type RoPersonTypeConstants = "P" | "AP" | "NC" | "C" | "GI" | "PI" | "O";
export type SanType = "FQDN" | "SUBDOMAIN" | "WILDCARD";
export type SectigoHsmType = "YUBIKEY" | "LUNA";
export type SocialMediaPlatform = "FACEBOOK" | "TWITTER" | "PINTEREST" | "YOUTUBE" | "TIKTOK" | "GITHUB" | "TWITCH" | "VIMEO" | "VK";
export type ServerSoftwareTypeConstants = "IIS4" | "IIS5" | "APACHE2" | "APACHESSL" | "PLESK" | "TOMCAT" | "NOT_SET";
export type SignatureHashAlgorithmConstants = "DEFAULT" | "SHA1" | "SHA2" | "SHA2_FULL_CHAIN" | "UNKNOWN" | "SHA384" | "SHA512" | "SHA256" | "SHA384_SHA1" | "SHA256_SHA256" | "SHA256_ECDSA_SHA1" | "SHA384ECDSA_SHA1" | "SHA384_ECDSA_SHA1" | "SHA256_ECDSA_SHA384_ECDSA" | "SHA384_ECDSA_SHA384_ECDSA";
export type StatusType = "SUCCESS" | "ERROR" | "NOTIFY" | "NOTICE" | "NICCOM_NOTIFY";
export type SepaStatus = "ACTIVE" | "UPDATE" | "CANCELED" | "EXPIRED" | "LOCKED" | "REMOVE";
export type TanMethods = "METHOD_EMAIL" | "METHOD_MOBILE" | "METHOD_2FA";
export type TaskGroup = "DOMAIN_CREATE" | "DOMAIN_DELETE" | "DOMAIN_STATUS_UPDATE" | "DOMAIN_TRANSFER_IN" | "DOMAIN_TRANSFER_OUT" | "DOMAINSAFE" | "AUTHINFO_CREATE" | "AUTHINFO_SEND" | "ZONE_CREATE" | "WHOIS" | "DOMAIN_UPDATE" | "DOMAINSTUDIO" | "ZONE_UPDATE" | "ZONE_DELETE" | "ZONE_AXFR";
export type TimeUnitConstants = "MILLISECOND" | "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
export type TldType = "GTLD" | "CCTLD" | "NGTLD";
export type TldContinent = "ASIA" | "AFRICA" | "NORTH_AMERICA" | "SOUTH_AMERICA" | "ANTARCTICA" | "EUROPE" | "OCEANIA" | "GLOBAL";
export type TmchMarkHolderConstants = "OWNER" | "LICENSEE" | "ASSIGNEE";
export type TmchMarkStatusConstants = "OPEN" | "PAYMENT" | "PENDING" | "INCORRECT" | "VERIFIED" | "SENT" | "ACTIVE" | "DEACTIVATED" | "CANCELED" | "RENEW" | "FAILED" | "EXTERNAL" | "PENDING_TRANSFER" | "PENDING_RENEW" | "PENDING_DELETE" | "PENDING_PAYMENT" | "PENDING_TRANSFER_PAYMENT" | "PENDING_RENEW_PAYMENT";
export type TmchMarkTypeConstants = "TRADEMARK" | "TREATY_OR_STATUTE" | "COURT" | "DNL_ABUSED";
export type TransferAnswer = "TRANSFER_OUT_ACK" | "TRANSFER_OUT_NACK";
export type TransferStatusConstants = "NOT_SET" | "START" | "FAILED" | "NACK" | "ACK" | "FOA1_SENT" | "AUTOUPDATE_SUCCESS" | "AUTOUPDATE_FAILED";
export type UkTypeConstants = "LTD" | "PLC" | "PTNR" | "STRA" | "LLP" | "IP" | "IND" | "SCH" | "RCHAR" | "GOV" | "CRC" | "STAT" | "OTHER" | "FIND" | "FCORP" | "FOTHER";
export type UserLock = "NONE" | "CUSTOMER" | "EXPIRED" | "USER";
export type UserProfileFlag = "OPTIONAL" | "FIX" | "RECURSE" | "HIDDEN" | "PARENT_FIX";
export type VmcTrademarkCountryOrRegion = "US" | "CA" | "EM" | "GB" | "DE" | "JP" | "AU" | "ES" | "IN" | "KR" | "BR";
export namespace DomainRobotModels {
export class Account {
constructor(config?: Account);
}
export interface Account {
customer?: GenericCustomer;
currentAccountBalance?: number;
runningTotal?: number;
creditLimit?: number;
currency?: string;
minRunningTotalNotification?: number;
minRunningTotalNotificationEmail?: string;
created?: string;
updated?: string;
view?: CurrencyRate;
reserved?: number;
}
export class AccountingDocument {
constructor(config?: AccountingDocument);
}
export interface AccountingDocument {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
id?: number;
entry?: AccountEntry;
type?: AccountingDocumentTypeConstants;
account?: Account;
subjectProducts?: SubjectProduct;
view?: CurrencyRate;
synchronized?: boolean;
status?: AccountStatusConstants;
invoice?: Invoice;
payment?: PaymentConstants;
parent?: AccountingDocument;
}
export class AccountEntry {
constructor(config?: AccountEntry);
}
export interface AccountEntry {
label?: string;
amount?: number;
vatAmount?: number;
vats?: Vat;
netAmount?: number;
currency?: string;
}
export class AccountManager {
constructor(config?: AccountManager)
}
export interface AccountManager {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
id?: number;
name?: string;
phone?: Phone;
email?: string;
}
export class AdoptExpiration {
constructor(config?: AdoptExpiration)
}
export interface AdoptExpiration {
tlds?: string[];
}
export class AddressClaim {
constructor(config?: AddressClaim);
}
export interface AddressClaim {
formatted?: string;
streetAddress?: string;
locality?: string;
region?: string;
postalCode?: string;
country?: string;
}
export class Article {
constructor(config?: Article);
}
export interface Article {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
type?: string;
category?: ArticleCategory;
label?: string;
}
export class ArticleCategory {
constructor(config?: ArticleCategory);
}
export interface ArticleCategory {
label?: string;
}
export class AuthSession {
constructor(config?: AuthSession);
}
export interface AuthSession {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
language?: string;
configuration?: Configuration;
}
export class Application {
constructor(config?: Application);
}
export interface Application {
created?: string;
updated?: string;
name?: string;
functionCodes?: string[];
}
export class AutoDeleteDomain {
constructor(config?: AutoDeleteDomain);
}
export interface AutoDeleteDomain {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
domain?: Domain;
changed?: string;
nicMemberLabel?: string;
status?: AutoDeleteStatus;
paymentLimit?: string;
payable?: string;
}
export class BackupMx {
constructor(config?: BackupMx);
}
export interface BackupMx {
domain?: string;
idn?: string;
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
}
export class BasicCertificate {
constructor(config?: BasicCertificate)
}
export interface BasicCertificate {
id?: number;
product?: string;
}
export class BasicCustomer {
constructor(config?: BasicCustomer);
}
export interface BasicCustomer {
number?: number;
client?: string;
group?: number;
name?: string;
type?: CustomerType;
organization?: string;
organization2?: string;
vatNumber?: string;
gender?: string;
title?: string;
addressLines?: string[];
city?: string;
state?: string;
country?: string;
phone?: Phone;
fax?: Phone;
emails?: string[];
billingEmails?: string[];
payment?: string;
paymentMode?: string;
paymentCurrency?: Currency;
paymentCurrencyExchangeFee?: number;
discount?: number;
discountNgtld?: number;
discountCertificate?: number;
discountValid?: string;
dataIncorrect?: boolean
invoiceLanguage?: string;
taxable?: boolean;
card?: Card;
contracts?: CustomerContract[];
billingUsers?: BasicUser[];
comments?: Comment[];
contacts?: basicCustomerContact[];
account?: Account;
priceListEntities?: CustomerPriceList[];
addPriceListEntities?: CustomerPriceList[];
remPriceListEntities?: CustomerPriceList[];
clearAccount?: ClearAccountPeriod;
autodelete?: boolean;
pending?: boolean;
verifications?: BasicCustomerSpoolVerification[];
tags?: CustomerTag;
pin?: string;
persistent?: object;
active?: boolean;
fname?: string;
lname?: string;
pcode?: string;
technical?: TechnicalCustomer;
sepa?: SEPAMandate;
created?: string;
locked?: boolean;
canceled?: string;
billable?: boolean;
verified?: boolean;
invoiceDays?: { days: number[] };
invoicePaperbill?: boolean;
invoiceFee?: boolean;
pricelists?: PriceLists;
supplierNumber?: string
currentAccountBalance?: number
reserved?: number
accountInfo?: { creditLimit: string }
accountManager?: AccountManager;
faxes?: Phone;
reference?: string;
confirmSignature?: string;
document?: number;
confirmCity?: string;
confirmIp?: string;
securityDepositDomain?: number
securityDepositServer?: number
owner?: {
user?: string
context?: string
}
}
export type CustomerStatistics = {
article: {
type: string
labe: string
}
count: number
created: string
customer: { number: number; client: string }
id: number
updated: string
}[] | undefined
export class PriceLists {
constructor(config?: PriceLists)
}
export interface PriceLists {
pricelist: {
articleTypeLabel: string
priceListLabel: string
type: string
}[]
}
export class basicCustomerContact {
constructor(config?: basicCustomerContact);
}
export interface basicCustomerContact {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
id?: number;
customer?: GenericCustomer;
type?: ContactType;
firstName?: string;
lastName?: string;
title?: string;
label?: string;
language?: string;
gender?: GenderConstants;
postalCode?: string;
city?: string;
country?: string;
state?: string;
phones?: Phone[];
faxes?: Phone[];
email?: string;
address?: string[];
notice?: string;
}
export class BasicCustomerSpoolVerification {
constructor(config?: BasicCustomerSpoolVerification)
}
export interface BasicCustomerSpoolVerification {
created?: string;
updated?: string;
email?: string;
status?: GenericStatusConstants;
customer?: GenericCustomer;
}
export class BasicDocument {
constructor(config?: BasicDocument);
}
export interface BasicDocument {
created?: string;
updated?: string;
id?: number;
comment?: string;
type?: string;
mimeType?: string;
data?: string;
size?: number;
name?: string;
link?: string;
uuid?: string;
alias?: string;
owner?: BasicUser;
updater?: BasicUser;
expire?: string;
}
export class BasicUser {
constructor(config?: BasicUser);
}
export interface BasicUser {
context?: number;
user?: string;
language?: string;
parent?: {
user?: string
context?: number
};
status?: number;
subStatus?: number;
defaultEmail?: string;
passwordExpired?: boolean;
passwordChanged?: string;
subscriptions?: Subscription[];
toggle?: boolean
details?: {
fname?: string
lname?: string
}
lock?: string
}
export class BillingCustomerXML {
constructor(config?: BillingCustomerXML)
}
export interface BillingCustomerXML {
"@_number"?: number;
"@_client": string;
"@_payment": string;
country: string;
fname: string;
lname: string;
city: string;
pcode: string;
taxable?: boolean;
discount?: boolean;
billing_term?: string;
autodelete?: boolean;
autodelete_tlds?: string;
email: string[];
billing_email: string[];
extension?: any;
sepa_mandate: SEPAMandate;
contact: BillingCustomerContact;
contract?: BillingContractXML;
comment?: Comment;
billing?: string;
}
export class BillingCustomerContact {
constructor(config?: BillingCustomerContact)
}
export interface BillingCustomerContact {
type?: string;
city?: string;
country?: string;
state?: string;
email?: string;
fname?: string;
lname?: string;
address?: string[];
pcode?: string;
fax?: string;
phone?: string;
}
export class BillingContractXML {
constructor(config?: BillingContractXML)
}
export interface BillingContractXML {
contract: {
"@_label": string;
},
account_manager?: {
name: string;
},
document_id?: number;
classification?: string;
notice?: string;
addons?: any;
}
export class BillingEvent {
constructor(config?: BillingEvent)
}
export interface BillingEvent {
id?: number;
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
status?: BillingStatus;
object?: string;
description?: string;
period?: TimePeriod;
articleTypeLabel?: string;
payable?: string;
articleLabel?: string;
businessCase?: string;
extensions?: BillingEventExtensions;
customer?: GenericCustomer;
}
export class BillingEventExtensions {
constructor(config?: BillingEventExtensions)
}
export interface BillingEventExtensions {
externalReference?: string;
error?: string;
}
export class BillingLimit {
constructor(config?: BillingLimit);
}
export interface BillingLimit {
user?: BasicUser;
entries?: BillingObjectLimit[];
}
export class BillingObjectTerms {
constructor(config?: BillingObjectTerms);
}
export interface BillingObjectTerms {
billingObjectTerms?: BillingObjectTerm[];
}
export class BillingObjectTerm {
constructor(config?: BillingObjectTerm);
}
export interface BillingObjectTerm {
created?: string;
updated?: string;
owner?: BasicUser;
updater?: BasicUser;
cancelation?: TimePeriod;
cancelationExpireOnly?: boolean;
initial?: TimePeriod;
renew?: TimePeriod;
renewTerm?: TimePeriod;
customer?: GenericCustomer;
articleTypeLabel?: string;
acrticleLabel?: string;