@opusdns/api 0.284.0 → 0.286.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.284.0",
6
+ "version": "0.286.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -967,23 +967,23 @@ export const DNS_RRSET_TYPE = {
967
967
  AAAA: "AAAA",
968
968
  ALIAS: "ALIAS",
969
969
  CAA: "CAA",
970
- CERT: "CERT",
971
970
  CNAME: "CNAME",
972
971
  DNSKEY: "DNSKEY",
973
972
  DS: "DS",
974
- HTTPS: "HTTPS",
975
973
  MX: "MX",
976
- NAPTR: "NAPTR",
977
974
  NS: "NS",
978
975
  PTR: "PTR",
979
976
  TXT: "TXT",
980
977
  SOA: "SOA",
981
978
  SRV: "SRV",
982
- SMIMEA: "SMIMEA",
983
- SSHFP: "SSHFP",
984
- SVCB: "SVCB",
985
979
  TLSA: "TLSA",
980
+ SMIMEA: "SMIMEA",
986
981
  URI: "URI",
982
+ HTTPS: "HTTPS",
983
+ SVCB: "SVCB",
984
+ NAPTR: "NAPTR",
985
+ SSHFP: "SSHFP",
986
+ CERT: "CERT",
987
987
  } as const satisfies Record<string, DnsRrsetType>;
988
988
 
