@opusdns/api 1.208.0 → 1.210.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +0 -78
- package/src/helpers/schemas.d.ts +0 -4
- package/src/openapi.yaml +602 -337
- package/src/schema.d.ts +167 -85
package/src/schema.d.ts
CHANGED
|
@@ -3670,50 +3670,9 @@ export interface components {
|
|
|
3670
3670
|
BrandingDesignContextPayload: {
|
|
3671
3671
|
actions?: components["schemas"]["BrandingDesignActions"] | null;
|
|
3672
3672
|
diff?: components["schemas"]["BrandingDesignDiff"] | null;
|
|
3673
|
-
/** Notices */
|
|
3674
|
-
notices?: components["schemas"]["BrandingDesignNotice"][];
|
|
3675
3673
|
/** Results */
|
|
3676
3674
|
results: components["schemas"]["BrandingDesignVariant"][];
|
|
3677
3675
|
source?: components["schemas"]["BrandingDesignSource"] | null;
|
|
3678
|
-
/**
|
|
3679
|
-
* Summary
|
|
3680
|
-
* @default
|
|
3681
|
-
*/
|
|
3682
|
-
summary: string;
|
|
3683
|
-
/** Summary Parts */
|
|
3684
|
-
summary_parts?: components["schemas"]["BrandingDesignPhrase"][];
|
|
3685
|
-
/** Warnings */
|
|
3686
|
-
warnings?: string[];
|
|
3687
|
-
};
|
|
3688
|
-
/** BrandingDesignContrast */
|
|
3689
|
-
BrandingDesignContrast: {
|
|
3690
|
-
/** All Pass */
|
|
3691
|
-
all_pass?: boolean | null;
|
|
3692
|
-
/** Checks */
|
|
3693
|
-
checks?: components["schemas"]["BrandingDesignContrastCheck"][];
|
|
3694
|
-
/** Min Ratio */
|
|
3695
|
-
min_ratio?: number | null;
|
|
3696
|
-
};
|
|
3697
|
-
/** BrandingDesignContrastCheck */
|
|
3698
|
-
BrandingDesignContrastCheck: {
|
|
3699
|
-
/** Bg */
|
|
3700
|
-
bg?: string | null;
|
|
3701
|
-
/** Fg */
|
|
3702
|
-
fg?: string | null;
|
|
3703
|
-
/** Hard */
|
|
3704
|
-
hard?: boolean | null;
|
|
3705
|
-
/** Kind */
|
|
3706
|
-
kind?: string | null;
|
|
3707
|
-
/** Max */
|
|
3708
|
-
max?: number | null;
|
|
3709
|
-
/** Min */
|
|
3710
|
-
min?: number | null;
|
|
3711
|
-
/** Mode */
|
|
3712
|
-
mode?: string | null;
|
|
3713
|
-
/** Ok */
|
|
3714
|
-
ok?: boolean | null;
|
|
3715
|
-
/** Ratio */
|
|
3716
|
-
ratio?: number | null;
|
|
3717
3676
|
};
|
|
3718
3677
|
/** BrandingDesignDiff */
|
|
3719
3678
|
BrandingDesignDiff: {
|
|
@@ -3726,33 +3685,6 @@ export interface components {
|
|
|
3726
3685
|
BrandingDesignDocument: {
|
|
3727
3686
|
[key: string]: unknown;
|
|
3728
3687
|
};
|
|
3729
|
-
/** BrandingDesignNotice */
|
|
3730
|
-
BrandingDesignNotice: {
|
|
3731
|
-
/** Code */
|
|
3732
|
-
code: string;
|
|
3733
|
-
/**
|
|
3734
|
-
* Message
|
|
3735
|
-
* @default
|
|
3736
|
-
*/
|
|
3737
|
-
message: string;
|
|
3738
|
-
/** Params */
|
|
3739
|
-
params?: {
|
|
3740
|
-
[key: string]: string | number | boolean | string[];
|
|
3741
|
-
};
|
|
3742
|
-
/** Severity */
|
|
3743
|
-
severity: string;
|
|
3744
|
-
/** Variants */
|
|
3745
|
-
variants?: string[];
|
|
3746
|
-
};
|
|
3747
|
-
/** BrandingDesignPhrase */
|
|
3748
|
-
BrandingDesignPhrase: {
|
|
3749
|
-
/** Code */
|
|
3750
|
-
code: string;
|
|
3751
|
-
/** Params */
|
|
3752
|
-
params?: {
|
|
3753
|
-
[key: string]: string | number | boolean | string[];
|
|
3754
|
-
};
|
|
3755
|
-
};
|
|
3756
3688
|
/** BrandingDesignPreview */
|
|
3757
3689
|
BrandingDesignPreview: {
|
|
3758
3690
|
/** Dark Strategy */
|
|
@@ -3775,8 +3707,6 @@ export interface components {
|
|
|
3775
3707
|
};
|
|
3776
3708
|
/** BrandingDesignSource */
|
|
3777
3709
|
BrandingDesignSource: {
|
|
3778
|
-
/** Confidence */
|
|
3779
|
-
confidence?: string | null;
|
|
3780
3710
|
/** Kind */
|
|
3781
3711
|
kind?: string | null;
|
|
3782
3712
|
/** Logo Asset Url */
|
|
@@ -3801,23 +3731,8 @@ export interface components {
|
|
|
3801
3731
|
};
|
|
3802
3732
|
/** BrandingDesignVariant */
|
|
3803
3733
|
BrandingDesignVariant: {
|
|
3804
|
-
/** Changed Seeds */
|
|
3805
|
-
changed_seeds?: string[];
|
|
3806
|
-
contrast?: components["schemas"]["BrandingDesignContrast"] | null;
|
|
3807
3734
|
document: components["schemas"]["BrandingDesignDocument"];
|
|
3808
|
-
/**
|
|
3809
|
-
* Label
|
|
3810
|
-
* @default
|
|
3811
|
-
*/
|
|
3812
|
-
label: string;
|
|
3813
3735
|
preview?: components["schemas"]["BrandingDesignPreview"] | null;
|
|
3814
|
-
/**
|
|
3815
|
-
* Rationale
|
|
3816
|
-
* @default
|
|
3817
|
-
*/
|
|
3818
|
-
rationale: string;
|
|
3819
|
-
/** Rationale Parts */
|
|
3820
|
-
rationale_parts?: components["schemas"]["BrandingDesignPhrase"][];
|
|
3821
3736
|
/** Variant Id */
|
|
3822
3737
|
variant_id: string;
|
|
3823
3738
|
};
|
|
@@ -21827,12 +21742,19 @@ export interface operations {
|
|
|
21827
21742
|
parameters: {
|
|
21828
21743
|
query: {
|
|
21829
21744
|
email_forward_id: TypeId<"email_forward">;
|
|
21745
|
+
/** @description Sort field (log_id, domain, sender_email, recipient_email, forward_email, final_status, created_on, synced_on) */
|
|
21830
21746
|
sort_by?: components["schemas"]["EmailForwardLogSortField"];
|
|
21747
|
+
/** @description Sort order (asc, desc) */
|
|
21831
21748
|
sort_order?: components["schemas"]["SortOrder"];
|
|
21749
|
+
/** @description Records per page */
|
|
21832
21750
|
page_size?: number;
|
|
21751
|
+
/** @description Page number */
|
|
21833
21752
|
page?: number;
|
|
21753
|
+
/** @description Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) */
|
|
21834
21754
|
final_status?: components["schemas"]["EmailForwardLogStatus"] | null;
|
|
21755
|
+
/** @description Filter logs after (RFC3339) */
|
|
21835
21756
|
start_time?: Date | null;
|
|
21757
|
+
/** @description Filter logs before (RFC3339) */
|
|
21836
21758
|
end_time?: Date | null;
|
|
21837
21759
|
};
|
|
21838
21760
|
header?: {
|
|
@@ -21872,12 +21794,19 @@ export interface operations {
|
|
|
21872
21794
|
get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get: {
|
|
21873
21795
|
parameters: {
|
|
21874
21796
|
query?: {
|
|
21797
|
+
/** @description Sort field (log_id, domain, sender_email, recipient_email, forward_email, final_status, created_on, synced_on) */
|
|
21875
21798
|
sort_by?: components["schemas"]["EmailForwardLogSortField"];
|
|
21799
|
+
/** @description Sort order (asc, desc) */
|
|
21876
21800
|
sort_order?: components["schemas"]["SortOrder"];
|
|
21801
|
+
/** @description Records per page */
|
|
21877
21802
|
page_size?: number;
|
|
21803
|
+
/** @description Page number */
|
|
21878
21804
|
page?: number;
|
|
21805
|
+
/** @description Filter by final status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) */
|
|
21879
21806
|
final_status?: components["schemas"]["EmailForwardLogStatus"] | null;
|
|
21807
|
+
/** @description Filter logs after (RFC3339) */
|
|
21880
21808
|
start_time?: Date | null;
|
|
21809
|
+
/** @description Filter logs before (RFC3339) */
|
|
21881
21810
|
end_time?: Date | null;
|
|
21882
21811
|
};
|
|
21883
21812
|
header?: {
|
|
@@ -21917,18 +21846,31 @@ export interface operations {
|
|
|
21917
21846
|
get_object_logs_v1_archive_object_logs_get: {
|
|
21918
21847
|
parameters: {
|
|
21919
21848
|
query?: {
|
|
21849
|
+
/** @description Sort field (object_log_id, object_id, object_type, action, created_on, organization_id, server_request_id, performed_by_type, performed_by_id) */
|
|
21920
21850
|
sort_by?: components["schemas"]["ObjectLogSortField"];
|
|
21851
|
+
/** @description Sort order (asc, desc) */
|
|
21921
21852
|
sort_order?: components["schemas"]["SortOrder"];
|
|
21853
|
+
/** @description Records per page */
|
|
21922
21854
|
page_size?: number;
|
|
21855
|
+
/** @description Page number */
|
|
21923
21856
|
page?: number;
|
|
21857
|
+
/** @description Filter by specific log UUID */
|
|
21924
21858
|
object_log_id?: string | null;
|
|
21859
|
+
/** @description Filter by object type */
|
|
21925
21860
|
object_type?: string | null;
|
|
21861
|
+
/** @description Filter by action */
|
|
21926
21862
|
action?: components["schemas"]["ObjectEventType"] | null;
|
|
21863
|
+
/** @description Filter by server request ID */
|
|
21927
21864
|
server_request_id?: string | null;
|
|
21865
|
+
/** @description Filter by performer type */
|
|
21928
21866
|
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
21867
|
+
/** @description Filter by performer ID (TypeID) */
|
|
21929
21868
|
performed_by_id?: string | null;
|
|
21869
|
+
/** @description Upper bound: created_on <= value (RFC3339) */
|
|
21930
21870
|
created_before?: Date | null;
|
|
21871
|
+
/** @description Lower bound: created_on >= value (RFC3339) */
|
|
21931
21872
|
created_after?: Date | null;
|
|
21873
|
+
/** @description Filter by object ID (TypeID) */
|
|
21932
21874
|
object_id?: string | null;
|
|
21933
21875
|
};
|
|
21934
21876
|
header?: {
|
|
@@ -21966,17 +21908,29 @@ export interface operations {
|
|
|
21966
21908
|
get_object_logs_by_object_id_v1_archive_object_logs__object_id__get: {
|
|
21967
21909
|
parameters: {
|
|
21968
21910
|
query?: {
|
|
21911
|
+
/** @description Sort field (object_log_id, object_id, object_type, action, created_on, organization_id, server_request_id, performed_by_type, performed_by_id) */
|
|
21969
21912
|
sort_by?: components["schemas"]["ObjectLogSortField"];
|
|
21913
|
+
/** @description Sort order (asc, desc) */
|
|
21970
21914
|
sort_order?: components["schemas"]["SortOrder"];
|
|
21915
|
+
/** @description Records per page */
|
|
21971
21916
|
page_size?: number;
|
|
21917
|
+
/** @description Page number */
|
|
21972
21918
|
page?: number;
|
|
21919
|
+
/** @description Filter by specific log UUID */
|
|
21973
21920
|
object_log_id?: string | null;
|
|
21921
|
+
/** @description Filter by object type */
|
|
21974
21922
|
object_type?: string | null;
|
|
21923
|
+
/** @description Filter by action */
|
|
21975
21924
|
action?: components["schemas"]["ObjectEventType"] | null;
|
|
21925
|
+
/** @description Filter by server request ID */
|
|
21976
21926
|
server_request_id?: string | null;
|
|
21927
|
+
/** @description Filter by performer type */
|
|
21977
21928
|
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
21929
|
+
/** @description Filter by performer ID (TypeID) */
|
|
21978
21930
|
performed_by_id?: string | null;
|
|
21931
|
+
/** @description Upper bound: created_on <= value (RFC3339) */
|
|
21979
21932
|
created_before?: Date | null;
|
|
21933
|
+
/** @description Lower bound: created_on >= value (RFC3339) */
|
|
21980
21934
|
created_after?: Date | null;
|
|
21981
21935
|
};
|
|
21982
21936
|
header?: {
|
|
@@ -22016,22 +21970,37 @@ export interface operations {
|
|
|
22016
21970
|
get_request_history_v1_archive_request_history_get: {
|
|
22017
21971
|
parameters: {
|
|
22018
21972
|
query?: {
|
|
21973
|
+
/** @description Sort field (request_history_id, method, path, status_code, duration, client_ip, server_request_id, performed_by_type, performed_by_id, created_on, request_started_at, request_completed_at, organization_id) */
|
|
22019
21974
|
sort_by?: components["schemas"]["RequestHistorySortField"];
|
|
21975
|
+
/** @description Sort order (asc, desc) */
|
|
22020
21976
|
sort_order?: components["schemas"]["SortOrder"];
|
|
22021
21977
|
page_size?: number;
|
|
22022
21978
|
page?: number;
|
|
21979
|
+
/** @description HTTP method filter (GET, POST, etc.) */
|
|
22023
21980
|
method?: components["schemas"]["HTTPMethod"] | null;
|
|
21981
|
+
/** @description Path filter (supports LIKE queries) */
|
|
22024
21982
|
path?: string | null;
|
|
21983
|
+
/** @description Exact status code filter */
|
|
22025
21984
|
status_code?: number | null;
|
|
21985
|
+
/** @description Minimum status code filter */
|
|
22026
21986
|
min_status_code?: number | null;
|
|
21987
|
+
/** @description Maximum status code filter */
|
|
22027
21988
|
max_status_code?: number | null;
|
|
21989
|
+
/** @description Minimum duration in milliseconds */
|
|
22028
21990
|
min_duration?: number | null;
|
|
21991
|
+
/** @description Maximum duration in milliseconds */
|
|
22029
21992
|
max_duration?: number | null;
|
|
21993
|
+
/** @description Client IP address filter */
|
|
22030
21994
|
client_ip?: string | null;
|
|
21995
|
+
/** @description Server request ID filter */
|
|
22031
21996
|
server_request_id?: string | null;
|
|
21997
|
+
/** @description Performed by type filter */
|
|
22032
21998
|
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
21999
|
+
/** @description Performed by ID filter */
|
|
22033
22000
|
performed_by_id?: string | null;
|
|
22001
|
+
/** @description Upper bound: request_started_at <= value (RFC3339) */
|
|
22034
22002
|
request_started_before?: Date | null;
|
|
22003
|
+
/** @description Lower bound: request_started_at >= value (RFC3339) */
|
|
22035
22004
|
request_started_after?: Date | null;
|
|
22036
22005
|
};
|
|
22037
22006
|
header?: {
|
|
@@ -22431,22 +22400,35 @@ export interface operations {
|
|
|
22431
22400
|
query?: {
|
|
22432
22401
|
page?: number;
|
|
22433
22402
|
page_size?: number;
|
|
22403
|
+
/** @description Field to sort by */
|
|
22434
22404
|
sort_by?: components["schemas"]["ContactSortField"];
|
|
22405
|
+
/** @description Sort order direction */
|
|
22435
22406
|
sort_order?: components["schemas"]["SortOrder"];
|
|
22436
22407
|
/** @description Filter by contact status tag types. Can be specified multiple times. */
|
|
22437
22408
|
status_tags?: components["schemas"]["ContactStatusTagType"][] | null;
|
|
22409
|
+
/** @description How to combine status_tags: 'match_any' returns objects with at least one of the tags, 'match_all' returns objects with every tag, 'match_none' returns objects with none of the tags, including objects that carry no status tags at all. Has no effect unless one or more status_tags are supplied. */
|
|
22438
22410
|
status_tag_mode?: components["schemas"]["TagFilterMode"];
|
|
22439
22411
|
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
22440
22412
|
tag_ids?: TypeId<"tag">[] | null;
|
|
22413
|
+
/** @description How to combine tag_ids: 'match_any' returns objects with at least one of the tags, 'match_all' returns objects with every tag, 'match_none' returns objects with none of the tags, including objects that carry no user tags at all. Has no effect unless one or more tag_ids are supplied; to filter on whether an object has any user tag, use has_tags. */
|
|
22441
22414
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
22415
|
+
/** @description true returns only objects that carry at least one user tag, false only objects that carry none. Status tags are not counted. Combines with tag_ids and the other filters. */
|
|
22442
22416
|
has_tags?: boolean | null;
|
|
22417
|
+
/** @description Filter by exact first name */
|
|
22443
22418
|
first_name?: string | null;
|
|
22419
|
+
/** @description Filter by exact last name */
|
|
22444
22420
|
last_name?: string | null;
|
|
22421
|
+
/** @description Filter by exact email address */
|
|
22445
22422
|
email?: string | null;
|
|
22423
|
+
/** @description Search contacts by name, email, organization, or contact ID. Multiple whitespace-separated terms must all match (as substrings), so a full "First Last" name matches across the separate first- and last-name columns. A contact ID is matched exactly. */
|
|
22446
22424
|
search?: string | null;
|
|
22425
|
+
/** @description Filter by country */
|
|
22447
22426
|
country?: string | null;
|
|
22427
|
+
/** @description Filter by whether the contact is in use by any domain (true = has domains, false = none) */
|
|
22448
22428
|
in_use?: boolean | null;
|
|
22429
|
+
/** @description Filter contacts created after this date */
|
|
22449
22430
|
created_after?: Date | null;
|
|
22431
|
+
/** @description Filter contacts created before this date */
|
|
22450
22432
|
created_before?: Date | null;
|
|
22451
22433
|
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
22452
22434
|
include?: components["schemas"]["ContactIncludeField"][] | null;
|
|
@@ -22527,9 +22509,13 @@ export interface operations {
|
|
|
22527
22509
|
query?: {
|
|
22528
22510
|
page?: number;
|
|
22529
22511
|
page_size?: number;
|
|
22512
|
+
/** @description Field to sort by */
|
|
22530
22513
|
sort_by?: components["schemas"]["ContactAttributeSetSortField"];
|
|
22514
|
+
/** @description Sort order direction */
|
|
22531
22515
|
sort_order?: components["schemas"]["SortOrder"];
|
|
22516
|
+
/** @description Filter by exact TLD (e.g. 'de', '.de', 'DE') */
|
|
22532
22517
|
tld?: string | null;
|
|
22518
|
+
/** @description Filter by label (contains, case-insensitive) */
|
|
22533
22519
|
label?: string | null;
|
|
22534
22520
|
};
|
|
22535
22521
|
header?: {
|
|
@@ -23700,20 +23686,33 @@ export interface operations {
|
|
|
23700
23686
|
query?: {
|
|
23701
23687
|
page?: number;
|
|
23702
23688
|
page_size?: number;
|
|
23689
|
+
/** @description Field to sort by */
|
|
23703
23690
|
sort_by?: components["schemas"]["ZoneSortField"];
|
|
23691
|
+
/** @description Sort order direction */
|
|
23704
23692
|
sort_order?: components["schemas"]["SortOrder"];
|
|
23705
23693
|
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
23706
23694
|
tag_ids?: TypeId<"tag">[] | null;
|
|
23695
|
+
/** @description How to combine tag_ids: 'match_any' returns objects with at least one of the tags, 'match_all' returns objects with every tag, 'match_none' returns objects with none of the tags, including objects that carry no user tags at all. Has no effect unless one or more tag_ids are supplied; to filter on whether an object has any user tag, use has_tags. */
|
|
23707
23696
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
23697
|
+
/** @description true returns only objects that carry at least one user tag, false only objects that carry none. Status tags are not counted. Combines with tag_ids and the other filters. */
|
|
23708
23698
|
has_tags?: boolean | null;
|
|
23699
|
+
/** @description Filter by DNSSEC status */
|
|
23709
23700
|
dnssec_status?: components["schemas"]["DnssecStatus"] | null;
|
|
23701
|
+
/** @description Filter by exact zone name */
|
|
23710
23702
|
name?: string | null;
|
|
23703
|
+
/** @description Search zones by name (contains) */
|
|
23711
23704
|
search?: string | null;
|
|
23705
|
+
/** @description Filter zones by TLD/suffix (e.g., 'com', 'io', 'co.uk') */
|
|
23712
23706
|
suffix?: string | null;
|
|
23707
|
+
/** @description Filter zones by the vanity nameserver set branding them */
|
|
23713
23708
|
vanity_nameserver_set_id?: TypeId<"vns"> | null;
|
|
23709
|
+
/** @description Filter zones created after this date */
|
|
23714
23710
|
created_after?: Date | null;
|
|
23711
|
+
/** @description Filter zones created before this date */
|
|
23715
23712
|
created_before?: Date | null;
|
|
23713
|
+
/** @description Filter zones updated after this date */
|
|
23716
23714
|
updated_after?: Date | null;
|
|
23715
|
+
/** @description Filter zones updated before this date */
|
|
23717
23716
|
updated_before?: Date | null;
|
|
23718
23717
|
/** @description Include additional data in the response. Can be specified multiple times. */
|
|
23719
23718
|
include?: components["schemas"]["ZoneIncludeField"][] | null;
|
|
@@ -23810,8 +23809,11 @@ export interface operations {
|
|
|
23810
23809
|
query?: {
|
|
23811
23810
|
page?: number;
|
|
23812
23811
|
page_size?: number;
|
|
23812
|
+
/** @description Search by zone name */
|
|
23813
23813
|
search?: string | null;
|
|
23814
|
+
/** @description Field to sort by */
|
|
23814
23815
|
sort_by?: components["schemas"]["DomainForwardZoneSortField"];
|
|
23816
|
+
/** @description Sort order direction */
|
|
23815
23817
|
sort_order?: components["schemas"]["SortOrder"];
|
|
23816
23818
|
};
|
|
23817
23819
|
header?: {
|
|
@@ -23883,8 +23885,11 @@ export interface operations {
|
|
|
23883
23885
|
query?: {
|
|
23884
23886
|
page?: number;
|
|
23885
23887
|
page_size?: number;
|
|
23888
|
+
/** @description Search by zone name */
|
|
23886
23889
|
search?: string | null;
|
|
23890
|
+
/** @description Field to sort by */
|
|
23887
23891
|
sort_by?: components["schemas"]["EmailForwardZoneSortField"];
|
|
23892
|
+
/** @description Sort order direction */
|
|
23888
23893
|
sort_order?: components["schemas"]["SortOrder"];
|
|
23889
23894
|
};
|
|
23890
23895
|
header?: {
|
|
@@ -24657,8 +24662,11 @@ export interface operations {
|
|
|
24657
24662
|
query?: {
|
|
24658
24663
|
page?: number;
|
|
24659
24664
|
page_size?: number;
|
|
24665
|
+
/** @description Search by hostname */
|
|
24660
24666
|
search?: string | null;
|
|
24667
|
+
/** @description Field to sort by */
|
|
24661
24668
|
sort_by?: components["schemas"]["DomainForwardSortField"];
|
|
24669
|
+
/** @description Sort order direction */
|
|
24662
24670
|
sort_order?: components["schemas"]["SortOrder"];
|
|
24663
24671
|
};
|
|
24664
24672
|
header?: {
|
|
@@ -26608,36 +26616,61 @@ export interface operations {
|
|
|
26608
26616
|
query?: {
|
|
26609
26617
|
page?: number;
|
|
26610
26618
|
page_size?: number;
|
|
26619
|
+
/** @description Field to sort by */
|
|
26611
26620
|
sort_by?: components["schemas"]["DomainSortField"];
|
|
26621
|
+
/** @description Sort order direction */
|
|
26612
26622
|
sort_order?: components["schemas"]["SortOrder"];
|
|
26613
26623
|
/** @description Filter by status tag types. Can be specified multiple times. */
|
|
26614
26624
|
status_tags?: components["schemas"]["StatusTagType"][] | null;
|
|
26625
|
+
/** @description How to combine status_tags: 'match_any' returns objects with at least one of the tags, 'match_all' returns objects with every tag, 'match_none' returns objects with none of the tags, including objects that carry no status tags at all. Has no effect unless one or more status_tags are supplied. */
|
|
26615
26626
|
status_tag_mode?: components["schemas"]["TagFilterMode"];
|
|
26616
26627
|
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
26617
26628
|
tag_ids?: TypeId<"tag">[] | null;
|
|
26629
|
+
/** @description How to combine tag_ids: 'match_any' returns objects with at least one of the tags, 'match_all' returns objects with every tag, 'match_none' returns objects with none of the tags, including objects that carry no user tags at all. Has no effect unless one or more tag_ids are supplied; to filter on whether an object has any user tag, use has_tags. */
|
|
26618
26630
|
tag_mode?: components["schemas"]["TagFilterMode"];
|
|
26631
|
+
/** @description true returns only objects that carry at least one user tag, false only objects that carry none. Status tags are not counted. Combines with tag_ids and the other filters. */
|
|
26619
26632
|
has_tags?: boolean | null;
|
|
26633
|
+
/** @description Filter by exact domain name */
|
|
26620
26634
|
name?: string | null;
|
|
26635
|
+
/** @description Search domains by name (contains) or domain ID (exact match) */
|
|
26621
26636
|
search?: string | null;
|
|
26622
26637
|
/** @description Filter by top-level domain (e.g., 'com', 'org'). Can be specified multiple times (union of all provided values). */
|
|
26623
26638
|
tld?: string[] | null;
|
|
26639
|
+
/** @description Filter by second-level domain */
|
|
26624
26640
|
sld?: string | null;
|
|
26641
|
+
/** @description Filter domains whose nameserver hostnames contain this text, e.g. `cloudflare` or `ns1.example.com`. Matches the nameservers the domain currently delegates to. The text is matched literally, so `%` and `_` are not wildcards; a trailing dot on a single label anchors at a label boundary, so `ns1.` matches `ns1.example.com` but not `ns10.example.com`. Unlike the other filters this one reads the nameservers of every domain in scope, so expect a slower response, the more so the larger the portfolio. */
|
|
26625
26642
|
nameserver?: string | null;
|
|
26643
|
+
/** @description Filter by transfer lock status */
|
|
26626
26644
|
transfer_lock?: boolean | null;
|
|
26645
|
+
/** @description Filter by read-only status */
|
|
26627
26646
|
read_only?: boolean | null;
|
|
26647
|
+
/** @description Filter by premium domain status */
|
|
26628
26648
|
is_premium?: boolean | null;
|
|
26649
|
+
/** @description Filter domains created after this date */
|
|
26629
26650
|
created_after?: Date | null;
|
|
26651
|
+
/** @description Filter domains created before this date */
|
|
26630
26652
|
created_before?: Date | null;
|
|
26653
|
+
/** @description Filter domains updated after this date */
|
|
26631
26654
|
updated_after?: Date | null;
|
|
26655
|
+
/** @description Filter domains updated before this date */
|
|
26632
26656
|
updated_before?: Date | null;
|
|
26657
|
+
/** @description Filter domains expiring after this date */
|
|
26633
26658
|
expires_after?: Date | null;
|
|
26659
|
+
/** @description Filter domains expiring before this date */
|
|
26634
26660
|
expires_before?: Date | null;
|
|
26661
|
+
/** @description Filter domains expiring within the next 30 days */
|
|
26635
26662
|
expires_in_30_days?: boolean | null;
|
|
26663
|
+
/** @description Filter domains expiring within the next 60 days */
|
|
26636
26664
|
expires_in_60_days?: boolean | null;
|
|
26665
|
+
/** @description Filter domains expiring within the next 90 days */
|
|
26637
26666
|
expires_in_90_days?: boolean | null;
|
|
26667
|
+
/** @description Filter domains registered after this date */
|
|
26638
26668
|
registered_after?: Date | null;
|
|
26669
|
+
/** @description Filter domains registered before this date */
|
|
26639
26670
|
registered_before?: Date | null;
|
|
26671
|
+
/** @description Filter domains transferred in after this date */
|
|
26640
26672
|
transferred_after?: Date | null;
|
|
26673
|
+
/** @description Filter domains transferred in before this date */
|
|
26641
26674
|
transferred_before?: Date | null;
|
|
26642
26675
|
/** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
|
|
26643
26676
|
registry_statuses?: string[] | null;
|
|
@@ -26888,12 +26921,19 @@ export interface operations {
|
|
|
26888
26921
|
get_domain_statistics_v1_domains_statistics_get: {
|
|
26889
26922
|
parameters: {
|
|
26890
26923
|
query: {
|
|
26924
|
+
/** @description First day of the window, inclusive (YYYY-MM-DD, UTC) */
|
|
26891
26925
|
start_date: string;
|
|
26926
|
+
/** @description Last day of the window, inclusive (YYYY-MM-DD, UTC). How far it may reach depends on `granularity`: at most 92 days for `day`, 371 days for `week`, 396 days for `month`. */
|
|
26892
26927
|
end_date: string;
|
|
26928
|
+
/** @description Time-bucket size. Weeks start on Monday and months on the 1st, in UTC. */
|
|
26893
26929
|
granularity?: components["schemas"]["UsageGranularity"];
|
|
26930
|
+
/** @description Restrict the counts to one top-level domain, e.g. `com`. */
|
|
26894
26931
|
tld?: string | null;
|
|
26932
|
+
/** @description Adds a top-N list to the response: `organization` ranks your organization and its sub-organizations (so it needs `include_sub_organizations=true`), `tld` ranks the top-level domains. */
|
|
26895
26933
|
breakdown?: components["schemas"]["DomainStatisticsBreakdown"];
|
|
26934
|
+
/** @description How many rows the breakdown lists. */
|
|
26896
26935
|
breakdown_limit?: number;
|
|
26936
|
+
/** @description Count your sub-organizations' domains too. By default only your own organization's domains are counted, as in the domain summary. */
|
|
26897
26937
|
include_sub_organizations?: boolean;
|
|
26898
26938
|
};
|
|
26899
26939
|
header?: {
|
|
@@ -28819,9 +28859,13 @@ export interface operations {
|
|
|
28819
28859
|
query?: {
|
|
28820
28860
|
page?: number;
|
|
28821
28861
|
page_size?: number;
|
|
28862
|
+
/** @description Search by hostname */
|
|
28822
28863
|
search?: string | null;
|
|
28864
|
+
/** @description Filter by enabled status */
|
|
28823
28865
|
enabled?: boolean | null;
|
|
28866
|
+
/** @description Field to sort by */
|
|
28824
28867
|
sort_by?: components["schemas"]["EmailForwardSortField"];
|
|
28868
|
+
/** @description Sort order direction */
|
|
28825
28869
|
sort_order?: components["schemas"]["SortOrder"];
|
|
28826
28870
|
};
|
|
28827
28871
|
header?: {
|
|
@@ -29605,7 +29649,9 @@ export interface operations {
|
|
|
29605
29649
|
get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get: {
|
|
29606
29650
|
parameters: {
|
|
29607
29651
|
query?: {
|
|
29652
|
+
/** @description Filter metrics after (RFC3339) */
|
|
29608
29653
|
start_time?: Date | null;
|
|
29654
|
+
/** @description Filter metrics before (RFC3339) */
|
|
29609
29655
|
end_time?: Date | null;
|
|
29610
29656
|
};
|
|
29611
29657
|
header?: {
|
|
@@ -29695,12 +29741,19 @@ export interface operations {
|
|
|
29695
29741
|
query?: {
|
|
29696
29742
|
page?: number;
|
|
29697
29743
|
page_size?: number;
|
|
29744
|
+
/** @description Field to sort by */
|
|
29698
29745
|
sort_by?: components["schemas"]["EventSortField"];
|
|
29746
|
+
/** @description Sort order direction */
|
|
29699
29747
|
sort_order?: components["schemas"]["SortOrder"];
|
|
29748
|
+
/** @description Filter by */
|
|
29700
29749
|
object_type?: components["schemas"]["EventObjectType"] | null;
|
|
29750
|
+
/** @description Filter by specific domain/contact/host name */
|
|
29701
29751
|
object_id?: string | null;
|
|
29752
|
+
/** @description Filter by event type */
|
|
29702
29753
|
type?: components["schemas"]["EventType"] | null;
|
|
29754
|
+
/** @description Filter by subtype */
|
|
29703
29755
|
subtype?: components["schemas"]["EventSubtype"] | null;
|
|
29756
|
+
/** @description Filter by acknowledgment status */
|
|
29704
29757
|
acknowledged?: boolean | null;
|
|
29705
29758
|
};
|
|
29706
29759
|
header?: {
|
|
@@ -31038,9 +31091,13 @@ export interface operations {
|
|
|
31038
31091
|
query?: {
|
|
31039
31092
|
page?: number;
|
|
31040
31093
|
page_size?: number;
|
|
31094
|
+
/** @description Field to sort by */
|
|
31041
31095
|
sort_by?: components["schemas"]["OrganizationSortField"];
|
|
31096
|
+
/** @description Sort order direction */
|
|
31042
31097
|
sort_order?: components["schemas"]["SortOrder"];
|
|
31098
|
+
/** @description Search across organization name, address, and city */
|
|
31043
31099
|
search?: string | null;
|
|
31100
|
+
/** @description Filter by country code */
|
|
31044
31101
|
country_code?: string | null;
|
|
31045
31102
|
};
|
|
31046
31103
|
header?: {
|
|
@@ -32361,8 +32418,11 @@ export interface operations {
|
|
|
32361
32418
|
query?: {
|
|
32362
32419
|
page?: number;
|
|
32363
32420
|
page_size?: number;
|
|
32421
|
+
/** @description Field to sort by */
|
|
32364
32422
|
sort_by?: components["schemas"]["UserSortField"];
|
|
32423
|
+
/** @description Sort order direction */
|
|
32365
32424
|
sort_order?: components["schemas"]["SortOrder"];
|
|
32425
|
+
/** @description Search across username, email, first name, and last name */
|
|
32366
32426
|
search?: string | null;
|
|
32367
32427
|
};
|
|
32368
32428
|
header?: {
|
|
@@ -32949,15 +33009,25 @@ export interface operations {
|
|
|
32949
33009
|
query?: {
|
|
32950
33010
|
page?: number;
|
|
32951
33011
|
page_size?: number;
|
|
33012
|
+
/** @description Field to sort by */
|
|
32952
33013
|
sort_by?: components["schemas"]["BillingTransactionSortField"];
|
|
33014
|
+
/** @description Sort order direction */
|
|
32953
33015
|
sort_order?: components["schemas"]["SortOrder"];
|
|
33016
|
+
/** @description Filter by product reference */
|
|
32954
33017
|
product_reference?: string | null;
|
|
33018
|
+
/** @description Filter by product type */
|
|
32955
33019
|
product_type?: components["schemas"]["BillingTransactionProductType"] | null;
|
|
33020
|
+
/** @description Filter by action */
|
|
32956
33021
|
action?: components["schemas"]["BillingTransactionAction"] | null;
|
|
33022
|
+
/** @description Filter by status */
|
|
32957
33023
|
status?: components["schemas"]["BillingTransactionStatus"] | null;
|
|
33024
|
+
/** @description Filter by transactions created after this date */
|
|
32958
33025
|
created_after?: Date | null;
|
|
33026
|
+
/** @description Filter by transactions created before this date */
|
|
32959
33027
|
created_before?: Date | null;
|
|
33028
|
+
/** @description Filter by transactions completed after this date */
|
|
32960
33029
|
completed_after?: Date | null;
|
|
33030
|
+
/** @description Filter by transactions completed before this date */
|
|
32961
33031
|
completed_before?: Date | null;
|
|
32962
33032
|
};
|
|
32963
33033
|
header?: {
|
|
@@ -33255,10 +33325,15 @@ export interface operations {
|
|
|
33255
33325
|
page?: number;
|
|
33256
33326
|
/** @description Page size */
|
|
33257
33327
|
page_size?: number;
|
|
33328
|
+
/** @description Field to sort by */
|
|
33258
33329
|
sort_by?: components["schemas"]["ParkingSortField"];
|
|
33330
|
+
/** @description Sort order direction */
|
|
33259
33331
|
sort_order?: components["schemas"]["SortOrder"];
|
|
33332
|
+
/** @description Search parking entries by domain name (contains) */
|
|
33260
33333
|
search?: string | null;
|
|
33334
|
+
/** @description Filter by enabled status */
|
|
33261
33335
|
enabled?: boolean | null;
|
|
33336
|
+
/** @description Filter by compliance status */
|
|
33262
33337
|
compliance_status?: components["schemas"]["ComplianceStatus"] | null;
|
|
33263
33338
|
};
|
|
33264
33339
|
header?: {
|
|
@@ -33328,7 +33403,9 @@ export interface operations {
|
|
|
33328
33403
|
get_total_parking_metrics_v1_parking_metrics_get: {
|
|
33329
33404
|
parameters: {
|
|
33330
33405
|
query?: {
|
|
33406
|
+
/** @description Filter metrics after (RFC3339) */
|
|
33331
33407
|
start_time?: Date | null;
|
|
33408
|
+
/** @description Filter metrics before (RFC3339) */
|
|
33332
33409
|
end_time?: Date | null;
|
|
33333
33410
|
};
|
|
33334
33411
|
header?: {
|
|
@@ -33536,7 +33613,9 @@ export interface operations {
|
|
|
33536
33613
|
get_parking_metrics_v1_parking__parking_reference__metrics_get: {
|
|
33537
33614
|
parameters: {
|
|
33538
33615
|
query?: {
|
|
33616
|
+
/** @description Filter metrics after (RFC3339) */
|
|
33539
33617
|
start_time?: Date | null;
|
|
33618
|
+
/** @description Filter metrics before (RFC3339) */
|
|
33540
33619
|
end_time?: Date | null;
|
|
33541
33620
|
};
|
|
33542
33621
|
header?: {
|
|
@@ -33782,10 +33861,13 @@ export interface operations {
|
|
|
33782
33861
|
query?: {
|
|
33783
33862
|
page?: number;
|
|
33784
33863
|
page_size?: number;
|
|
33864
|
+
/** @description Field to sort by */
|
|
33785
33865
|
sort_by?: components["schemas"]["TagSortField"];
|
|
33866
|
+
/** @description Sort order direction */
|
|
33786
33867
|
sort_order?: components["schemas"]["SortOrder"];
|
|
33787
33868
|
/** @description Filter by tag types (OR semantics) */
|
|
33788
33869
|
tag_types?: components["schemas"]["TagType"][] | null;
|
|
33870
|
+
/** @description Search tags by label (contains) */
|
|
33789
33871
|
search?: string | null;
|
|
33790
33872
|
};
|
|
33791
33873
|
header?: {
|