@opusdns/api 0.258.0 → 0.259.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/constants.ts +105 -1
- package/src/helpers/keys.ts +814 -0
- package/src/helpers/requests.d.ts +300 -1
- package/src/helpers/responses.d.ts +649 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +144 -0
- package/src/openapi.yaml +716 -1
- package/src/schema.d.ts +722 -0
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainTagEnriched, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainTagEnriched, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainIncludeField
|
|
@@ -149,6 +149,20 @@ export type ReportTypeArray = ReportType[];
|
|
|
149
149
|
* @see {@link ReportStatus} - The individual ReportStatus type definition
|
|
150
150
|
*/
|
|
151
151
|
export type ReportStatusArray = ReportStatus[];
|
|
152
|
+
/**
|
|
153
|
+
* TagType
|
|
154
|
+
*
|
|
155
|
+
* @remarks
|
|
156
|
+
* Array type for TagType objects. Used when the API returns a collection of TagType instances.
|
|
157
|
+
*
|
|
158
|
+
* @example
|
|
159
|
+
* ```typescript
|
|
160
|
+
* const items: TagTypeArray = await api.getTagTypes();
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
163
|
+
* @see {@link TagType} - The individual TagType type definition
|
|
164
|
+
*/
|
|
165
|
+
export type TagTypeArray = TagType[];
|
|
152
166
|
/**
|
|
153
167
|
* TldResponseShort
|
|
154
168
|
*
|
|
@@ -1213,6 +1227,20 @@ export type ParkingArray = Parking[];
|
|
|
1213
1227
|
* @see {@link RequestHistory} - The individual RequestHistory type definition
|
|
1214
1228
|
*/
|
|
1215
1229
|
export type RequestHistoryArray = RequestHistory[];
|
|
1230
|
+
/**
|
|
1231
|
+
* TagResponse
|
|
1232
|
+
*
|
|
1233
|
+
* @remarks
|
|
1234
|
+
* Array type for TagResponse objects. Used when the API returns a collection of TagResponse instances.
|
|
1235
|
+
*
|
|
1236
|
+
* @example
|
|
1237
|
+
* ```typescript
|
|
1238
|
+
* const items: TagArray = await api.getTags();
|
|
1239
|
+
* ```
|
|
1240
|
+
*
|
|
1241
|
+
* @see {@link Tag} - The individual TagResponse type definition
|
|
1242
|
+
*/
|
|
1243
|
+
export type TagArray = Tag[];
|
|
1216
1244
|
/**
|
|
1217
1245
|
* UserPublic
|
|
1218
1246
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -250,6 +250,22 @@ export type BillingTransactionStatus = components['schemas']['BillingTransaction
|
|
|
250
250
|
* @see {@link components} - The OpenAPI components schema definition
|
|
251
251
|
*/
|
|
252
252
|
export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
|
|
253
|
+
/**
|
|
254
|
+
* BulkObjectTagChanges
|
|
255
|
+
*
|
|
256
|
+
* @remarks
|
|
257
|
+
* Type alias for the `BulkObjectTagChanges` OpenAPI schema.
|
|
258
|
+
* This type represents bulkobjecttagchanges data structures used in API requests and responses.
|
|
259
|
+
*
|
|
260
|
+
* @example
|
|
261
|
+
* ```typescript
|
|
262
|
+
* const response = await api.getBulkObjectTagChanges();
|
|
263
|
+
* const item: BulkObjectTagChanges = response.results;
|
|
264
|
+
* ```
|
|
265
|
+
*
|
|
266
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
267
|
+
*/
|
|
268
|
+
export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
|
|
253
269
|
/**
|
|
254
270
|
* CommandError
|
|
255
271
|
*
|
|
@@ -3924,6 +3940,38 @@ export type ObjectLog = components['schemas']['ObjectLog'];
|
|
|
3924
3940
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3925
3941
|
*/
|
|
3926
3942
|
export type ObjectLogSortField = components['schemas']['ObjectLogSortField'];
|
|
3943
|
+
/**
|
|
3944
|
+
* ObjectTagChanges
|
|
3945
|
+
*
|
|
3946
|
+
* @remarks
|
|
3947
|
+
* Type alias for the `ObjectTagChanges` OpenAPI schema.
|
|
3948
|
+
* This type represents objecttagchanges data structures used in API requests and responses.
|
|
3949
|
+
*
|
|
3950
|
+
* @example
|
|
3951
|
+
* ```typescript
|
|
3952
|
+
* const response = await api.getObjectTagChanges();
|
|
3953
|
+
* const item: ObjectTagChanges = response.results;
|
|
3954
|
+
* ```
|
|
3955
|
+
*
|
|
3956
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3957
|
+
*/
|
|
3958
|
+
export type ObjectTagChanges = components['schemas']['ObjectTagChanges'];
|
|
3959
|
+
/**
|
|
3960
|
+
* ObjectTagChangesResponse
|
|
3961
|
+
*
|
|
3962
|
+
* @remarks
|
|
3963
|
+
* Type alias for the `ObjectTagChangesResponse` OpenAPI schema.
|
|
3964
|
+
* This type represents objecttagchangesresponse data structures used in API requests and responses.
|
|
3965
|
+
*
|
|
3966
|
+
* @example
|
|
3967
|
+
* ```typescript
|
|
3968
|
+
* const response = await api.getObjectTagChanges2();
|
|
3969
|
+
* const item: ObjectTagChanges2 = response.results;
|
|
3970
|
+
* ```
|
|
3971
|
+
*
|
|
3972
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3973
|
+
*/
|
|
3974
|
+
export type ObjectTagChanges2 = components['schemas']['ObjectTagChangesResponse'];
|
|
3927
3975
|
/**
|
|
3928
3976
|
* Organization
|
|
3929
3977
|
*
|
|
@@ -4404,6 +4452,22 @@ export type Pagination_Parking = components['schemas']['Pagination_ParkingRespon
|
|
|
4404
4452
|
* @see {@link components} - The OpenAPI components schema definition
|
|
4405
4453
|
*/
|
|
4406
4454
|
export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
|
|
4455
|
+
/**
|
|
4456
|
+
* Pagination[TagResponse]
|
|
4457
|
+
*
|
|
4458
|
+
* @remarks
|
|
4459
|
+
* Type alias for the `Pagination_TagResponse_` OpenAPI schema.
|
|
4460
|
+
* This type represents pagination[tagresponse] data structures used in API requests and responses.
|
|
4461
|
+
*
|
|
4462
|
+
* @example
|
|
4463
|
+
* ```typescript
|
|
4464
|
+
* const response = await api.getPagination_Tag();
|
|
4465
|
+
* const item: Pagination_Tag = response.results;
|
|
4466
|
+
* ```
|
|
4467
|
+
*
|
|
4468
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
4469
|
+
*/
|
|
4470
|
+
export type Pagination_Tag = components['schemas']['Pagination_TagResponse_'];
|
|
4407
4471
|
/**
|
|
4408
4472
|
* Pagination[UserPublic]
|
|
4409
4473
|
*
|
|
@@ -5668,6 +5732,22 @@ export type TLDType = components['schemas']['TLDType'];
|
|
|
5668
5732
|
* @see {@link components} - The OpenAPI components schema definition
|
|
5669
5733
|
*/
|
|
5670
5734
|
export type TagColor = components['schemas']['TagColor'];
|
|
5735
|
+
/**
|
|
5736
|
+
* TagCreate
|
|
5737
|
+
*
|
|
5738
|
+
* @remarks
|
|
5739
|
+
* Type alias for the `TagCreate` OpenAPI schema.
|
|
5740
|
+
* This type represents tagcreate data structures used in API requests and responses.
|
|
5741
|
+
*
|
|
5742
|
+
* @example
|
|
5743
|
+
* ```typescript
|
|
5744
|
+
* const response = await api.getTagCreate();
|
|
5745
|
+
* const item: TagCreate = response.results;
|
|
5746
|
+
* ```
|
|
5747
|
+
*
|
|
5748
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5749
|
+
*/
|
|
5750
|
+
export type TagCreate = components['schemas']['TagCreate'];
|
|
5671
5751
|
/**
|
|
5672
5752
|
* TagFilterMode
|
|
5673
5753
|
*
|
|
@@ -5684,6 +5764,70 @@ export type TagColor = components['schemas']['TagColor'];
|
|
|
5684
5764
|
* @see {@link components} - The OpenAPI components schema definition
|
|
5685
5765
|
*/
|
|
5686
5766
|
export type TagFilterMode = components['schemas']['TagFilterMode'];
|
|
5767
|
+
/**
|
|
5768
|
+
* TagResponse
|
|
5769
|
+
*
|
|
5770
|
+
* @remarks
|
|
5771
|
+
* Type alias for the `TagResponse` OpenAPI schema.
|
|
5772
|
+
* This type represents tagresponse data structures used in API requests and responses.
|
|
5773
|
+
*
|
|
5774
|
+
* @example
|
|
5775
|
+
* ```typescript
|
|
5776
|
+
* const response = await api.getTag();
|
|
5777
|
+
* const item: Tag = response.results;
|
|
5778
|
+
* ```
|
|
5779
|
+
*
|
|
5780
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5781
|
+
*/
|
|
5782
|
+
export type Tag = components['schemas']['TagResponse'];
|
|
5783
|
+
/**
|
|
5784
|
+
* TagSortField
|
|
5785
|
+
*
|
|
5786
|
+
* @remarks
|
|
5787
|
+
* Type alias for the `TagSortField` OpenAPI schema.
|
|
5788
|
+
* This type represents tagsortfield data structures used in API requests and responses.
|
|
5789
|
+
*
|
|
5790
|
+
* @example
|
|
5791
|
+
* ```typescript
|
|
5792
|
+
* const response = await api.getTagSortField();
|
|
5793
|
+
* const item: TagSortField = response.results;
|
|
5794
|
+
* ```
|
|
5795
|
+
*
|
|
5796
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5797
|
+
*/
|
|
5798
|
+
export type TagSortField = components['schemas']['TagSortField'];
|
|
5799
|
+
/**
|
|
5800
|
+
* TagType
|
|
5801
|
+
*
|
|
5802
|
+
* @remarks
|
|
5803
|
+
* Type alias for the `TagType` OpenAPI schema.
|
|
5804
|
+
* This type represents tagtype data structures used in API requests and responses.
|
|
5805
|
+
*
|
|
5806
|
+
* @example
|
|
5807
|
+
* ```typescript
|
|
5808
|
+
* const response = await api.getTagType();
|
|
5809
|
+
* const item: TagType = response.results;
|
|
5810
|
+
* ```
|
|
5811
|
+
*
|
|
5812
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5813
|
+
*/
|
|
5814
|
+
export type TagType = components['schemas']['TagType'];
|
|
5815
|
+
/**
|
|
5816
|
+
* TagUpdate
|
|
5817
|
+
*
|
|
5818
|
+
* @remarks
|
|
5819
|
+
* Type alias for the `TagUpdate` OpenAPI schema.
|
|
5820
|
+
* This type represents tagupdate data structures used in API requests and responses.
|
|
5821
|
+
*
|
|
5822
|
+
* @example
|
|
5823
|
+
* ```typescript
|
|
5824
|
+
* const response = await api.getTagUpdate();
|
|
5825
|
+
* const item: TagUpdate = response.results;
|
|
5826
|
+
* ```
|
|
5827
|
+
*
|
|
5828
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5829
|
+
*/
|
|
5830
|
+
export type TagUpdate = components['schemas']['TagUpdate'];
|
|
5687
5831
|
/**
|
|
5688
5832
|
* TimeRange
|
|
5689
5833
|
*
|