989
989
  /**
@@ -1012,23 +1012,23 @@ export const DNS_RRSET_TYPE_VALUES = [
1012
1012
  'AAAA',
1013
1013
  'ALIAS',
1014
1014
  'CAA',
1015
- 'CERT',
1016
1015
  'CNAME',
1017
1016
  'DNSKEY',
1018
1017
  'DS',
1019
- 'HTTPS',
1020
1018
  'MX',
1021
- 'NAPTR',
1022
1019
  'NS',
1023
1020
  'PTR',
1024
1021
  'TXT',
1025
1022
  'SOA',
1026
1023
  'SRV',
1024
+ 'TLSA',
1027
1025
  'SMIMEA',
1028
- 'SSHFP',
1026
+ 'URI',
1027
+ 'HTTPS',
1029
1028
  'SVCB',
1030
- 'TLSA',
1031
- 'URI'
1029
+ 'NAPTR',
1030
+ 'SSHFP',
1031
+ 'CERT'
1032
1032
  ] as const satisfies [string, ...string[]] | DnsRrsetType[];
1033
1033
 
1034
1034
  /**
@@ -52,6 +52,7 @@ import { ContactCreateBulkTemplate } from './schemas';
52
52
  import { ContactCreateCommand } from './schemas';
53
53
  import { ContactCreatePayloadData } from './schemas';
54
54
  import { ContactCreateWorkerPayload } from './schemas';
55
+ import { ContactCreateWorkerResult } from './schemas';
55
56
  import { ContactHandle } from './schemas';
56
57
  import { Contact } from './schemas';
57
58
  import { ContactSchema } from './schemas';
@@ -87,6 +88,7 @@ import { DnsZoneCreateBulkTemplate } from './schemas';
87
88
  import { DnsZoneCreateCommand } from './schemas';
88
89
  import { DnsZoneCreatePayloadData } from './schemas';
89
90
  import { DnsZoneCreateWorkerPayload } from './schemas';
91
+ import { DnsZoneCreateWorkerResult } from './schemas';
90
92
  import { DnsZonePatchRecordsBulkCommand } from './schemas';
91
93
  import { DnsZonePatchRecordsBulkInstance } from './schemas';
92
94
  import { DnsZonePatchRecordsBulkPayload } from './schemas';
@@ -120,6 +122,7 @@ import { DomainCreateBulkTemplate } from './schemas';
120
122
  import { DomainCreateCommand } from './schemas';
121
123
  import { DomainCreatePayloadData } from './schemas';
122
124
  import { DomainCreateWorkerPayload } from './schemas';
125
+ import { DomainCreateWorkerResult } from './schemas';
123
126
  import { DomainDnssecDataCreate } from './schemas';
124
127
  import { DomainDnssecData } from './schemas';
125
128
  import { DomainForward } from './schemas';
@@ -4266,6 +4269,82 @@ export const KEYS_CONTACT_CREATE_WORKER_PAYLOAD = [
4266
4269
  KEY_CONTACT_CREATE_WORKER_PAYLOAD_TYPE,
4267
4270
  ] as const satisfies (keyof ContactCreateWorkerPayload)[];
4268
4271
 
4272
+ /**
4273
+ * Contact Id
4274
+ *
4275
+ *
4276
+ * @type {string}
4277
+ *
4278
+ *
4279
+ * @remarks
4280
+ * This key constant provides type-safe access to the `contact_id` property of ContactCreateWorkerResult objects.
4281
+ * Use this constant when you need to access properties dynamically or ensure type safety.
4282
+ *
4283
+ * @example
4284
+ * ```typescript
4285
+ * // Direct property access
4286
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID];
4287
+ *
4288
+ * // Dynamic property access
4289
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID;
4290
+ * const value = contactcreateworkerresult[propertyName];
4291
+ * ```
4292
+ *
4293
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
4294
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
4295
+ */
4296
+ export const KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID: keyof ContactCreateWorkerResult = 'contact_id';
4297
+ /**
4298
+ * Type
4299
+ *
4300
+ *
4301
+ * @type {string}
4302
+ *
4303
+ *
4304
+ * @remarks
4305
+ * This key constant provides type-safe access to the `type` property of ContactCreateWorkerResult objects.
4306
+ * Use this constant when you need to access properties dynamically or ensure type safety.
4307
+ *
4308
+ * @example
4309
+ * ```typescript
4310
+ * // Direct property access
4311
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_TYPE];
4312
+ *
4313
+ * // Dynamic property access
4314
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_TYPE;
4315
+ * const value = contactcreateworkerresult[propertyName];
4316
+ * ```
4317
+ *
4318
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
4319
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
4320
+ */
4321
+ export const KEY_CONTACT_CREATE_WORKER_RESULT_TYPE: keyof ContactCreateWorkerResult = 'type';
4322
+
4323
+ /**
4324
+ * Array of all ContactCreateWorkerResult property keys
4325
+ *
4326
+ * @remarks
4327
+ * This constant provides a readonly array containing all valid property keys for ContactCreateWorkerResult objects.
4328
+ * Useful for iteration, validation, and generating dynamic UI components.
4329
+ *
4330
+ * @example
4331
+ * ```typescript
4332
+ * // Iterating through all keys
4333
+ * for (const key of KEYS_CONTACT_CREATE_WORKER_RESULT) {
4334
+ * console.log(`Property: ${key}, Value: ${contactcreateworkerresult[key]}`);
4335
+ * }
4336
+ *
4337
+ * // Validation
4338
+ * const isValidKey = KEYS_CONTACT_CREATE_WORKER_RESULT.includes(someKey);
4339
+ * ```
4340
+ *
4341
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
4342
+ */
4343
+ export const KEYS_CONTACT_CREATE_WORKER_RESULT = [
4344
+ KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID,
4345
+ KEY_CONTACT_CREATE_WORKER_RESULT_TYPE,
4346
+ ] as const satisfies (keyof ContactCreateWorkerResult)[];
4347
+
4269
4348
  /**
4270
4349
  * Attributes
4271
4350
  *
@@ -9736,6 +9815,82 @@ export const KEYS_DNS_ZONE_CREATE_WORKER_PAYLOAD = [
9736
9815
  KEY_DNS_ZONE_CREATE_WORKER_PAYLOAD_ZONE,
9737
9816
  ] as const satisfies (keyof DnsZoneCreateWorkerPayload)[];
9738
9817
 
9818
+ /**
9819
+ * Type
9820
+ *
9821
+ *
9822
+ * @type {string}
9823
+ *
9824
+ *
9825
+ * @remarks
9826
+ * This key constant provides type-safe access to the `type` property of DnsZoneCreateWorkerResult objects.
9827
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9828
+ *
9829
+ * @example
9830
+ * ```typescript
9831
+ * // Direct property access
9832
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE];
9833
+ *
9834
+ * // Dynamic property access
9835
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE;
9836
+ * const value = dnszonecreateworkerresult[propertyName];
9837
+ * ```
9838
+ *
9839
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
9840
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
9841
+ */
9842
+ export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE: keyof DnsZoneCreateWorkerResult = 'type';
9843
+ /**
9844
+ * Zone Name
9845
+ *
9846
+ *
9847
+ * @type {string}
9848
+ *
9849
+ *
9850
+ * @remarks
9851
+ * This key constant provides type-safe access to the `zone_name` property of DnsZoneCreateWorkerResult objects.
9852
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9853
+ *
9854
+ * @example
9855
+ * ```typescript
9856
+ * // Direct property access
9857
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME];
9858
+ *
9859
+ * // Dynamic property access
9860
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME;
9861
+ * const value = dnszonecreateworkerresult[propertyName];
9862
+ * ```
9863
+ *
9864
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
9865
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
9866
+ */
9867
+ export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME: keyof DnsZoneCreateWorkerResult = 'zone_name';
9868
+
9869
+ /**
9870
+ * Array of all DnsZoneCreateWorkerResult property keys
9871
+ *
9872
+ * @remarks
9873
+ * This constant provides a readonly array containing all valid property keys for DnsZoneCreateWorkerResult objects.
9874
+ * Useful for iteration, validation, and generating dynamic UI components.
9875
+ *
9876
+ * @example
9877
+ * ```typescript
9878
+ * // Iterating through all keys
9879
+ * for (const key of KEYS_DNS_ZONE_CREATE_WORKER_RESULT) {
9880
+ * console.log(`Property: ${key}, Value: ${dnszonecreateworkerresult[key]}`);
9881
+ * }
9882
+ *
9883
+ * // Validation
9884
+ * const isValidKey = KEYS_DNS_ZONE_CREATE_WORKER_RESULT.includes(someKey);
9885
+ * ```
9886
+ *
9887
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
9888
+ */
9889
+ export const KEYS_DNS_ZONE_CREATE_WORKER_RESULT = [
9890
+ KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE,
9891
+ KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME,
9892
+ ] as const satisfies (keyof DnsZoneCreateWorkerResult)[];
9893
+
9739
9894
  /**
9740
9895
  * Command
9741
9896
  *
@@ -13351,6 +13506,82 @@ export const KEYS_DOMAIN_CREATE_WORKER_PAYLOAD = [
13351
13506
  KEY_DOMAIN_CREATE_WORKER_PAYLOAD_TYPE,
13352
13507
  ] as const satisfies (keyof DomainCreateWorkerPayload)[];
13353
13508
 
13509
+ /**
13510
+ * Domain Id
13511
+ *
13512
+ *
13513
+ * @type {string}
13514
+ *
13515
+ *
13516
+ * @remarks
13517
+ * This key constant provides type-safe access to the `domain_id` property of DomainCreateWorkerResult objects.
13518
+ * Use this constant when you need to access properties dynamically or ensure type safety.
13519
+ *
13520
+ * @example
13521
+ * ```typescript
13522
+ * // Direct property access
13523
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID];
13524
+ *
13525
+ * // Dynamic property access
13526
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID;
13527
+ * const value = domaincreateworkerresult[propertyName];
13528
+ * ```
13529
+ *
13530
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
13531
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
13532
+ */
13533
+ export const KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID: keyof DomainCreateWorkerResult = 'domain_id';
13534
+ /**
13535
+ * Type
13536
+ *
13537
+ *
13538
+ * @type {string}
13539
+ *
13540
+ *
13541
+ * @remarks
13542
+ * This key constant provides type-safe access to the `type` property of DomainCreateWorkerResult objects.
13543
+ * Use this constant when you need to access properties dynamically or ensure type safety.
13544
+ *
13545
+ * @example
13546
+ * ```typescript
13547
+ * // Direct property access
13548
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE];
13549
+ *
13550
+ * // Dynamic property access
13551
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE;
13552
+ * const value = domaincreateworkerresult[propertyName];
13553
+ * ```
13554
+ *
13555
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
13556
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
13557
+ */
13558
+ export const KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE: keyof DomainCreateWorkerResult = 'type';
13559
+
13560
+ /**
13561
+ * Array of all DomainCreateWorkerResult property keys
13562
+ *
13563
+ * @remarks
13564
+ * This constant provides a readonly array containing all valid property keys for DomainCreateWorkerResult objects.
13565
+ * Useful for iteration, validation, and generating dynamic UI components.
13566
+ *
13567
+ * @example
13568
+ * ```typescript
13569
+ * // Iterating through all keys
13570
+ * for (const key of KEYS_DOMAIN_CREATE_WORKER_RESULT) {
13571
+ * console.log(`Property: ${key}, Value: ${domaincreateworkerresult[key]}`);
13572
+ * }
13573
+ *
13574
+ * // Validation
13575
+ * const isValidKey = KEYS_DOMAIN_CREATE_WORKER_RESULT.includes(someKey);
13576
+ * ```
13577
+ *
13578
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
13579
+ */
13580
+ export const KEYS_DOMAIN_CREATE_WORKER_RESULT = [
13581
+ KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID,
13582
+ KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE,
13583
+ ] as const satisfies (keyof DomainCreateWorkerResult)[];
13584
+
13354
13585
  /**
13355
13586
  * algorithm property
13356
13587
  *
@@ -26665,6 +26896,31 @@ export const KEY_JOB_PAYLOAD: keyof Job = 'payload';
26665
26896
  * @see {@link KEYS_JOB} - Array of all keys for this type
26666
26897
  */
