@opusdns/api 1.12.0 → 1.14.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": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.12.0",
6
+ "version": "1.14.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -52,6 +52,7 @@ import type {
52
52
  HolderEntitlement,
53
53
  HostStatus,
54
54
  HttpProtocol,
55
+ IPAddressType,
55
56
  InvoiceResponsePaymentStatus,
56
57
  InvoiceResponseStatus,
57
58
  InvoiceResponseType,
@@ -989,6 +990,16 @@ export const HTTP_PROTOCOL_VALUES = [
989
990
  'https',
990
991
  ] as const satisfies ReadonlyArray<HttpProtocol>;
991
992
 
993
+ export const IP_ADDRESS_TYPE = {
994
+ V4: "v4",
995
+ V6: "v6",
996
+ } as const satisfies Record<string, IPAddressType>;
997
+
998
+ export const IP_ADDRESS_TYPE_VALUES = [
999
+ 'v4',
1000
+ 'v6',
1001
+ ] as const satisfies ReadonlyArray<IPAddressType>;
1002
+
992
1003
  export const INVOICE_RESPONSE_PAYMENT_STATUS = {
993
1004
  PENDING: "pending",
994
1005
  FAILED: "failed",
@@ -1549,6 +1560,7 @@ export const REPORT_TYPE = {
1549
1560
  DOMAIN_FORWARDS: "domain_forwards",
1550
1561
  EXPIRING_DOMAINS: "expiring_domains",
1551
1562
  EMAIL_FORWARDS: "email_forwards",
1563
+ REGISTRAR_PORTFOLIO_PDF: "registrar_portfolio_pdf",
1552
1564
  BILLING_TRANSACTIONS: "billing_transactions",
1553
1565
  BILLING_TRANSACTIONS_MONTHLY: "billing_transactions_monthly",
1554
1566
  } as const satisfies Record<string, ReportType>;
@@ -1560,6 +1572,7 @@ export const REPORT_TYPE_VALUES = [
1560
1572
  'domain_forwards',
1561
1573
  'expiring_domains',
1562
1574
  'email_forwards',
1575
+ 'registrar_portfolio_pdf',
1563
1576
  'billing_transactions',
1564
1577
  'billing_transactions_monthly',
1565
1578
  ] as const satisfies ReadonlyArray<ReportType>;
@@ -198,7 +198,11 @@ import type {
198
198
  GeoStatsBucket,
199
199
  GetPrices,
200
200
  HTTPValidationError,
201
+ HostCreate,
202
+ HostIpSchema,
203
+ Host,
201
204
  HostSchema,
205
+ HostUpdate,
202
206
  HttpRedirectList,
203
207
  HttpRedirectRemove,
204
208
  HttpRedirectRequest,
@@ -1048,9 +1052,11 @@ export const KEYS_CREATE_JOB_BATCH = [
1048
1052
  KEY_CREATE_JOB_BATCH_TOTAL_COMMANDS,
1049
1053
  ] as const satisfies (keyof CreateJobBatch)[];
1050
1054
 
1055
+ export const KEY_CREATE_REPORT_REQ_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof CreateReportReq;
1051
1056
  export const KEY_CREATE_REPORT_REQ_REPORT_TYPE = 'report_type' satisfies keyof CreateReportReq;
1052
1057
 
1053
1058
  export const KEYS_CREATE_REPORT_REQ = [
1059
+ KEY_CREATE_REPORT_REQ_REGISTRAR_CREDENTIAL_ID,
1054
1060
  KEY_CREATE_REPORT_REQ_REPORT_TYPE,
1055
1061
  ] as const satisfies (keyof CreateReportReq)[];
1056
1062
 
@@ -2784,6 +2790,44 @@ export const KEYS_HTTP_VALIDATION_ERROR = [
2784
2790
  KEY_HTTP_VALIDATION_ERROR_TYPE,
2785
2791
  ] as const satisfies (keyof HTTPValidationError)[];
2786
2792
 
2793
+ export const KEY_HOST_CREATE_HOSTNAME = 'hostname' satisfies keyof HostCreate;
2794
+ export const KEY_HOST_CREATE_IP_ADDRESSES = 'ip_addresses' satisfies keyof HostCreate;
2795
+
2796
+ export const KEYS_HOST_CREATE = [
2797
+ KEY_HOST_CREATE_HOSTNAME,
2798
+ KEY_HOST_CREATE_IP_ADDRESSES,
2799
+ ] as const satisfies (keyof HostCreate)[];
2800
+
2801
+ export const KEY_HOST_IP_SCHEMA_ADDRESS = 'address' satisfies keyof HostIpSchema;
2802
+ export const KEY_HOST_IP_SCHEMA_CREATED_ON = 'created_on' satisfies keyof HostIpSchema;
2803
+ export const KEY_HOST_IP_SCHEMA_HOST_ID = 'host_id' satisfies keyof HostIpSchema;
2804
+ export const KEY_HOST_IP_SCHEMA_HOST_IP_ID = 'host_ip_id' satisfies keyof HostIpSchema;
2805
+ export const KEY_HOST_IP_SCHEMA_TYPE = 'type' satisfies keyof HostIpSchema;
2806
+ export const KEY_HOST_IP_SCHEMA_UPDATED_ON = 'updated_on' satisfies keyof HostIpSchema;
2807
+
2808
+ export const KEYS_HOST_IP_SCHEMA = [
2809
+ KEY_HOST_IP_SCHEMA_ADDRESS,
2810
+ KEY_HOST_IP_SCHEMA_CREATED_ON,
2811
+ KEY_HOST_IP_SCHEMA_HOST_ID,
2812
+ KEY_HOST_IP_SCHEMA_HOST_IP_ID,
2813
+ KEY_HOST_IP_SCHEMA_TYPE,
2814
+ KEY_HOST_IP_SCHEMA_UPDATED_ON,
2815
+ ] as const satisfies (keyof HostIpSchema)[];
2816
+
2817
+ export const KEY_HOST_CREATED_ON = 'created_on' satisfies keyof Host;
2818
+ export const KEY_HOST_HOST_ID = 'host_id' satisfies keyof Host;
2819
+ export const KEY_HOST_HOSTNAME = 'hostname' satisfies keyof Host;
2820
+ export const KEY_HOST_IP_ADDRESSES = 'ip_addresses' satisfies keyof Host;
2821
+ export const KEY_HOST_UPDATED_ON = 'updated_on' satisfies keyof Host;
2822
+
2823
+ export const KEYS_HOST = [
2824
+ KEY_HOST_CREATED_ON,
2825
+ KEY_HOST_HOST_ID,
2826
+ KEY_HOST_HOSTNAME,
2827
+ KEY_HOST_IP_ADDRESSES,
2828
+ KEY_HOST_UPDATED_ON,
2829
+ ] as const satisfies (keyof Host)[];
2830
+
2787
2831
  export const KEY_HOST_SCHEMA_CREATED_ON = 'created_on' satisfies keyof HostSchema;
2788
2832
  export const KEY_HOST_SCHEMA_DOMAIN_ID = 'domain_id' satisfies keyof HostSchema;
2789
2833
  export const KEY_HOST_SCHEMA_HOST_ID = 'host_id' satisfies keyof HostSchema;
@@ -2802,6 +2846,12 @@ export const KEYS_HOST_SCHEMA = [
2802
2846
  KEY_HOST_SCHEMA_UPDATED_ON,
2803
2847
  ] as const satisfies (keyof HostSchema)[];
2804
2848
 
2849
+ export const KEY_HOST_UPDATE_IP_ADDRESSES = 'ip_addresses' satisfies keyof HostUpdate;
2850
+
2851
+ export const KEYS_HOST_UPDATE = [
2852
+ KEY_HOST_UPDATE_IP_ADDRESSES,
2853
+ ] as const satisfies (keyof HostUpdate)[];
2854
+
2805
2855
  export const KEY_HTTP_REDIRECT_LIST_PROTECTED = 'protected' satisfies keyof HttpRedirectList;
2806
2856
  export const KEY_HTTP_REDIRECT_LIST_REDIRECT_CODE = 'redirect_code' satisfies keyof HttpRedirectList;
2807
2857
  export const KEY_HTTP_REDIRECT_LIST_REQUEST_HOSTNAME = 'request_hostname' satisfies keyof HttpRedirectList;
@@ -29,6 +29,8 @@ import type {
29
29
  EmailForwardAliasCreate,
30
30
  EmailForwardAliasUpdate,
31
31
  EmailForwardCreate,
32
+ HostCreate,
33
+ HostUpdate,
32
34
  IpRestrictionCreate,
33
35
  IpRestrictionUpdate,
34
36
  JobBatchRequest,
@@ -654,6 +656,28 @@ export type PATCH_EventsByEventId_Request = {
654
656
  };
655
657
  export type PATCH_EventsByEventId_Request_Path = PATCH_EventsByEventId_Request['parameters']['path'];
656
658
 
659
+ export type POST_Hosts_Request = {
660
+ requestBody: HostCreate;
661
+ };
662
+ export type POST_Hosts_Request_Body = POST_Hosts_Request['requestBody'];
663
+
664
+ export type DELETE_HostsByHostReference_Request = {
665
+ parameters: operations['delete_host_v1_hosts__host_reference__delete']['parameters'];
666
+ };
667
+ export type DELETE_HostsByHostReference_Request_Path = DELETE_HostsByHostReference_Request['parameters']['path'];
668
+
669
+ export type GET_HostsByHostReference_Request = {
670
+ parameters: operations['get_host_v1_hosts__host_reference__get']['parameters'];
671
+ };
672
+ export type GET_HostsByHostReference_Request_Path = GET_HostsByHostReference_Request['parameters']['path'];
673
+
674
+ export type PUT_HostsByHostReference_Request = {
675
+ parameters: operations['update_host_v1_hosts__host_reference__put']['parameters'];
676
+ requestBody: HostUpdate;
677
+ };
678
+ export type PUT_HostsByHostReference_Request_Path = PUT_HostsByHostReference_Request['parameters']['path'];
679
+ export type PUT_HostsByHostReference_Request_Body = PUT_HostsByHostReference_Request['requestBody'];
680
+
657
681
  export type DELETE_JobByJobId_Request = {
658
682
  parameters: operations['delete_job_v1_job__job_id__delete']['parameters'];
659
683
  };
@@ -44,6 +44,7 @@ import type {
44
44
  EventResponse,
45
45
  GetPrices,
46
46
  HTTPValidationError,
47
+ Host,
47
48
  IpRestriction,
48
49
  Job,
49
50
  JobBatchRetry,
@@ -174,6 +175,14 @@ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 =
174
175
  export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem;
175
176
  export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError;
176
177
 
178
+ export type DELETE_HostsByHostReference_Response = DELETE_HostsByHostReference_Response_401 | DELETE_HostsByHostReference_Response_403 | DELETE_HostsByHostReference_Response_404 | DELETE_HostsByHostReference_Response_409 | DELETE_HostsByHostReference_Response_422;
179
+
180
+ export type DELETE_HostsByHostReference_Response_401 = Problem;
181
+ export type DELETE_HostsByHostReference_Response_403 = Problem;
182
+ export type DELETE_HostsByHostReference_Response_404 = Problem;
183
+ export type DELETE_HostsByHostReference_Response_409 = Problem;
184
+ export type DELETE_HostsByHostReference_Response_422 = HTTPValidationError;
185
+
177
186
  export type DELETE_JobByJobId_Response = DELETE_JobByJobId_Response_404 | DELETE_JobByJobId_Response_422;
178
187
 
179
188
  export type DELETE_JobByJobId_Response_404 = Problem;
@@ -547,6 +556,14 @@ export type GET_EventsByEventId_Response_401 = Problem;
547
556
  export type GET_EventsByEventId_Response_404 = Problem;
548
557
  export type GET_EventsByEventId_Response_422 = HTTPValidationError;
549
558
 
559
+ export type GET_HostsByHostReference_Response = GET_HostsByHostReference_Response_200 | GET_HostsByHostReference_Response_401 | GET_HostsByHostReference_Response_403 | GET_HostsByHostReference_Response_404 | GET_HostsByHostReference_Response_422;
560
+
561
+ export type GET_HostsByHostReference_Response_200 = Host;
562
+ export type GET_HostsByHostReference_Response_401 = Problem;
563
+ export type GET_HostsByHostReference_Response_403 = Problem;
564
+ export type GET_HostsByHostReference_Response_404 = Problem;
565
+ export type GET_HostsByHostReference_Response_422 = HTTPValidationError;
566
+
550
567
  export type GET_JobByJobId_Response = GET_JobByJobId_Response_200 | GET_JobByJobId_Response_404 | GET_JobByJobId_Response_422;
551
568
 
552
569
  export type GET_JobByJobId_Response_200 = Job;
@@ -1062,6 +1079,15 @@ export type POST_EmailForwardsByEmailForwardIdAliases_Response_404 = Problem;
1062
1079
  export type POST_EmailForwardsByEmailForwardIdAliases_Response_409 = Problem;
1063
1080
  export type POST_EmailForwardsByEmailForwardIdAliases_Response_422 = HTTPValidationError;
1064
1081
 
1082
+ export type POST_Hosts_Response = POST_Hosts_Response_201 | POST_Hosts_Response_401 | POST_Hosts_Response_403 | POST_Hosts_Response_404 | POST_Hosts_Response_409 | POST_Hosts_Response_422;
1083
+
1084
+ export type POST_Hosts_Response_201 = Host;
1085
+ export type POST_Hosts_Response_401 = Problem;
1086
+ export type POST_Hosts_Response_403 = Problem;
1087
+ export type POST_Hosts_Response_404 = Problem;
1088
+ export type POST_Hosts_Response_409 = Problem;
1089
+ export type POST_Hosts_Response_422 = Problem;
1090
+
1065
1091
  export type POST_JobByJobIdPause_Response = POST_JobByJobIdPause_Response_404 | POST_JobByJobIdPause_Response_422;
1066
1092
 
1067
1093
  export type POST_JobByJobIdPause_Response_404 = Problem;
@@ -1197,6 +1223,14 @@ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 = Pro
1197
1223
  export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem;
1198
1224
  export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError;
1199
1225
 
1226
+ export type PUT_HostsByHostReference_Response = PUT_HostsByHostReference_Response_200 | PUT_HostsByHostReference_Response_401 | PUT_HostsByHostReference_Response_403 | PUT_HostsByHostReference_Response_404 | PUT_HostsByHostReference_Response_422;
1227
+
1228
+ export type PUT_HostsByHostReference_Response_200 = Host;
1229
+ export type PUT_HostsByHostReference_Response_401 = Problem;
1230
+ export type PUT_HostsByHostReference_Response_403 = Problem;
1231
+ export type PUT_HostsByHostReference_Response_404 = Problem;
1232
+ export type PUT_HostsByHostReference_Response_422 = HTTPValidationError;
1233
+
1200
1234
  export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_422;
1201
1235
 
1202
1236
  export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;
@@ -252,13 +252,18 @@ export type GetPrices = components['schemas']['GetPricesResponse'];
252
252
  export type HTTPMethod = components['schemas']['HTTPMethod'];
253
253
  export type HTTPValidationError = components['schemas']['HTTPValidationError'];
254
254
  export type HolderEntitlement = components['schemas']['HolderEntitlement'];
255
+ export type HostCreate = components['schemas']['HostCreate'];
256
+ export type HostIpSchema = components['schemas']['HostIpSchema'];
257
+ export type Host = components['schemas']['HostResponse'];
255
258
  export type HostSchema = components['schemas']['HostSchema'];
256
259
  export type HostStatus = components['schemas']['HostStatus'];
260
+ export type HostUpdate = components['schemas']['HostUpdate'];
257
261
  export type HttpProtocol = components['schemas']['HttpProtocol'];
258
262
  export type HttpRedirectList = components['schemas']['HttpRedirectListResponse'];
259
263
  export type HttpRedirectRemove = components['schemas']['HttpRedirectRemove'];
260
264
  export type HttpRedirectRequest = components['schemas']['HttpRedirectRequest'];
261
265
  export type HttpRedirectUpsert = components['schemas']['HttpRedirectUpsert'];
266
+ export type IPAddressType = components['schemas']['IPAddressType'];
262
267
  export type IdnBase = components['schemas']['IdnBase'];
263
268
  export type Invoice = components['schemas']['InvoiceResponse'];
264
269
  export type InvoiceResponsePaymentStatus = components['schemas']['InvoiceResponsePaymentStatus'];