@opusdns/api 1.10.0 → 1.12.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/src/schema.d.ts CHANGED
@@ -4364,6 +4364,11 @@ export interface components {
4364
4364
  * @description The date/time the entry was last updated on
4365
4365
  */
4366
4366
  updated_on?: Date;
4367
+ /**
4368
+ * Vanity Nameserver Set Id
4369
+ * @description Vanity NS set whose apex NS + SOA brand this zone, or null when the zone uses the system default nameservers.
4370
+ */
4371
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
4367
4372
  };
4368
4373
  /** DnsZoneRrsetsCreate */
4369
4374
  DnsZoneRrsetsCreate: {
@@ -4943,6 +4948,73 @@ export interface components {
4943
4948
  /** Results */
4944
4949
  results: components["schemas"]["BrowserStatsBucket"][];
4945
4950
  };
4951
+ /** DomainForwardCreateBulkCommand */
4952
+ DomainForwardCreateBulkCommand: {
4953
+ /**
4954
+ * @description discriminator enum property added by openapi-typescript
4955
+ * @enum {string}
4956
+ */
4957
+ command: "domain_forward_create_bulk";
4958
+ /**
4959
+ * Idempotency Key
4960
+ * @description Idempotency key for this bulk command
4961
+ */
4962
+ idempotency_key?: string | null;
4963
+ /** @description Bulk domain forward create payload */
4964
+ payload: components["schemas"]["DomainForwardCreateBulkPayload"];
4965
+ /**
4966
+ * Version
4967
+ * @description Command version
4968
+ * @default v1
4969
+ */
4970
+ version: string;
4971
+ };
4972
+ /** DomainForwardCreateBulkInstance */
4973
+ DomainForwardCreateBulkInstance: {
4974
+ /**
4975
+ * Enabled
4976
+ * @description Override enabled setting for this hostname
4977
+ */
4978
+ enabled?: boolean | null;
4979
+ /**
4980
+ * Hostname
4981
+ * @description Hostname to create forward for
4982
+ */
4983
+ hostname: string;
4984
+ /** @description Override HTTP redirects */
4985
+ http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
4986
+ /** @description Override HTTPS redirects */
4987
+ https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
4988
+ };
4989
+ /** DomainForwardCreateBulkPayload */
4990
+ DomainForwardCreateBulkPayload: {
4991
+ /**
4992
+ * Instances
4993
+ * @description List of domain forwards to create (1-1000)
4994
+ */
4995
+ instances: components["schemas"]["DomainForwardCreateBulkInstance"][];
4996
+ /** @description Shared settings for all domain forwards */
4997
+ template: components["schemas"]["DomainForwardCreateBulkTemplate"];
4998
+ };
4999
+ /** DomainForwardCreateBulkTemplate */
5000
+ DomainForwardCreateBulkTemplate: {
5001
+ /**
5002
+ * Auto Create Zone
5003
+ * @description Create apex DNS zone automatically when missing
5004
+ * @default false
5005
+ */
5006
+ auto_create_zone: boolean;
5007
+ /**
5008
+ * Enabled
5009
+ * @description Whether domain forward should be enabled
5010
+ * @default false
5011
+ */
5012
+ enabled: boolean;
5013
+ /** @description HTTP redirect definitions */
5014
+ http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5015
+ /** @description HTTPS redirect definitions */
5016
+ https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5017
+ };
4946
5018
  /** DomainForwardCreateRequest */
4947
5019
  DomainForwardCreateRequest: {
4948
5020
  /**
@@ -4955,6 +5027,117 @@ export interface components {
4955
5027
  http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
4956
5028
  https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
4957
5029
  };
5030
+ /** DomainForwardDeleteBulkCommand */
5031
+ DomainForwardDeleteBulkCommand: {
5032
+ /**
5033
+ * @description discriminator enum property added by openapi-typescript
5034
+ * @enum {string}
5035
+ */
5036
+ command: "domain_forward_delete_bulk";
5037
+ /**
5038
+ * Idempotency Key
5039
+ * @description Idempotency key for this bulk command
5040
+ */
5041
+ idempotency_key?: string | null;
5042
+ /** @description Bulk domain forward delete payload */
5043
+ payload: components["schemas"]["DomainForwardDeleteBulkPayload"];
5044
+ /**
5045
+ * Version
5046
+ * @description Command version
5047
+ * @default v1
5048
+ */
5049
+ version: string;
5050
+ };
5051
+ /** DomainForwardDeleteBulkInstance */
5052
+ DomainForwardDeleteBulkInstance: {
5053
+ /**
5054
+ * Hostname
5055
+ * @description Hostname to delete forwarding for
5056
+ */
5057
+ hostname: string;
5058
+ };
5059
+ /** DomainForwardDeleteBulkPayload */
5060
+ DomainForwardDeleteBulkPayload: {
5061
+ /**
5062
+ * Instances
5063
+ * @description List of hostnames to delete forwarding for (1-1000)
5064
+ */
5065
+ instances: components["schemas"]["DomainForwardDeleteBulkInstance"][];
5066
+ };
5067
+ /** DomainForwardDisableBulkCommand */
5068
+ DomainForwardDisableBulkCommand: {
5069
+ /**
5070
+ * @description discriminator enum property added by openapi-typescript
5071
+ * @enum {string}
5072
+ */
5073
+ command: "domain_forward_disable_bulk";
5074
+ /**
5075
+ * Idempotency Key
5076
+ * @description Idempotency key for this bulk command
5077
+ */
5078
+ idempotency_key?: string | null;
5079
+ /** @description Bulk domain forward disable payload */
5080
+ payload: components["schemas"]["DomainForwardDisableBulkPayload"];
5081
+ /**
5082
+ * Version
5083
+ * @description Command version
5084
+ * @default v1
5085
+ */
5086
+ version: string;
5087
+ };
5088
+ /** DomainForwardDisableBulkInstance */
5089
+ DomainForwardDisableBulkInstance: {
5090
+ /**
5091
+ * Hostname
5092
+ * @description Hostname to disable forwarding for
5093
+ */
5094
+ hostname: string;
5095
+ };
5096
+ /** DomainForwardDisableBulkPayload */
5097
+ DomainForwardDisableBulkPayload: {
5098
+ /**
5099
+ * Instances
5100
+ * @description List of hostnames to disable forwarding for (1-1000)
5101
+ */
5102
+ instances: components["schemas"]["DomainForwardDisableBulkInstance"][];
5103
+ };
5104
+ /** DomainForwardEnableBulkCommand */
5105
+ DomainForwardEnableBulkCommand: {
5106
+ /**
5107
+ * @description discriminator enum property added by openapi-typescript
5108
+ * @enum {string}
5109
+ */
5110
+ command: "domain_forward_enable_bulk";
5111
+ /**
5112
+ * Idempotency Key
5113
+ * @description Idempotency key for this bulk command
5114
+ */
5115
+ idempotency_key?: string | null;
5116
+ /** @description Bulk domain forward enable payload */
5117
+ payload: components["schemas"]["DomainForwardEnableBulkPayload"];
5118
+ /**
5119
+ * Version
5120
+ * @description Command version
5121
+ * @default v1
5122
+ */
5123
+ version: string;
5124
+ };
5125
+ /** DomainForwardEnableBulkInstance */
5126
+ DomainForwardEnableBulkInstance: {
5127
+ /**
5128
+ * Hostname
5129
+ * @description Hostname to enable forwarding for
5130
+ */
5131
+ hostname: string;
5132
+ };
5133
+ /** DomainForwardEnableBulkPayload */
5134
+ DomainForwardEnableBulkPayload: {
5135
+ /**
5136
+ * Instances
5137
+ * @description List of hostnames to enable forwarding for (1-1000)
5138
+ */
5139
+ instances: components["schemas"]["DomainForwardEnableBulkInstance"][];
5140
+ };
4958
5141
  /** DomainForwardGeoStatsResponse */
4959
5142
  DomainForwardGeoStatsResponse: {
4960
5143
  /** Results */
@@ -5056,6 +5239,66 @@ export interface components {
5056
5239
  /** Results */
5057
5240
  results: components["schemas"]["StatusCodeStatsBucket"][];
5058
5241
  };
5242
+ /** DomainForwardUpdateBulkCommand */
5243
+ DomainForwardUpdateBulkCommand: {
5244
+ /**
5245
+ * @description discriminator enum property added by openapi-typescript
5246
+ * @enum {string}
5247
+ */
5248
+ command: "domain_forward_update_bulk";
5249
+ /**
5250
+ * Idempotency Key
5251
+ * @description Idempotency key for this bulk command
5252
+ */
5253
+ idempotency_key?: string | null;
5254
+ /** @description Bulk domain forward update payload */
5255
+ payload: components["schemas"]["DomainForwardUpdateBulkPayload"];
5256
+ /**
5257
+ * Version
5258
+ * @description Command version
5259
+ * @default v1
5260
+ */
5261
+ version: string;
5262
+ };
5263
+ /** DomainForwardUpdateBulkInstance */
5264
+ DomainForwardUpdateBulkInstance: {
5265
+ /**
5266
+ * Enabled
5267
+ * @description Override enabled setting for this hostname
5268
+ */
5269
+ enabled?: boolean | null;
5270
+ /**
5271
+ * Hostname
5272
+ * @description Hostname to update forward for
5273
+ */
5274
+ hostname: string;
5275
+ /** @description Override HTTP redirects */
5276
+ http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5277
+ /** @description Override HTTPS redirects */
5278
+ https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5279
+ };
5280
+ /** DomainForwardUpdateBulkPayload */
5281
+ DomainForwardUpdateBulkPayload: {
5282
+ /**
5283
+ * Instances
5284
+ * @description List of domain forwards to update (1-1000)
5285
+ */
5286
+ instances: components["schemas"]["DomainForwardUpdateBulkInstance"][];
5287
+ /** @description Shared settings for all domain forwards */
5288
+ template: components["schemas"]["DomainForwardUpdateBulkTemplate"];
5289
+ };
5290
+ /** DomainForwardUpdateBulkTemplate */
5291
+ DomainForwardUpdateBulkTemplate: {
5292
+ /**
5293
+ * Enabled
5294
+ * @description Whether domain forward should be enabled
5295
+ */
5296
+ enabled: boolean;
5297
+ /** @description HTTP redirect definitions */
5298
+ http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5299
+ /** @description HTTPS redirect definitions */
5300
+ https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
5301
+ };
5059
5302
  /** DomainForwardUserAgentStatsResponse */
5060
5303
  DomainForwardUserAgentStatsResponse: {
5061
5304
  /** Results */
@@ -6805,7 +7048,7 @@ export interface components {
6805
7048
  * Commands
6806
7049
  * @description List of commands to execute
6807
7050
  */
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"])[];
7051
+ 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
7052
  /**
6810
7053
  * Label
6811
7054
  * @description Human-readable label for this batch
@@ -8013,11 +8256,11 @@ export interface components {
8013
8256
  /** Results */
8014
8257
  results: components["schemas"]["TagResponse"][];
8015
8258
  };
8016
- /** Pagination[UserPublic] */
8017
- Pagination_UserPublic_: {
8259
+ /** Pagination[UserPublicWithRole] */
8260
+ Pagination_UserPublicWithRole_: {
8018
8261
  pagination: components["schemas"]["PaginationMetadata"];
8019
8262
  /** Results */
8020
- results: components["schemas"]["UserPublic"][];
8263
+ results: components["schemas"]["UserPublicWithRole"][];
8021
8264
  };
8022
8265
  /** ParkingActionPayloadData */
8023
8266
  ParkingActionPayloadData: {
@@ -9749,6 +9992,74 @@ export interface components {
9749
9992
  */
9750
9993
  username: string;
9751
9994
  };
9995
+ /** UserPublicWithRole */
9996
+ UserPublicWithRole: {
9997
+ /**
9998
+ * Created On
9999
+ * Format: date-time
10000
+ * @description The date/time the entry was created on
10001
+ */
10002
+ created_on?: Date;
10003
+ /**
10004
+ * Deleted On
10005
+ * @description The date/time the entry was deleted on
10006
+ */
10007
+ deleted_on?: Date | null;
10008
+ /**
10009
+ * Email
10010
+ * Format: email
10011
+ * @description The user's email address
10012
+ */
10013
+ email: string;
10014
+ /**
10015
+ * First Name
10016
+ * @description The user's first name
10017
+ */
10018
+ first_name: string;
10019
+ /**
10020
+ * Last Name
10021
+ * @description The user's last name
10022
+ */
10023
+ last_name: string;
10024
+ /**
10025
+ * Locale
10026
+ * @example en_US
10027
+ */
10028
+ locale: string;
10029
+ /**
10030
+ * Organization Id
10031
+ * Format: typeid
10032
+ * @description The user's organization id
10033
+ * @default None
10034
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
10035
+ */
10036
+ organization_id: TypeId<"organization">;
10037
+ /**
10038
+ * Phone
10039
+ * @description The user's phone number
10040
+ * @example +1.2125552368
10041
+ */
10042
+ phone?: string | null;
10043
+ role?: components["schemas"]["PublicRole"] | null;
10044
+ readonly status: components["schemas"]["UserStatus"];
10045
+ /**
10046
+ * Updated On
10047
+ * Format: date-time
10048
+ * @description The date/time the entry was last updated on
10049
+ */
10050
+ updated_on?: Date;
10051
+ /**
10052
+ * User Id
10053
+ * Format: typeid
10054
+ * @example user_01h45ytscbebyvny4gc8cr8ma2
10055
+ */
10056
+ user_id?: TypeId<"user">;
10057
+ /**
10058
+ * Username
10059
+ * @description The user's unique username
10060
+ */
10061
+ username: string;
10062
+ };
9752
10063
  /**
9753
10064
  * UserSortField
9754
10065
  * @enum {string}
@@ -9826,8 +10137,8 @@ export interface components {
9826
10137
  */
9827
10138
  username?: string | null;
9828
10139
  };
9829
- /** UserWithPermissions */
9830
- UserWithPermissions: {
10140
+ /** UserWithAuthorization */
10141
+ UserWithAuthorization: {
9831
10142
  /**
9832
10143
  * Created On
9833
10144
  * Format: date-time
@@ -9876,6 +10187,7 @@ export interface components {
9876
10187
  * @example +1.2125552368
9877
10188
  */
9878
10189
  phone?: string | null;
10190
+ role?: components["schemas"]["PublicRole"] | null;
9879
10191
  readonly status: components["schemas"]["UserStatus"];
9880
10192
  /**
9881
10193
  * Updated On
@@ -18668,7 +18980,7 @@ export interface operations {
18668
18980
  [name: string]: unknown;
18669
18981
  };
18670
18982
  content: {
18671
- "application/json": components["schemas"]["Pagination_UserPublic_"];
18983
+ "application/json": components["schemas"]["Pagination_UserPublicWithRole_"];
18672
18984
  };
18673
18985
  };
18674
18986
  /** @description Unauthorized */
@@ -20395,7 +20707,7 @@ export interface operations {
20395
20707
  [name: string]: unknown;
20396
20708
  };
20397
20709
  content: {
20398
- "application/json": components["schemas"]["UserWithPermissions"];
20710
+ "application/json": components["schemas"]["UserWithAuthorization"];
20399
20711
  };
20400
20712
  };
20401
20713
  /** @description Validation Error */