26667
26898
  export const KEY_JOB_RESOURCE_KEY: keyof Job = 'resource_key';
26899
+ /**
26900
+ * Result
26901
+ *
26902
+ * Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
26903
+ *
26904
+ *
26905
+ *
26906
+ * @remarks
26907
+ * This key constant provides type-safe access to the `result` property of Job objects.
26908
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26909
+ *
26910
+ * @example
26911
+ * ```typescript
26912
+ * // Direct property access
26913
+ * const value = job[KEY_JOB_RESULT];
26914
+ *
26915
+ * // Dynamic property access
26916
+ * const propertyName = KEY_JOB_RESULT;
26917
+ * const value = job[propertyName];
26918
+ * ```
26919
+ *
26920
+ * @see {@link Job} - The TypeScript type definition
26921
+ * @see {@link KEYS_JOB} - Array of all keys for this type
26922
+ */
26923
+ export const KEY_JOB_RESULT: keyof Job = 'result';
26668
26924
  /**
26669
26925
  * Started At
26670
26926
  *
@@ -26750,6 +27006,7 @@ export const KEYS_JOB = [
26750
27006
  KEY_JOB_PAUSED_AT,
26751
27007
  KEY_JOB_PAYLOAD,
26752
27008
  KEY_JOB_RESOURCE_KEY,
27009
+ KEY_JOB_RESULT,
26753
27010
  KEY_JOB_STARTED_AT,
26754
27011
  KEY_JOB_STATUS,
26755
27012
  ] as const satisfies (keyof Job)[];
@@ -570,6 +570,22 @@ export type ContactCreatePayloadData = components['schemas']['ContactCreatePaylo
570
570
  * @see {@link components} - The OpenAPI components schema definition
571
571
  */
