@opusdns/api 1.10.0 → 1.11.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 +240 -32
- package/src/helpers/responses.d.ts +4 -4
- package/src/helpers/schemas.d.ts +20 -2
- package/src/openapi.yaml +442 -8
- package/src/schema.d.ts +315 -8
package/src/schema.d.ts
CHANGED
|
@@ -4943,6 +4943,73 @@ export interface components {
|
|
|
4943
4943
|
/** Results */
|
|
4944
4944
|
results: components["schemas"]["BrowserStatsBucket"][];
|
|
4945
4945
|
};
|
|
4946
|
+
/** DomainForwardCreateBulkCommand */
|
|
4947
|
+
DomainForwardCreateBulkCommand: {
|
|
4948
|
+
/**
|
|
4949
|
+
* @description discriminator enum property added by openapi-typescript
|
|
4950
|
+
* @enum {string}
|
|
4951
|
+
*/
|
|
4952
|
+
command: "domain_forward_create_bulk";
|
|
4953
|
+
/**
|
|
4954
|
+
* Idempotency Key
|
|
4955
|
+
* @description Idempotency key for this bulk command
|
|
4956
|
+
*/
|
|
4957
|
+
idempotency_key?: string | null;
|
|
4958
|
+
/** @description Bulk domain forward create payload */
|
|
4959
|
+
payload: components["schemas"]["DomainForwardCreateBulkPayload"];
|
|
4960
|
+
/**
|
|
4961
|
+
* Version
|
|
4962
|
+
* @description Command version
|
|
4963
|
+
* @default v1
|
|
4964
|
+
*/
|
|
4965
|
+
version: string;
|
|
4966
|
+
};
|
|
4967
|
+
/** DomainForwardCreateBulkInstance */
|
|
4968
|
+
DomainForwardCreateBulkInstance: {
|
|
4969
|
+
/**
|
|
4970
|
+
* Enabled
|
|
4971
|
+
* @description Override enabled setting for this hostname
|
|
4972
|
+
*/
|
|
4973
|
+
enabled?: boolean | null;
|
|
4974
|
+
/**
|
|
4975
|
+
* Hostname
|
|
4976
|
+
* @description Hostname to create forward for
|
|
4977
|
+
*/
|
|
4978
|
+
hostname: string;
|
|
4979
|
+
/** @description Override HTTP redirects */
|
|
4980
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
4981
|
+
/** @description Override HTTPS redirects */
|
|
4982
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
4983
|
+
};
|
|
4984
|
+
/** DomainForwardCreateBulkPayload */
|
|
4985
|
+
DomainForwardCreateBulkPayload: {
|
|
4986
|
+
/**
|
|
4987
|
+
* Instances
|
|
4988
|
+
* @description List of domain forwards to create (1-1000)
|
|
4989
|
+
*/
|
|
4990
|
+
instances: components["schemas"]["DomainForwardCreateBulkInstance"][];
|
|
4991
|
+
/** @description Shared settings for all domain forwards */
|
|
4992
|
+
template: components["schemas"]["DomainForwardCreateBulkTemplate"];
|
|
4993
|
+
};
|
|
4994
|
+
/** DomainForwardCreateBulkTemplate */
|
|
4995
|
+
DomainForwardCreateBulkTemplate: {
|
|
4996
|
+
/**
|
|
4997
|
+
* Auto Create Zone
|
|
4998
|
+
* @description Create apex DNS zone automatically when missing
|
|
4999
|
+
* @default false
|
|
5000
|
+
*/
|
|
5001
|
+
auto_create_zone: boolean;
|
|
5002
|
+
/**
|
|
5003
|
+
* Enabled
|
|
5004
|
+
* @description Whether domain forward should be enabled
|
|
5005
|
+
* @default false
|
|
5006
|
+
*/
|
|
5007
|
+
enabled: boolean;
|
|
5008
|
+
/** @description HTTP redirect definitions */
|
|
5009
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5010
|
+
/** @description HTTPS redirect definitions */
|
|
5011
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5012
|
+
};
|
|
4946
5013
|
/** DomainForwardCreateRequest */
|
|
4947
5014
|
DomainForwardCreateRequest: {
|
|
4948
5015
|
/**
|
|
@@ -4955,6 +5022,117 @@ export interface components {
|
|
|
4955
5022
|
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
4956
5023
|
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
4957
5024
|
};
|
|
5025
|
+
/** DomainForwardDeleteBulkCommand */
|
|
5026
|
+
DomainForwardDeleteBulkCommand: {
|
|
5027
|
+
/**
|
|
5028
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5029
|
+
* @enum {string}
|
|
5030
|
+
*/
|
|
5031
|
+
command: "domain_forward_delete_bulk";
|
|
5032
|
+
/**
|
|
5033
|
+
* Idempotency Key
|
|
5034
|
+
* @description Idempotency key for this bulk command
|
|
5035
|
+
*/
|
|
5036
|
+
idempotency_key?: string | null;
|
|
5037
|
+
/** @description Bulk domain forward delete payload */
|
|
5038
|
+
payload: components["schemas"]["DomainForwardDeleteBulkPayload"];
|
|
5039
|
+
/**
|
|
5040
|
+
* Version
|
|
5041
|
+
* @description Command version
|
|
5042
|
+
* @default v1
|
|
5043
|
+
*/
|
|
5044
|
+
version: string;
|
|
5045
|
+
};
|
|
5046
|
+
/** DomainForwardDeleteBulkInstance */
|
|
5047
|
+
DomainForwardDeleteBulkInstance: {
|
|
5048
|
+
/**
|
|
5049
|
+
* Hostname
|
|
5050
|
+
* @description Hostname to delete forwarding for
|
|
5051
|
+
*/
|
|
5052
|
+
hostname: string;
|
|
5053
|
+
};
|
|
5054
|
+
/** DomainForwardDeleteBulkPayload */
|
|
5055
|
+
DomainForwardDeleteBulkPayload: {
|
|
5056
|
+
/**
|
|
5057
|
+
* Instances
|
|
5058
|
+
* @description List of hostnames to delete forwarding for (1-1000)
|
|
5059
|
+
*/
|
|
5060
|
+
instances: components["schemas"]["DomainForwardDeleteBulkInstance"][];
|
|
5061
|
+
};
|
|
5062
|
+
/** DomainForwardDisableBulkCommand */
|
|
5063
|
+
DomainForwardDisableBulkCommand: {
|
|
5064
|
+
/**
|
|
5065
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5066
|
+
* @enum {string}
|
|
5067
|
+
*/
|
|
5068
|
+
command: "domain_forward_disable_bulk";
|
|
5069
|
+
/**
|
|
5070
|
+
* Idempotency Key
|
|
5071
|
+
* @description Idempotency key for this bulk command
|
|
5072
|
+
*/
|
|
5073
|
+
idempotency_key?: string | null;
|
|
5074
|
+
/** @description Bulk domain forward disable payload */
|
|
5075
|
+
payload: components["schemas"]["DomainForwardDisableBulkPayload"];
|
|
5076
|
+
/**
|
|
5077
|
+
* Version
|
|
5078
|
+
* @description Command version
|
|
5079
|
+
* @default v1
|
|
5080
|
+
*/
|
|
5081
|
+
version: string;
|
|
5082
|
+
};
|
|
5083
|
+
/** DomainForwardDisableBulkInstance */
|
|
5084
|
+
DomainForwardDisableBulkInstance: {
|
|
5085
|
+
/**
|
|
5086
|
+
* Hostname
|
|
5087
|
+
* @description Hostname to disable forwarding for
|
|
5088
|
+
*/
|
|
5089
|
+
hostname: string;
|
|
5090
|
+
};
|
|
5091
|
+
/** DomainForwardDisableBulkPayload */
|
|
5092
|
+
DomainForwardDisableBulkPayload: {
|
|
5093
|
+
/**
|
|
5094
|
+
* Instances
|
|
5095
|
+
* @description List of hostnames to disable forwarding for (1-1000)
|
|
5096
|
+
*/
|
|
5097
|
+
instances: components["schemas"]["DomainForwardDisableBulkInstance"][];
|
|
5098
|
+
};
|
|
5099
|
+
/** DomainForwardEnableBulkCommand */
|
|
5100
|
+
DomainForwardEnableBulkCommand: {
|
|
5101
|
+
/**
|
|
5102
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5103
|
+
* @enum {string}
|
|
5104
|
+
*/
|
|
5105
|
+
command: "domain_forward_enable_bulk";
|
|
5106
|
+
/**
|
|
5107
|
+
* Idempotency Key
|
|
5108
|
+
* @description Idempotency key for this bulk command
|
|
5109
|
+
*/
|
|
5110
|
+
idempotency_key?: string | null;
|
|
5111
|
+
/** @description Bulk domain forward enable payload */
|
|
5112
|
+
payload: components["schemas"]["DomainForwardEnableBulkPayload"];
|
|
5113
|
+
/**
|
|
5114
|
+
* Version
|
|
5115
|
+
* @description Command version
|
|
5116
|
+
* @default v1
|
|
5117
|
+
*/
|
|
5118
|
+
version: string;
|
|
5119
|
+
};
|
|
5120
|
+
/** DomainForwardEnableBulkInstance */
|
|
5121
|
+
DomainForwardEnableBulkInstance: {
|
|
5122
|
+
/**
|
|
5123
|
+
* Hostname
|
|
5124
|
+
* @description Hostname to enable forwarding for
|
|
5125
|
+
*/
|
|
5126
|
+
hostname: string;
|
|
5127
|
+
};
|
|
5128
|
+
/** DomainForwardEnableBulkPayload */
|
|
5129
|
+
DomainForwardEnableBulkPayload: {
|
|
5130
|
+
/**
|
|
5131
|
+
* Instances
|
|
5132
|
+
* @description List of hostnames to enable forwarding for (1-1000)
|
|
5133
|
+
*/
|
|
5134
|
+
instances: components["schemas"]["DomainForwardEnableBulkInstance"][];
|
|
5135
|
+
};
|
|
4958
5136
|
/** DomainForwardGeoStatsResponse */
|
|
4959
5137
|
DomainForwardGeoStatsResponse: {
|
|
4960
5138
|
/** Results */
|
|
@@ -5056,6 +5234,66 @@ export interface components {
|
|
|
5056
5234
|
/** Results */
|
|
5057
5235
|
results: components["schemas"]["StatusCodeStatsBucket"][];
|
|
5058
5236
|
};
|
|
5237
|
+
/** DomainForwardUpdateBulkCommand */
|
|
5238
|
+
DomainForwardUpdateBulkCommand: {
|
|
5239
|
+
/**
|
|
5240
|
+
* @description discriminator enum property added by openapi-typescript
|
|
5241
|
+
* @enum {string}
|
|
5242
|
+
*/
|
|
5243
|
+
command: "domain_forward_update_bulk";
|
|
5244
|
+
/**
|
|
5245
|
+
* Idempotency Key
|
|
5246
|
+
* @description Idempotency key for this bulk command
|
|
5247
|
+
*/
|
|
5248
|
+
idempotency_key?: string | null;
|
|
5249
|
+
/** @description Bulk domain forward update payload */
|
|
5250
|
+
payload: components["schemas"]["DomainForwardUpdateBulkPayload"];
|
|
5251
|
+
/**
|
|
5252
|
+
* Version
|
|
5253
|
+
* @description Command version
|
|
5254
|
+
* @default v1
|
|
5255
|
+
*/
|
|
5256
|
+
version: string;
|
|
5257
|
+
};
|
|
5258
|
+
/** DomainForwardUpdateBulkInstance */
|
|
5259
|
+
DomainForwardUpdateBulkInstance: {
|
|
5260
|
+
/**
|
|
5261
|
+
* Enabled
|
|
5262
|
+
* @description Override enabled setting for this hostname
|
|
5263
|
+
*/
|
|
5264
|
+
enabled?: boolean | null;
|
|
5265
|
+
/**
|
|
5266
|
+
* Hostname
|
|
5267
|
+
* @description Hostname to update forward for
|
|
5268
|
+
*/
|
|
5269
|
+
hostname: string;
|
|
5270
|
+
/** @description Override HTTP redirects */
|
|
5271
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5272
|
+
/** @description Override HTTPS redirects */
|
|
5273
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5274
|
+
};
|
|
5275
|
+
/** DomainForwardUpdateBulkPayload */
|
|
5276
|
+
DomainForwardUpdateBulkPayload: {
|
|
5277
|
+
/**
|
|
5278
|
+
* Instances
|
|
5279
|
+
* @description List of domain forwards to update (1-1000)
|
|
5280
|
+
*/
|
|
5281
|
+
instances: components["schemas"]["DomainForwardUpdateBulkInstance"][];
|
|
5282
|
+
/** @description Shared settings for all domain forwards */
|
|
5283
|
+
template: components["schemas"]["DomainForwardUpdateBulkTemplate"];
|
|
5284
|
+
};
|
|
5285
|
+
/** DomainForwardUpdateBulkTemplate */
|
|
5286
|
+
DomainForwardUpdateBulkTemplate: {
|
|
5287
|
+
/**
|
|
5288
|
+
* Enabled
|
|
5289
|
+
* @description Whether domain forward should be enabled
|
|
5290
|
+
*/
|
|
5291
|
+
enabled: boolean;
|
|
5292
|
+
/** @description HTTP redirect definitions */
|
|
5293
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5294
|
+
/** @description HTTPS redirect definitions */
|
|
5295
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
5296
|
+
};
|
|
5059
5297
|
/** DomainForwardUserAgentStatsResponse */
|
|
5060
5298
|
DomainForwardUserAgentStatsResponse: {
|
|
5061
5299
|
/** Results */
|
|
@@ -6805,7 +7043,7 @@ export interface components {
|
|
|
6805
7043
|
* Commands
|
|
6806
7044
|
* @description List of commands to execute
|
|
6807
7045
|
*/
|
|
6808
|
-
commands: (components["schemas"]["DomainCreateCommand"] | components["schemas"]["DomainUpdateCommand"] | components["schemas"]["DomainTransferCommand"] | components["schemas"]["DnsZoneCreateCommand"] | components["schemas"]["DnsZoneUpdateCommand"] | components["schemas"]["DomainCreateBulkCommand"] | components["schemas"]["DomainTransferBulkCommand"] | components["schemas"]["DomainUpdateBulkCommand"] | components["schemas"]["DnsZoneCreateBulkCommand"] | components["schemas"]["DnsZoneUpdateBulkCommand"] | components["schemas"]["DnsZonePatchRrsetsBulkCommand"] | components["schemas"]["DnsZonePatchRecordsBulkCommand"] | components["schemas"]["ContactCreateBulkCommand"] | components["schemas"]["ContactCreateCommand"] | components["schemas"]["ParkingCreateBulkCommand"] | components["schemas"]["ParkingEnableBulkCommand"] | components["schemas"]["ParkingDisableBulkCommand"] | components["schemas"]["ParkingDeleteBulkCommand"])[];
|
|
7046
|
+
commands: (components["schemas"]["DomainCreateCommand"] | components["schemas"]["DomainUpdateCommand"] | components["schemas"]["DomainTransferCommand"] | components["schemas"]["DnsZoneCreateCommand"] | components["schemas"]["DnsZoneUpdateCommand"] | components["schemas"]["DomainCreateBulkCommand"] | components["schemas"]["DomainTransferBulkCommand"] | components["schemas"]["DomainUpdateBulkCommand"] | components["schemas"]["DnsZoneCreateBulkCommand"] | components["schemas"]["DnsZoneUpdateBulkCommand"] | components["schemas"]["DnsZonePatchRrsetsBulkCommand"] | components["schemas"]["DnsZonePatchRecordsBulkCommand"] | components["schemas"]["ContactCreateBulkCommand"] | components["schemas"]["ContactCreateCommand"] | components["schemas"]["ParkingCreateBulkCommand"] | components["schemas"]["ParkingEnableBulkCommand"] | components["schemas"]["ParkingDisableBulkCommand"] | components["schemas"]["ParkingDeleteBulkCommand"] | components["schemas"]["DomainForwardCreateBulkCommand"] | components["schemas"]["DomainForwardUpdateBulkCommand"] | components["schemas"]["DomainForwardEnableBulkCommand"] | components["schemas"]["DomainForwardDisableBulkCommand"] | components["schemas"]["DomainForwardDeleteBulkCommand"])[];
|
|
6809
7047
|
/**
|
|
6810
7048
|
* Label
|
|
6811
7049
|
* @description Human-readable label for this batch
|
|
@@ -8013,11 +8251,11 @@ export interface components {
|
|
|
8013
8251
|
/** Results */
|
|
8014
8252
|
results: components["schemas"]["TagResponse"][];
|
|
8015
8253
|
};
|
|
8016
|
-
/** Pagination[
|
|
8017
|
-
|
|
8254
|
+
/** Pagination[UserPublicWithRole] */
|
|
8255
|
+
Pagination_UserPublicWithRole_: {
|
|
8018
8256
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
8019
8257
|
/** Results */
|
|
8020
|
-
results: components["schemas"]["
|
|
8258
|
+
results: components["schemas"]["UserPublicWithRole"][];
|
|
8021
8259
|
};
|
|
8022
8260
|
/** ParkingActionPayloadData */
|
|
8023
8261
|
ParkingActionPayloadData: {
|
|
@@ -9749,6 +9987,74 @@ export interface components {
|
|
|
9749
9987
|
*/
|
|
9750
9988
|
username: string;
|
|
9751
9989
|
};
|
|
9990
|
+
/** UserPublicWithRole */
|
|
9991
|
+
UserPublicWithRole: {
|
|
9992
|
+
/**
|
|
9993
|
+
* Created On
|
|
9994
|
+
* Format: date-time
|
|
9995
|
+
* @description The date/time the entry was created on
|
|
9996
|
+
*/
|
|
9997
|
+
created_on?: Date;
|
|
9998
|
+
/**
|
|
9999
|
+
* Deleted On
|
|
10000
|
+
* @description The date/time the entry was deleted on
|
|
10001
|
+
*/
|
|
10002
|
+
deleted_on?: Date | null;
|
|
10003
|
+
/**
|
|
10004
|
+
* Email
|
|
10005
|
+
* Format: email
|
|
10006
|
+
* @description The user's email address
|
|
10007
|
+
*/
|
|
10008
|
+
email: string;
|
|
10009
|
+
/**
|
|
10010
|
+
* First Name
|
|
10011
|
+
* @description The user's first name
|
|
10012
|
+
*/
|
|
10013
|
+
first_name: string;
|
|
10014
|
+
/**
|
|
10015
|
+
* Last Name
|
|
10016
|
+
* @description The user's last name
|
|
10017
|
+
*/
|
|
10018
|
+
last_name: string;
|
|
10019
|
+
/**
|
|
10020
|
+
* Locale
|
|
10021
|
+
* @example en_US
|
|
10022
|
+
*/
|
|
10023
|
+
locale: string;
|
|
10024
|
+
/**
|
|
10025
|
+
* Organization Id
|
|
10026
|
+
* Format: typeid
|
|
10027
|
+
* @description The user's organization id
|
|
10028
|
+
* @default None
|
|
10029
|
+
* @example organization_01h45ytscbebyvny4gc8cr8ma2
|
|
10030
|
+
*/
|
|
10031
|
+
organization_id: TypeId<"organization">;
|
|
10032
|
+
/**
|
|
10033
|
+
* Phone
|
|
10034
|
+
* @description The user's phone number
|
|
10035
|
+
* @example +1.2125552368
|
|
10036
|
+
*/
|
|
10037
|
+
phone?: string | null;
|
|
10038
|
+
role?: components["schemas"]["PublicRole"] | null;
|
|
10039
|
+
readonly status: components["schemas"]["UserStatus"];
|
|
10040
|
+
/**
|
|
10041
|
+
* Updated On
|
|
10042
|
+
* Format: date-time
|
|
10043
|
+
* @description The date/time the entry was last updated on
|
|
10044
|
+
*/
|
|
10045
|
+
updated_on?: Date;
|
|
10046
|
+
/**
|
|
10047
|
+
* User Id
|
|
10048
|
+
* Format: typeid
|
|
10049
|
+
* @example user_01h45ytscbebyvny4gc8cr8ma2
|
|
10050
|
+
*/
|
|
10051
|
+
user_id?: TypeId<"user">;
|
|
10052
|
+
/**
|
|
10053
|
+
* Username
|
|
10054
|
+
* @description The user's unique username
|
|
10055
|
+
*/
|
|
10056
|
+
username: string;
|
|
10057
|
+
};
|
|
9752
10058
|
/**
|
|
9753
10059
|
* UserSortField
|
|
9754
10060
|
* @enum {string}
|
|
@@ -9826,8 +10132,8 @@ export interface components {
|
|
|
9826
10132
|
*/
|
|
9827
10133
|
username?: string | null;
|
|
9828
10134
|
};
|
|
9829
|
-
/**
|
|
9830
|
-
|
|
10135
|
+
/** UserWithAuthorization */
|
|
10136
|
+
UserWithAuthorization: {
|
|
9831
10137
|
/**
|
|
9832
10138
|
* Created On
|
|
9833
10139
|
* Format: date-time
|
|
@@ -9876,6 +10182,7 @@ export interface components {
|
|
|
9876
10182
|
* @example +1.2125552368
|
|
9877
10183
|
*/
|
|
9878
10184
|
phone?: string | null;
|
|
10185
|
+
role?: components["schemas"]["PublicRole"] | null;
|
|
9879
10186
|
readonly status: components["schemas"]["UserStatus"];
|
|
9880
10187
|
/**
|
|
9881
10188
|
* Updated On
|
|
@@ -18668,7 +18975,7 @@ export interface operations {
|
|
|
18668
18975
|
[name: string]: unknown;
|
|
18669
18976
|
};
|
|
18670
18977
|
content: {
|
|
18671
|
-
"application/json": components["schemas"]["
|
|
18978
|
+
"application/json": components["schemas"]["Pagination_UserPublicWithRole_"];
|
|
18672
18979
|
};
|
|
18673
18980
|
};
|
|
18674
18981
|
/** @description Unauthorized */
|
|
@@ -20395,7 +20702,7 @@ export interface operations {
|
|
|
20395
20702
|
[name: string]: unknown;
|
|
20396
20703
|
};
|
|
20397
20704
|
content: {
|
|
20398
|
-
"application/json": components["schemas"]["
|
|
20705
|
+
"application/json": components["schemas"]["UserWithAuthorization"];
|
|
20399
20706
|
};
|
|
20400
20707
|
};
|
|
20401
20708
|
/** @description Validation Error */
|