@opusdns/api 0.6.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.
Files changed (9) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +8 -0
  3. package/package.json +37 -0
  4. package/src/openapi.yaml +7677 -0
  5. package/src/schema.d.ts +6574 -0
  6. package/src/types/constants.ts +362 -0
  7. package/src/types/index.ts +11 -0
  8. package/src/types/keys.ts +1173 -0
  9. package/src/types/types.ts +173 -0
package/src/types/types.ts ADDED
@@ -0,0 +1,173 @@
1
+ /**
2
+ * Type definitions for OpusDNS API response objects and parameters.
3
+ *
4
+ * This file is auto-generated from the OpenAPI specification.
5
+ * Do not edit manually.
6
+ */
7
+
8
+ import { components, operations } from '../schema';
9
+
10
+
11
+ /**
12
+ * Response Types
13
+ */
14
+ export type Get_AuthClientCredentials_Response_V1 = components['schemas']['Pagination_OrganizationCredential_'];
15
+ export type Get_Availability_Response_V1 = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
16
+ export type Get_Contacts_Response_V1 = components['schemas']['Pagination_ContactSchema_'];
17
+ export type Get_ContactsBycontactId_Response_V1 = components['schemas']['ContactSchema'];
18
+ export type Get_ContactsBycontactIdVerification_Response_V1 = components['schemas']['ContactVerificationResponse'];
19
+ export type Get_ContactsVerification_Response_V1 = components['schemas']['ContactResponse'];
20
+ export type Get_Dns_Response_V1 = components['schemas']['Pagination_DnsZoneResponse_'];
21
+ export type Get_DnsByzoneName_Response_V1 = components['schemas']['DnsZoneResponse'];
22
+ export type Get_Domains_Response_V1 = components['schemas']['Pagination_DomainResponse_'];
23
+ export type Get_DomainsBydomainReference_Response_V1 = components['schemas']['DomainResponse'];
24
+ export type Get_DomainsCheck_Response_V1 = components['schemas']['DomainCheckResponse'];
25
+ export type Get_DomainSearchSuggest_Response_V1 = components['schemas']['DomainSearchResponse'];
26
+ export type Get_EmailForwards_Response_V1 = components['schemas']['Pagination_EmailForward_'];
27
+ export type Get_EmailForwardsByemailForwardId_Response_V1 = components['schemas']['EmailForward'];
28
+ export type Get_Event_Response_V1 = components['schemas']['Pagination_EventResponse_'];
29
+ export type Get_EventByeventId_Response_V1 = components['schemas']['EventSchema'];
30
+ export type Get_Notifications_Response_V1 = components['schemas']['Pagination_UserNotificationSummary_'];
31
+ export type Get_NotificationsBynotificationId_Response_V1 = components['schemas']['UserNotification'];
32
+ export type Get_Organizations_Response_V1 = components['schemas']['Pagination_Organization_'];
33
+ export type Get_OrganizationsByorganizationId_Response_V1 = components['schemas']['OrganizationWithPlan'];
34
+ export type Get_OrganizationsIpRestrictionsByipRestrictionId_Response_V1 = components['schemas']['IpRestrictionResponse'];
35
+ export type Get_OrganizationsUsers_Response_V1 = components['schemas']['Pagination_User_'];
36
+ export type Get_UsersByuserId_Response_V1 = components['schemas']['UserWithAttributes'];
37
+ export type Get_UsersByuserIdPermissions_Response_V1 = components['schemas']['PermissionSet'];
38
+ export type Get_UsersByuserIdRoles_Response_V1 = components['schemas']['RelationSet'];
39
+ export type Get_UsersMe_Response_V1 = components['schemas']['UserWithRelationPermissions'];
40
+ export type Patch_DomainsBydomainReference_Response_V1 = components['schemas']['DomainResponse'];
41
+ export type Patch_EmailForwardsBulkUpdate_Response_V1 = components['schemas']['BulkOperationResponse_EmailForwardBulkUpdateResult_'];
42
+ export type Patch_EmailForwardsByemailForwardId_Response_V1 = components['schemas']['EmailForward'];
43
+ export type Patch_OrganizationsByorganizationId_Response_V1 = components['schemas']['Organization'];
44
+ export type Patch_OrganizationsByorganizationIdPlan_Response_V1 = components['schemas']['OrganizationWithPlan'];
45
+ export type Patch_OrganizationsIpRestrictionsByipRestrictionId_Response_V1 = components['schemas']['IpRestrictionResponse'];
46
+ export type Patch_UsersByuserId_Response_V1 = components['schemas']['UserWithAttributes'];
47
+ export type Patch_UsersByuserIdRoles_Response_V1 = components['schemas']['RelationSet'];
48
+ export type Post_AuthClientCredentials_Response_V1 = components['schemas']['OrganizationCredentialCreated'];
49
+ export type Post_Contacts_Response_V1 = components['schemas']['ContactSchema'];
50
+ export type Post_DnsByzoneNameDnssecDisable_Response_V1 = components['schemas']['DnsChangesResponse'];
51
+ export type Post_DnsByzoneNameDnssecEnable_Response_V1 = components['schemas']['DnsChangesResponse'];
52
+ export type Post_Domains_Response_V1 = components['schemas']['DomainResponse'];
53
+ export type Post_DomainsBydomainReferenceRenew_Response_V1 = components['schemas']['DomainRenewResponse'];
54
+ export type Post_DomainsTransfer_Response_V1 = components['schemas']['DomainResponse'];
55
+ export type Post_EmailForwards_Response_V1 = components['schemas']['EmailForward'];
56
+ export type Post_EmailForwardsBulkDelete_Response_V1 = components['schemas']['BulkOperationResponse_EmailForwardBulkDeleteResult_'];
57
+ export type Post_Notifications_Response_V1 = components['schemas']['Notification'];
58
+ export type Post_Organizations_Response_V1 = components['schemas']['Organization'];
59
+ export type Post_OrganizationsIpRestrictions_Response_V1 = components['schemas']['IpRestrictionResponse'];
60
+ export type Post_Users_Response_V1 = components['schemas']['User'];
61
+ export type Put_NotificationsBynotificationId_Response_V1 = components['schemas']['Notification'];
62
+ /**
63
+ * Request Parameter Types
64
+ */
65
+ export type Get_AuthClientCredentials_ParamsQuery_V1 = operations['list_api_keys_v1_auth_client_credentials_get']['parameters']['query'];
66
+ export type Delete_AuthClientCredentialsByapiKeyId_ParamsPath_V1 = operations['delete_api_key_v1_auth_client_credentials__api_key_id__delete']['parameters']['path'];
67
+ export type Get_Availability_ParamsQuery_V1 = operations['bulk_availability_v1_availability_get']['parameters']['query'];
68
+ export type Get_AvailabilityStream_ParamsQuery_V1 = operations['stream_availability_v1_availability_stream_get']['parameters']['query'];
69
+ export type Get_Contacts_ParamsQuery_V1 = operations['get_contacts_v1_contacts_get']['parameters']['query'];
70
+ export type Get_ContactsVerification_ParamsQuery_V1 = operations['get_verification_by_token_v1_contacts_verification_get']['parameters']['query'];
71
+ export type Put_ContactsVerification_ParamsQuery_V1 = operations['update_verification_by_token_v1_contacts_verification_put']['parameters']['query'];
72
+ export type Get_ContactsVerify_ParamsQuery_V1 = operations['email_verify_contact_v1_contacts_verify_get']['parameters']['query'];
73
+ export type Get_ContactsBycontactId_ParamsPath_V1 = operations['get_contact_v1_contacts__contact_id__get']['parameters']['path'];
74
+ export type Delete_ContactsBycontactId_ParamsPath_V1 = operations['delete_contact_v1_contacts__contact_id__delete']['parameters']['path'];
75
+ export type Get_ContactsBycontactIdVerification_ParamsPath_V1 = operations['get_verification_status_v1_contacts__contact_id__verification_get']['parameters']['path'];
76
+ export type Post_ContactsBycontactIdVerification_ParamsPath_V1 = operations['start_contact_verification_v1_contacts__contact_id__verification_post']['parameters']['path'];
77
+ export type Post_ContactsBycontactIdVerification_ParamsQuery_V1 = operations['start_contact_verification_v1_contacts__contact_id__verification_post']['parameters']['query'];
78
+ export type Put_ContactsBycontactIdVerification_ParamsPath_V1 = operations['update_verification_v1_contacts__contact_id__verification_put']['parameters']['path'];
79
+ export type Put_ContactsBycontactIdVerification_ParamsQuery_V1 = operations['update_verification_v1_contacts__contact_id__verification_put']['parameters']['query'];
80
+ export type Delete_ContactsBycontactIdVerification_ParamsPath_V1 = operations['cancel_verification_v1_contacts__contact_id__verification_delete']['parameters']['path'];
81
+ export type Get_Dns_ParamsQuery_V1 = operations['list_zones_v1_dns_get']['parameters']['query'];
82
+ export type Get_DnsByzoneName_ParamsPath_V1 = operations['get_zone_v1_dns__zone_name__get']['parameters']['path'];
83
+ export type Delete_DnsByzoneName_ParamsPath_V1 = operations['delete_zone_v1_dns__zone_name__delete']['parameters']['path'];
84
+ export type Post_DnsByzoneNameDnssecDisable_ParamsPath_V1 = operations['disable_dnssec_v1_dns__zone_name__dnssec_disable_post']['parameters']['path'];
85
+ export type Post_DnsByzoneNameDnssecEnable_ParamsPath_V1 = operations['enable_dnssec_v1_dns__zone_name__dnssec_enable_post']['parameters']['path'];
86
+ export type Put_DnsByzoneNameRrsets_ParamsPath_V1 = operations['update_zone_v1_dns__zone_name__rrsets_put']['parameters']['path'];
87
+ export type Get_DomainSearchSuggest_ParamsQuery_V1 = operations['suggest_v1_domain_search_suggest_get']['parameters']['query'];
88
+ export type Get_Domains_ParamsQuery_V1 = operations['get_domains_v1_domains_get']['parameters']['query'];
89
+ export type Get_DomainsCheck_ParamsQuery_V1 = operations['epp_check_domain_v1_domains_check_get']['parameters']['query'];
90
+ export type Get_DomainsBydomainReference_ParamsPath_V1 = operations['get_domain_v1_domains__domain_reference__get']['parameters']['path'];
91
+ export type Patch_DomainsBydomainReference_ParamsPath_V1 = operations['update_domain_v1_domains__domain_reference__patch']['parameters']['path'];
92
+ export type Delete_DomainsBydomainReference_ParamsPath_V1 = operations['delete_domain_v1_domains__domain_reference__delete']['parameters']['path'];
93
+ export type Get_DomainsBydomainReferenceDnssec_ParamsPath_V1 = operations['get_dnssec_v1_domains__domain_reference__dnssec_get']['parameters']['path'];
94
+ export type Put_DomainsBydomainReferenceDnssec_ParamsPath_V1 = operations['create_or_update_dnssec_v1_domains__domain_reference__dnssec_put']['parameters']['path'];
95
+ export type Delete_DomainsBydomainReferenceDnssec_ParamsPath_V1 = operations['delete_dnssec_v1_domains__domain_reference__dnssec_delete']['parameters']['path'];
96
+ export type Post_DomainsBydomainReferenceRenew_ParamsPath_V1 = operations['renew_domain_v1_domains__domain_reference__renew_post']['parameters']['path'];
97
+ export type Delete_DomainsBydomainReferenceTransfer_ParamsPath_V1 = operations['cancel_domain_transfer_v1_domains__domain_reference__transfer_delete']['parameters']['path'];
98
+ export type Get_EmailForwards_ParamsQuery_V1 = operations['list_email_forwards_v1_email_forwards_get']['parameters']['query'];
99
+ export type Get_EmailForwardsByemailForwardId_ParamsPath_V1 = operations['get_email_forward_v1_email_forwards__email_forward_id__get']['parameters']['path'];
100
+ export type Patch_EmailForwardsByemailForwardId_ParamsPath_V1 = operations['update_email_forward_v1_email_forwards__email_forward_id__patch']['parameters']['path'];
101
+ export type Delete_EmailForwardsByemailForwardId_ParamsPath_V1 = operations['delete_email_forward_v1_email_forwards__email_forward_id__delete']['parameters']['path'];
102
+ export type Get_Event_ParamsQuery_V1 = operations['get_events_v1_event_get']['parameters']['query'];
103
+ export type Get_EventByeventId_ParamsPath_V1 = operations['get_event_v1_event__event_id__get']['parameters']['path'];
104
+ export type Patch_EventByeventId_ParamsPath_V1 = operations['acknowledge_event_v1_event__event_id__patch']['parameters']['path'];
105
+ export type Get_Notifications_ParamsQuery_V1 = operations['list_notifications_v1_notifications_get']['parameters']['query'];
106
+ export type Get_NotificationsBynotificationId_ParamsPath_V1 = operations['get_notification_v1_notifications__notification_id__get']['parameters']['path'];
107
+ export type Get_NotificationsBynotificationId_ParamsQuery_V1 = operations['get_notification_v1_notifications__notification_id__get']['parameters']['query'];
108
+ export type Put_NotificationsBynotificationId_ParamsPath_V1 = operations['update_notification_v1_notifications__notification_id__put']['parameters']['path'];
109
+ export type Delete_NotificationsBynotificationId_ParamsPath_V1 = operations['delete_notification_v1_notifications__notification_id__delete']['parameters']['path'];
110
+ export type Patch_NotificationsBynotificationIdRead_ParamsPath_V1 = operations['update_notification_read_v1_notifications__notification_id__read_patch']['parameters']['path'];
111
+ export type Get_Organizations_ParamsQuery_V1 = operations['list_organizations_v1_organizations_get']['parameters']['query'];
112
+ export type Get_OrganizationsAttributes_ParamsQuery_V1 = operations['get_attributes_v1_organizations_attributes_get']['parameters']['query'];
113
+ export type Patch_OrganizationsAttributes_ParamsQuery_V1 = operations['update_attributes_v1_organizations_attributes_patch']['parameters']['query'];
114
+ export type Get_OrganizationsAttributesByorganizationId_ParamsPath_V1 = operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['path'];
115
+ export type Get_OrganizationsAttributesByorganizationId_ParamsQuery_V1 = operations['get_attributes_v1_organizations_attributes__organization_id__get']['parameters']['query'];
116
+ export type Patch_OrganizationsAttributesByorganizationId_ParamsPath_V1 = operations['update_attributes_v1_organizations_attributes__organization_id__patch']['parameters']['path'];
117
+ export type Get_OrganizationsIpRestrictionsByipRestrictionId_ParamsPath_V1 = operations['get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get']['parameters']['path'];
118
+ export type Patch_OrganizationsIpRestrictionsByipRestrictionId_ParamsPath_V1 = operations['update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch']['parameters']['path'];
119
+ export type Delete_OrganizationsIpRestrictionsByipRestrictionId_ParamsPath_V1 = operations['delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete']['parameters']['path'];
120
+ export type Get_OrganizationsUsers_ParamsQuery_V1 = operations['list_users_v1_organizations_users_get']['parameters']['query'];
121
+ export type Get_OrganizationsByorganizationId_ParamsPath_V1 = operations['get_organization_v1_organizations__organization_id__get']['parameters']['path'];
122
+ export type Patch_OrganizationsByorganizationId_ParamsPath_V1 = operations['update_organization_v1_organizations__organization_id__patch']['parameters']['path'];
123
+ export type Delete_OrganizationsByorganizationId_ParamsPath_V1 = operations['delete_user_v1_organizations__organization_id__delete']['parameters']['path'];
124
+ export type Patch_OrganizationsByorganizationIdPlan_ParamsPath_V1 = operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
125
+ export type Get_UsersMe_ParamsQuery_V1 = operations['get_current_user_v1_users_me_get']['parameters']['query'];
126
+ export type Get_UsersByuserId_ParamsPath_V1 = operations['get_user_v1_users__user_id__get']['parameters']['path'];
127
+ export type Get_UsersByuserId_ParamsQuery_V1 = operations['get_user_v1_users__user_id__get']['parameters']['query'];
128
+ export type Patch_UsersByuserId_ParamsPath_V1 = operations['update_user_v1_users__user_id__patch']['parameters']['path'];
129
+ export type Delete_UsersByuserId_ParamsPath_V1 = operations['delete_user_v1_users__user_id__delete']['parameters']['path'];
130
+ export type Get_UsersByuserIdPermissions_ParamsPath_V1 = operations['get_user_permissions_v1_users__user_id__permissions_get']['parameters']['path'];
131
+ export type Get_UsersByuserIdRoles_ParamsPath_V1 = operations['list_roles_v1_users__user_id__roles_get']['parameters']['path'];
132
+ export type Patch_UsersByuserIdRoles_ParamsPath_V1 = operations['update_user_relations_v1_users__user_id__roles_patch']['parameters']['path'];
133
+
134
+ /**
135
+ * Response Data Types
136
+ */
137
+ export type DomainAvailability = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
138
+ export type DomainAvailabilityResultsArray = DomainAvailability['results'];
139
+ export type Contact = components['schemas']['ContactResponse'];
140
+ export type ContactSchema = components['schemas']['ContactSchema'];
141
+ export type ContactVerification = components['schemas']['ContactVerificationResponse'];
142
+ export type DnsZone = components['schemas']['DnsZoneResponse'];
143
+ export type DnsZoneRrsetsArray = DnsZone['rrsets'];
144
+ export type DomainCheck = components['schemas']['DomainCheckResponse'];
145
+ export type DomainCheckResultsArray = DomainCheck['results'];
146
+ export type Domain = components['schemas']['DomainResponse'];
147
+ export type DomainContactsArray = Domain['contacts'];
148
+ export type DomainNameserversArray = Domain['nameservers'];
149
+ export type DomainRegistry_statusesArray = Domain['registry_statuses'];
150
+ export type DomainSearch = components['schemas']['DomainSearchResponse'];
151
+ export type DomainSearchResultsArray = DomainSearch['results'];
152
+ export type EmailForward = components['schemas']['EmailForward'];
153
+ export type EventSchema = components['schemas']['EventSchema'];
154
+ export type IpRestriction = components['schemas']['IpRestrictionResponse'];
155
+ export type OrganizationWithPlan = components['schemas']['OrganizationWithPlan'];
156
+ export type OrganizationWithPlanAttributesArray = OrganizationWithPlan['attributes'];
157
+ export type OrganizationWithPlanUsersArray = OrganizationWithPlan['users'];
158
+ export type ContactSchemaArray = Get_Contacts_Response_V1['results'];
159
+ export type DnsZoneArray = Get_Dns_Response_V1['results'];
160
+ export type DomainArray = Get_Domains_Response_V1['results'];
161
+ export type EmailForwardArray = Get_EmailForwards_Response_V1['results'];
162
+ export type EventArray = Get_Event_Response_V1['results'];
163
+ export type OrganizationArray = Get_Organizations_Response_V1['results'];
164
+ export type OrganizationCredentialArray = Get_AuthClientCredentials_Response_V1['results'];
165
+ export type UserArray = Get_OrganizationsUsers_Response_V1['results'];
166
+ export type UserNotificationSummaryArray = Get_Notifications_Response_V1['results'];
167
+ export type PermissionSet = components['schemas']['PermissionSet'];
168
+ export type PermissionSetPermissionsArray = PermissionSet['permissions'];
169
+ export type RelationSet = components['schemas']['RelationSet'];
170
+ export type RelationSetRelationsArray = RelationSet['relations'];
171
+ export type UserNotification = components['schemas']['UserNotification'];
172
+ export type UserWithAttributes = components['schemas']['UserWithAttributes'];
173
+ export type UserWithRelationPermissions = components['schemas']['UserWithRelationPermissions'];