572
572
  export type ContactCreateWorkerPayload = components['schemas']['ContactCreateWorkerPayload'];
573
+ /**
574
+ * ContactCreateWorkerResult
575
+ *
576
+ * @remarks
577
+ * Type alias for the `ContactCreateWorkerResult` OpenAPI schema.
578
+ * This type represents contactcreateworkerresult data structures used in API requests and responses.
579
+ *
580
+ * @example
581
+ * ```typescript
582
+ * const response = await api.getContactCreateWorkerResult();
583
+ * const item: ContactCreateWorkerResult = response.results;
584
+ * ```
585
+ *
586
+ * @see {@link components} - The OpenAPI components schema definition
587
+ */
588
+ export type ContactCreateWorkerResult = components['schemas']['ContactCreateWorkerResult'];
573
589
  /**
574
590
  * ContactHandle
575
591
  *
@@ -1258,6 +1274,22 @@ export type DnsZoneCreatePayloadData = components['schemas']['DnsZoneCreatePaylo
1258
1274
  * @see {@link components} - The OpenAPI components schema definition
1259
1275
  */
1260
1276
  export type DnsZoneCreateWorkerPayload = components['schemas']['DnsZoneCreateWorkerPayload'];
1277
+ /**
1278
+ * DnsZoneCreateWorkerResult
1279
+ *
1280
+ * @remarks
1281
+ * Type alias for the `DnsZoneCreateWorkerResult` OpenAPI schema.
1282
+ * This type represents dnszonecreateworkerresult data structures used in API requests and responses.
1283
+ *
1284
+ * @example
1285
+ * ```typescript
1286
+ * const response = await api.getDnsZoneCreateWorkerResult();
1287
+ * const item: DnsZoneCreateWorkerResult = response.results;
1288
+ * ```
1289
+ *
1290
+ * @see {@link components} - The OpenAPI components schema definition
1291
+ */
1292
+ export type DnsZoneCreateWorkerResult = components['schemas']['DnsZoneCreateWorkerResult'];
1261
1293
  /**
1262
1294
  * DnsZonePatchRecordsBulkCommand
1263
1295
  *
@@ -1946,6 +1978,22 @@ export type DomainCreatePayloadData = components['schemas']['DomainCreatePayload
1946
1978
  * @see {@link components} - The OpenAPI components schema definition
1947
1979
  */
