@opusdns/api 0.282.0 → 0.284.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.
@@ -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 { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DuplicateCommand, 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, 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, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, 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, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, 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, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * ContactIncludeField
@@ -317,6 +317,34 @@ export type PostalAddressTypeArray = PostalAddressType[];
317
317
  * @see {@link ContactConfigBase} - The individual ContactConfigBase type definition
318
318
  */
319
319
  export type ContactConfigBaseArray = ContactConfigBase[];
320
+ /**
321
+ * Context
322
+ *
323
+ * @remarks
324
+ * Array type for Context objects. Used when the API returns a collection of Context instances.
325
+ *
326
+ * @example
327
+ * ```typescript
328
+ * const items: ContextArray = await api.getContexts();
329
+ * ```
330
+ *
331
+ * @see {@link Context} - The individual Context type definition
332
+ */
333
+ export type ContextArray = Context[];
334
+ /**
335
+ * Conversation
336
+ *
337
+ * @remarks
338
+ * Array type for Conversation objects. Used when the API returns a collection of Conversation instances.
339
+ *
340
+ * @example
341
+ * ```typescript
342
+ * const items: ConversationArray = await api.getConversations();
343
+ * ```
344
+ *
345
+ * @see {@link Conversation} - The individual Conversation type definition
346
+ */
347
+ export type ConversationArray = Conversation[];
320
348
  /**
321
349
  * DuplicateCommand
322
350
  *
@@ -989,6 +1017,34 @@ export type LegalRequirementOperationTypeArray = LegalRequirementOperationType[]
989
1017
  * @see {@link LocalPresenceRequirementType} - The individual LocalPresenceRequirementType type definition
990
1018
  */
991
1019
  export type LocalPresenceRequirementTypeArray = LocalPresenceRequirementType[];
1020
+ /**
1021
+ * MemoryFact
1022
+ *
1023
+ * @remarks
1024
+ * Array type for MemoryFact objects. Used when the API returns a collection of MemoryFact instances.
1025
+ *
1026
+ * @example
1027
+ * ```typescript
1028
+ * const items: MemoryFactArray = await api.getMemoryFacts();
1029
+ * ```
1030
+ *
1031
+ * @see {@link MemoryFact} - The individual MemoryFact type definition
1032
+ */
1033
+ export type MemoryFactArray = MemoryFact[];
1034
+ /**
1035
+ * Message
1036
+ *
1037
+ * @remarks
1038
+ * Array type for Message objects. Used when the API returns a collection of Message instances.
1039
+ *
1040
+ * @example
1041
+ * ```typescript
1042
+ * const items: MessageArray = await api.getMessages();
1043
+ * ```
1044
+ *
1045
+ * @see {@link Message} - The individual Message type definition
1046
+ */
1047
+ export type MessageArray = Message[];
992
1048
  /**
993
1049
  * OrganizationAttribute
994
1050
  *
@@ -730,6 +730,118 @@ export type ContactVerification = components['schemas']['ContactVerificationResp
730
730
  * @see {@link components} - The OpenAPI components schema definition
731
731
  */
732
732
  export type ContactsBase = components['schemas']['ContactsBase'];
733
+ /**
734
+ * Context
735
+ *
736
+ * @remarks
737
+ * Type alias for the `Context` OpenAPI schema.
738
+ * This type represents context data structures used in API requests and responses.
739
+ *
740
+ * @example
741
+ * ```typescript
742
+ * const response = await api.getContext();
743
+ * const item: Context = response.results;
744
+ * ```
745
+ *
746
+ * @see {@link components} - The OpenAPI components schema definition
747
+ */
748
+ export type Context = components['schemas']['Context'];
749
+ /**
750
+ * ContextCreateRequest
751
+ *
752
+ * @remarks
753
+ * Type alias for the `ContextCreateRequest` OpenAPI schema.
754
+ * This type represents contextcreaterequest data structures used in API requests and responses.
755
+ *
756
+ * @example
757
+ * ```typescript
758
+ * const response = await api.getContextCreateRequest();
759
+ * const item: ContextCreateRequest = response.results;
760
+ * ```
761
+ *
762
+ * @see {@link components} - The OpenAPI components schema definition
763
+ */
764
+ export type ContextCreateRequest = components['schemas']['ContextCreateRequest'];
765
+ /**
766
+ * ContextListResponse
767
+ *
768
+ * @remarks
769
+ * Type alias for the `ContextListResponse` OpenAPI schema.
770
+ * This type represents contextlistresponse data structures used in API requests and responses.
771
+ *
772
+ * @example
773
+ * ```typescript
774
+ * const response = await api.getContextList();
775
+ * const item: ContextList = response.results;
776
+ * ```
777
+ *
778
+ * @see {@link components} - The OpenAPI components schema definition
779
+ */
780
+ export type ContextList = components['schemas']['ContextListResponse'];
781
+ /**
782
+ * Conversation
783
+ *
784
+ * @remarks
785
+ * Type alias for the `Conversation` OpenAPI schema.
786
+ * This type represents conversation data structures used in API requests and responses.
787
+ *
788
+ * @example
789
+ * ```typescript
790
+ * const response = await api.getConversation();
791
+ * const item: Conversation = response.results;
792
+ * ```
793
+ *
794
+ * @see {@link components} - The OpenAPI components schema definition
795
+ */
796
+ export type Conversation = components['schemas']['Conversation'];
797
+ /**
798
+ * ConversationCreateRequest
799
+ *
800
+ * @remarks
801
+ * Type alias for the `ConversationCreateRequest` OpenAPI schema.
802
+ * This type represents conversationcreaterequest data structures used in API requests and responses.
803
+ *
804
+ * @example
805
+ * ```typescript
806
+ * const response = await api.getConversationCreateRequest();
807
+ * const item: ConversationCreateRequest = response.results;
808
+ * ```
809
+ *
810
+ * @see {@link components} - The OpenAPI components schema definition
811
+ */
812
+ export type ConversationCreateRequest = components['schemas']['ConversationCreateRequest'];
813
+ /**
814
+ * ConversationListResponse
815
+ *
816
+ * @remarks
817
+ * Type alias for the `ConversationListResponse` OpenAPI schema.
818
+ * This type represents conversationlistresponse data structures used in API requests and responses.
819
+ *
820
+ * @example
821
+ * ```typescript
822
+ * const response = await api.getConversationList();
823
+ * const item: ConversationList = response.results;
824
+ * ```
825
+ *
826
+ * @see {@link components} - The OpenAPI components schema definition
827
+ */
828
+ export type ConversationList = components['schemas']['ConversationListResponse'];
829
+ /**
830
+ * ConversationPatchRequest
831
+ *
832
+ * @remarks
833
+ * Type alias for the `ConversationPatchRequest` OpenAPI schema.
834
+ * This type represents conversationpatchrequest data structures used in API requests and responses.
835
+ *
836
+ * @example
837
+ * ```typescript
838
+ * const response = await api.getConversationPatchRequest();
839
+ * const item: ConversationPatchRequest = response.results;
840
+ * ```
841
+ *
842
+ * @see {@link components} - The OpenAPI components schema definition
843
+ */
844
+ export type ConversationPatchRequest = components['schemas']['ConversationPatchRequest'];
733
845
  /**
734
846
  * CreateJobBatchResponse
735
847
  *
@@ -3828,6 +3940,166 @@ export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
3828
3940
  * @see {@link components} - The OpenAPI components schema definition
3829
3941
  */
3830
3942
  export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
3943
+ /**
3944
+ * MemoryFact
3945
+ *
3946
+ * @remarks
3947
+ * Type alias for the `MemoryFact` OpenAPI schema.
3948
+ * This type represents memoryfact data structures used in API requests and responses.
3949
+ *
3950
+ * @example
3951
+ * ```typescript
3952
+ * const response = await api.getMemoryFact();
3953
+ * const item: MemoryFact = response.results;
3954
+ * ```
3955
+ *
3956
+ * @see {@link components} - The OpenAPI components schema definition
3957
+ */
3958
+ export type MemoryFact = components['schemas']['MemoryFact'];
3959
+ /**
3960
+ * MemoryFactCreateRequest
3961
+ *
3962
+ * @remarks
3963
+ * Type alias for the `MemoryFactCreateRequest` OpenAPI schema.
3964
+ * This type represents memoryfactcreaterequest data structures used in API requests and responses.
3965
+ *
3966
+ * @example
3967
+ * ```typescript
3968
+ * const response = await api.getMemoryFactCreateRequest();
3969
+ * const item: MemoryFactCreateRequest = response.results;
3970
+ * ```
3971
+ *
3972
+ * @see {@link components} - The OpenAPI components schema definition
3973
+ */
3974
+ export type MemoryFactCreateRequest = components['schemas']['MemoryFactCreateRequest'];
3975
+ /**
3976
+ * MemoryFactKind
3977
+ *
3978
+ * @remarks
3979
+ * Type alias for the `MemoryFactKind` OpenAPI schema.
3980
+ * This type represents memoryfactkind data structures used in API requests and responses.
3981
+ *
3982
+ * @example
3983
+ * ```typescript
3984
+ * const response = await api.getMemoryFactKind();
3985
+ * const item: MemoryFactKind = response.results;
3986
+ * ```
3987
+ *
3988
+ * @see {@link components} - The OpenAPI components schema definition
3989
+ */
3990
+ export type MemoryFactKind = components['schemas']['MemoryFactKind'];
3991
+ /**
3992
+ * MemoryFactListResponse
3993
+ *
3994
+ * @remarks
3995
+ * Type alias for the `MemoryFactListResponse` OpenAPI schema.
3996
+ * This type represents memoryfactlistresponse data structures used in API requests and responses.
3997
+ *
3998
+ * @example
3999
+ * ```typescript
4000
+ * const response = await api.getMemoryFactList();
4001
+ * const item: MemoryFactList = response.results;
4002
+ * ```
4003
+ *
4004
+ * @see {@link components} - The OpenAPI components schema definition
4005
+ */
4006
+ export type MemoryFactList = components['schemas']['MemoryFactListResponse'];
4007
+ /**
4008
+ * MemoryFactPatchRequest
4009
+ *
4010
+ * @remarks
4011
+ * Type alias for the `MemoryFactPatchRequest` OpenAPI schema.
4012
+ * This type represents memoryfactpatchrequest data structures used in API requests and responses.
4013
+ *
4014
+ * @example
4015
+ * ```typescript
4016
+ * const response = await api.getMemoryFactPatchRequest();
4017
+ * const item: MemoryFactPatchRequest = response.results;
4018
+ * ```
4019
+ *
4020
+ * @see {@link components} - The OpenAPI components schema definition
4021
+ */
4022
+ export type MemoryFactPatchRequest = components['schemas']['MemoryFactPatchRequest'];
4023
+ /**
4024
+ * Message
4025
+ *
4026
+ * @remarks
4027
+ * Type alias for the `Message` OpenAPI schema.
4028
+ * This type represents message data structures used in API requests and responses.
4029
+ *
4030
+ * @example
4031
+ * ```typescript
4032
+ * const response = await api.getMessage();
4033
+ * const item: Message = response.results;
4034
+ * ```
4035
+ *
4036
+ * @see {@link components} - The OpenAPI components schema definition
4037
+ */
4038
+ export type Message = components['schemas']['Message'];
4039
+ /**
4040
+ * MessageContextKind
4041
+ *
4042
+ * @remarks
4043
+ * Type alias for the `MessageContextKind` OpenAPI schema.
4044
+ * This type represents messagecontextkind data structures used in API requests and responses.
4045
+ *
4046
+ * @example
4047
+ * ```typescript
4048
+ * const response = await api.getMessageContextKind();
4049
+ * const item: MessageContextKind = response.results;
4050
+ * ```
4051
+ *
4052
+ * @see {@link components} - The OpenAPI components schema definition
4053
+ */
4054
+ export type MessageContextKind = components['schemas']['MessageContextKind'];
4055
+ /**
4056
+ * MessageCreateRequest
4057
+ *
4058
+ * @remarks
4059
+ * Type alias for the `MessageCreateRequest` OpenAPI schema.
4060
+ * This type represents messagecreaterequest data structures used in API requests and responses.
4061
+ *
4062
+ * @example
4063
+ * ```typescript
4064
+ * const response = await api.getMessageCreateRequest();
4065
+ * const item: MessageCreateRequest = response.results;
4066
+ * ```
4067
+ *
4068
+ * @see {@link components} - The OpenAPI components schema definition
4069
+ */
4070
+ export type MessageCreateRequest = components['schemas']['MessageCreateRequest'];
4071
+ /**
4072
+ * MessageListResponse
4073
+ *
4074
+ * @remarks
4075
+ * Type alias for the `MessageListResponse` OpenAPI schema.
4076
+ * This type represents messagelistresponse data structures used in API requests and responses.
4077
+ *
4078
+ * @example
4079
+ * ```typescript
4080
+ * const response = await api.getMessageList();
4081
+ * const item: MessageList = response.results;
4082
+ * ```
4083
+ *
4084
+ * @see {@link components} - The OpenAPI components schema definition
4085
+ */
4086
+ export type MessageList = components['schemas']['MessageListResponse'];
4087
+ /**
4088
+ * MessageRole
4089
+ *
4090
+ * @remarks
4091
+ * Type alias for the `MessageRole` OpenAPI schema.
4092
+ * This type represents messagerole data structures used in API requests and responses.
4093
+ *
4094
+ * @example
4095
+ * ```typescript
4096
+ * const response = await api.getMessageRole();
4097
+ * const item: MessageRole = response.results;
4098
+ * ```
4099
+ *
4100
+ * @see {@link components} - The OpenAPI components schema definition
4101
+ */
4102
+ export type MessageRole = components['schemas']['MessageRole'];
3831
4103
  /**
3832
4104
  * MetricsGrouping
3833
4105
  *