1948
1980
  export type DomainCreateWorkerPayload = components['schemas']['DomainCreateWorkerPayload'];
1981
+ /**
1982
+ * DomainCreateWorkerResult
1983
+ *
1984
+ * @remarks
1985
+ * Type alias for the `DomainCreateWorkerResult` OpenAPI schema.
1986
+ * This type represents domaincreateworkerresult data structures used in API requests and responses.
1987
+ *
1988
+ * @example
1989
+ * ```typescript
1990
+ * const response = await api.getDomainCreateWorkerResult();
1991
+ * const item: DomainCreateWorkerResult = response.results;
1992
+ * ```
1993
+ *
1994
+ * @see {@link components} - The OpenAPI components schema definition
1995
+ */
1996
+ export type DomainCreateWorkerResult = components['schemas']['DomainCreateWorkerResult'];
1949
1997
  /**
1950
1998
  * DomainDnssecDataCreate
1951
1999
  *
package/src/openapi.yaml CHANGED
@@ -1035,6 +1035,22 @@ components:
1035
1035
  - contact
1036
1036
  title: ContactCreateWorkerPayload
1037
1037
  type: object
1038
+ ContactCreateWorkerResult:
1039
+ properties:
1040
+ contact_id:
1041
+ title: Contact Id
1042
+ type: string
1043
+ type:
1044
+ enum:
1045
+ - contact_create
1046
+ - contact_create_bulk
1047
+ title: Type
1048
+ type: string
1049
+ required:
1050
+ - type
1051
+ - contact_id
1052
+ title: ContactCreateWorkerResult
1053
+ type: object
1038
1054
  ContactHandle:
1039
1055
  properties:
1040
1056
  attributes:
@@ -2104,23 +2120,23 @@ components:
2104
2120
  - AAAA
2105
2121
  - ALIAS
2106
2122
  - CAA
2107
- - CERT
2108
2123
  - CNAME
2109
2124
  - DNSKEY
2110
2125
  - DS
2111
- - HTTPS
2112
2126
  - MX
2113
- - NAPTR
2114
2127
  - NS
2115
2128
  - PTR
2116
2129
  - TXT
2117
2130
  - SOA
2118
2131
  - SRV
2119
- - SMIMEA
2120
- - SSHFP
2121
- - SVCB
2122
2132
  - TLSA
2133
+ - SMIMEA
2123
2134
  - URI
2135
+ - HTTPS
2136
+ - SVCB
2137
+ - NAPTR
2138
+ - SSHFP
2139
+ - CERT
2124
2140
  title: DnsRrsetType
2125
2141
  type: string
2126
2142
  DnsRrsetWithOneRecordPatch:
@@ -2301,6 +2317,22 @@ components:
2301
2317
  - zone
2302
2318
  title: DnsZoneCreateWorkerPayload
2303
2319
  type: object
2320
+ DnsZoneCreateWorkerResult:
2321
+ properties:
2322
+ type:
2323
+ enum:
2324
+ - dns_zone_create
2325
+ - dns_zone_create_bulk
2326
+ title: Type
2327
+ type: string
2328
+ zone_name:
2329
+ title: Zone Name
2330
+ type: string
2331
+ required:
2332
+ - type
2333
+ - zone_name
2334
+ title: DnsZoneCreateWorkerResult
2335
+ type: object
2304
2336
  DnsZonePatchRecordsBulkCommand:
2305
2337
  properties:
2306
2338
  command:
@@ -3168,6 +3200,22 @@ components:
3168
3200
  - domain
3169
3201
  title: DomainCreateWorkerPayload
3170
3202
  type: object
3203
+ DomainCreateWorkerResult:
3204
+ properties:
3205
+ domain_id:
3206
+ title: Domain Id
3207
+ type: string
3208
+ type:
3209
+ enum:
3210
+ - domain_create
3211
+ - domain_create_bulk
3212
+ title: Type
3213
+ type: string
3214
+ required:
3215
+ - type
3216
+ - domain_id
3217
+ title: DomainCreateWorkerResult
3218
+ type: object
3171
3219
  DomainDnssecDataCreate:
3172
3220
  properties:
3173
3221
  algorithm:
@@ -6406,6 +6454,28 @@ components:
6406
6454
  - type: 'null'
6407
6455
  description: Resource identifier for this job
6408
6456
  title: Resource Key
6457
+ result:
6458
+ anyOf:
6459
+ - discriminator:
6460
+ mapping:
6461
+ contact_create: '#/components/schemas/ContactCreateWorkerResult'
6462
+ contact_create_bulk: '#/components/schemas/ContactCreateWorkerResult'
6463
+ dns_zone_create: '#/components/schemas/DnsZoneCreateWorkerResult'
6464
+ dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateWorkerResult'
6465
+ domain_create: '#/components/schemas/DomainCreateWorkerResult'
6466
+ domain_create_bulk: '#/components/schemas/DomainCreateWorkerResult'
6467
+ propertyName: type
6468
+ oneOf:
6469
+ - $ref: '#/components/schemas/ContactCreateWorkerResult'
6470
+ - $ref: '#/components/schemas/DomainCreateWorkerResult'
6471
+ - $ref: '#/components/schemas/DnsZoneCreateWorkerResult'
6472
+ - additionalProperties: true
6473
+ type: object
6474
+ - type: 'null'
6475
+ description: Structured result data from successful job execution (e.g.
6476
+ created entity IDs). Typed when the worker emits a known `type` discriminator;
6477
+ raw dict otherwise.
6478
+ title: Result
6409
6479
  started_at:
6410
6480
  anyOf:
6411
6481
  - format: date-time
@@ -10690,7 +10760,7 @@ info:
10690
10760
  \n\n"
10691
10761
  summary: OpusDNS - your gateway to a seamless domain management experience.
10692
10762
  title: OpusDNS API
10693
- version: 2026-05-05-201917
10763
+ version: 2026-05-06-130436
10694
10764
  x-logo:
10695
10765
  altText: OpusDNS API Reference
10696
10766
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -3115,6 +3115,16 @@ export interface components {
3115
3115
  */
3116
3116
  type: "contact_create" | "contact_create_bulk";
3117
3117
  };
3118
+ /** ContactCreateWorkerResult */
3119
+ ContactCreateWorkerResult: {
3120
+ /** Contact Id */
3121
+ contact_id: string;
3122
+ /**
3123
+ * @description discriminator enum property added by openapi-typescript
3124
+ * @enum {string}
3125
+ */
3126
+ type: "contact_create" | "contact_create_bulk";
3127
+ };
3118
3128
  /** ContactHandle */
3119
3129
  ContactHandle: {
3120
3130
  /**
@@ -3867,7 +3877,7 @@ export interface components {
3867
3877
  * DnsRrsetType
3868
3878
  * @enum {string}
3869
3879
  */
3870
- DnsRrsetType: "A" | "AAAA" | "ALIAS" | "CAA" | "CERT" | "CNAME" | "DNSKEY" | "DS" | "HTTPS" | "MX" | "NAPTR" | "NS" | "PTR" | "TXT" | "SOA" | "SRV" | "SMIMEA" | "SSHFP" | "SVCB" | "TLSA" | "URI";
3880
+ DnsRrsetType: "A" | "AAAA" | "ALIAS" | "CAA" | "CNAME" | "DNSKEY" | "DS" | "MX" | "NS" | "PTR" | "TXT" | "SOA" | "SRV" | "TLSA" | "SMIMEA" | "URI" | "HTTPS" | "SVCB" | "NAPTR" | "SSHFP" | "CERT";
3871
3881
  /** DnsRrsetWithOneRecordPatch */
3872
3882
  DnsRrsetWithOneRecordPatch: {
3873
3883
  /** Name */
@@ -3987,6 +3997,16 @@ export interface components {
3987
3997
  type: "dns_zone_create" | "dns_zone_create_bulk";
3988
3998
  zone: components["schemas"]["DnsZoneCreatePayloadData"];
3989
3999
  };
4000
+ /** DnsZoneCreateWorkerResult */
4001
+ DnsZoneCreateWorkerResult: {
4002
+ /**
4003
+ * @description discriminator enum property added by openapi-typescript
4004
+ * @enum {string}
4005
+ */
4006
+ type: "dns_zone_create" | "dns_zone_create_bulk";
4007
+ /** Zone Name */
4008
+ zone_name: string;
4009
+ };
3990
4010
  /** DnsZonePatchRecordsBulkCommand */
3991
4011
  DnsZonePatchRecordsBulkCommand: {
3992
4012
  /**
@@ -4548,6 +4568,16 @@ export interface components {
4548
4568
  */
4549
4569
  type: "domain_create" | "domain_create_bulk";
4550
4570
  };
4571
+ /** DomainCreateWorkerResult */
4572
+ DomainCreateWorkerResult: {
4573
+ /** Domain Id */
4574
+ domain_id: string;
4575
+ /**
4576
+ * @description discriminator enum property added by openapi-typescript
4577
+ * @enum {string}
4578
+ */
4579
+ type: "domain_create" | "domain_create_bulk";
4580
+ };
4551
4581
  /** DomainDnssecDataCreate */
4552
4582
  DomainDnssecDataCreate: {
4553
4583
  /** @description DNSSEC algorithm used */
@@ -6730,6 +6760,13 @@ export interface components {
6730
6760
  * @description Resource identifier for this job
6731
6761
  */
6732
6762
  resource_key?: string | null;
6763
+ /**
6764
+ * Result
6765
+ * @description Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
6766
+ */
6767
+ result?: (components["schemas"]["ContactCreateWorkerResult"] | components["schemas"]["DomainCreateWorkerResult"] | components["schemas"]["DnsZoneCreateWorkerResult"]) | {
6768
+ [key: string]: unknown;
6769
+ } | null;
6733
6770
  /**
6734
6771
  * Started At
6735
6772
  * @description Timestamp when job execution began (UTC)