@opusdns/api 0.199.0 → 0.200.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/keys.ts +1413 -165
- package/src/helpers/requests.d.ts +241 -2
- package/src/helpers/responses.d.ts +408 -4
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +128 -0
- package/src/openapi.yaml +630 -3
- package/src/schema.d.ts +589 -5
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactAttributeLink, Pagination_ContactAttributeSet, ContactAttributeSet, ContactDetail, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -676,6 +676,411 @@ export type POST_Contacts_Response_201 = ContactSchema
|
|
|
676
676
|
*/
|
|
677
677
|
export type POST_Contacts_Response_422 = HTTPValidationError
|
|
678
678
|
|
|
679
|
+
/**
|
|
680
|
+
* Response types for POST ContactsAttributeLinks endpoint
|
|
681
|
+
*
|
|
682
|
+
* Link a contact to a contact attribute set
|
|
683
|
+
*
|
|
684
|
+
* @remarks
|
|
685
|
+
* This type defines all possible response structures for the POST ContactsAttributeLinks endpoint.
|
|
686
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
687
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
688
|
+
*
|
|
689
|
+
|
|
690
|
+
*
|
|
691
|
+
* @path /v1/contacts/attribute-links
|
|
692
|
+
*
|
|
693
|
+
* @see {@link POST_ContactsAttributeLinks_Response_201} - 201 response type
|
|
694
|
+
* @see {@link POST_ContactsAttributeLinks_Response_404} - 404 response type
|
|
695
|
+
* @see {@link POST_ContactsAttributeLinks_Response_409} - 409 response type
|
|
696
|
+
* @see {@link POST_ContactsAttributeLinks_Response_422} - 422 response type
|
|
697
|
+
*
|
|
698
|
+
|
|
699
|
+
*/
|
|
700
|
+
export type POST_ContactsAttributeLinks_Response = POST_ContactsAttributeLinks_Response_201 | POST_ContactsAttributeLinks_Response_404 | POST_ContactsAttributeLinks_Response_409 | POST_ContactsAttributeLinks_Response_422;
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* 201 response for POST ContactsAttributeLinks endpoint
|
|
704
|
+
*
|
|
705
|
+
* @remarks
|
|
706
|
+
* This type defines the response structure for the 201 status code
|
|
707
|
+
* of the POST ContactsAttributeLinks endpoint.
|
|
708
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
709
|
+
*
|
|
710
|
+
|
|
711
|
+
*
|
|
712
|
+
* @path /v1/contacts/attribute-links
|
|
713
|
+
*
|
|
714
|
+
* @see {@link POST_ContactsAttributeLinks_Response} - The main response type definition
|
|
715
|
+
* @see {@link ContactAttributeLink} - The actual schema type definition
|
|
716
|
+
*/
|
|
717
|
+
export type POST_ContactsAttributeLinks_Response_201 = ContactAttributeLink
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* 404 response for POST ContactsAttributeLinks endpoint
|
|
721
|
+
*
|
|
722
|
+
* @remarks
|
|
723
|
+
* This type defines the response structure for the 404 status code
|
|
724
|
+
* of the POST ContactsAttributeLinks endpoint.
|
|
725
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
726
|
+
*
|
|
727
|
+
|
|
728
|
+
*
|
|
729
|
+
* @path /v1/contacts/attribute-links
|
|
730
|
+
*
|
|
731
|
+
* @see {@link POST_ContactsAttributeLinks_Response} - The main response type definition
|
|
732
|
+
* @see {@link Problem} - The actual schema type definition
|
|
733
|
+
*/
|
|
734
|
+
export type POST_ContactsAttributeLinks_Response_404 = Problem
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* 409 response for POST ContactsAttributeLinks endpoint
|
|
738
|
+
*
|
|
739
|
+
* @remarks
|
|
740
|
+
* This type defines the response structure for the 409 status code
|
|
741
|
+
* of the POST ContactsAttributeLinks endpoint.
|
|
742
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
743
|
+
*
|
|
744
|
+
|
|
745
|
+
*
|
|
746
|
+
* @path /v1/contacts/attribute-links
|
|
747
|
+
*
|
|
748
|
+
* @see {@link POST_ContactsAttributeLinks_Response} - The main response type definition
|
|
749
|
+
* @see {@link Problem} - The actual schema type definition
|
|
750
|
+
*/
|
|
751
|
+
export type POST_ContactsAttributeLinks_Response_409 = Problem
|
|
752
|
+
|
|
753
|
+
/**
|
|
754
|
+
* 422 response for POST ContactsAttributeLinks endpoint
|
|
755
|
+
*
|
|
756
|
+
* @remarks
|
|
757
|
+
* This type defines the response structure for the 422 status code
|
|
758
|
+
* of the POST ContactsAttributeLinks endpoint.
|
|
759
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
760
|
+
*
|
|
761
|
+
|
|
762
|
+
*
|
|
763
|
+
* @path /v1/contacts/attribute-links
|
|
764
|
+
*
|
|
765
|
+
* @see {@link POST_ContactsAttributeLinks_Response} - The main response type definition
|
|
766
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
767
|
+
*/
|
|
768
|
+
export type POST_ContactsAttributeLinks_Response_422 = HTTPValidationError
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
* Response types for GET ContactsAttributeSets endpoint
|
|
772
|
+
*
|
|
773
|
+
* List contact attribute sets
|
|
774
|
+
*
|
|
775
|
+
* @remarks
|
|
776
|
+
* This type defines all possible response structures for the GET ContactsAttributeSets endpoint.
|
|
777
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
778
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
779
|
+
*
|
|
780
|
+
|
|
781
|
+
*
|
|
782
|
+
* @path /v1/contacts/attribute-sets
|
|
783
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
784
|
+
*
|
|
785
|
+
* @see {@link GET_ContactsAttributeSets_Response_200} - 200 response type
|
|
786
|
+
* @see {@link GET_ContactsAttributeSets_Response_422} - 422 response type
|
|
787
|
+
*
|
|
788
|
+
|
|
789
|
+
*/
|
|
790
|
+
export type GET_ContactsAttributeSets_Response = GET_ContactsAttributeSets_Response_200 | GET_ContactsAttributeSets_Response_422;
|
|
791
|
+
|
|
792
|
+
/**
|
|
793
|
+
* 200 response for GET ContactsAttributeSets endpoint
|
|
794
|
+
*
|
|
795
|
+
* @remarks
|
|
796
|
+
* This type defines the response structure for the 200 status code
|
|
797
|
+
* of the GET ContactsAttributeSets endpoint.
|
|
798
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
799
|
+
*
|
|
800
|
+
|
|
801
|
+
*
|
|
802
|
+
* @path /v1/contacts/attribute-sets
|
|
803
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
804
|
+
*
|
|
805
|
+
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
806
|
+
* @see {@link Pagination_ContactAttributeSet} - The actual schema type definition
|
|
807
|
+
*/
|
|
808
|
+
export type GET_ContactsAttributeSets_Response_200 = Pagination_ContactAttributeSet
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* 422 response for GET ContactsAttributeSets endpoint
|
|
812
|
+
*
|
|
813
|
+
* @remarks
|
|
814
|
+
* This type defines the response structure for the 422 status code
|
|
815
|
+
* of the GET ContactsAttributeSets endpoint.
|
|
816
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
817
|
+
*
|
|
818
|
+
|
|
819
|
+
*
|
|
820
|
+
* @path /v1/contacts/attribute-sets
|
|
821
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
822
|
+
*
|
|
823
|
+
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
824
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
825
|
+
*/
|
|
826
|
+
export type GET_ContactsAttributeSets_Response_422 = HTTPValidationError
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* Response types for POST ContactsAttributeSets endpoint
|
|
830
|
+
*
|
|
831
|
+
* Create a contact attribute set
|
|
832
|
+
*
|
|
833
|
+
* @remarks
|
|
834
|
+
* This type defines all possible response structures for the POST ContactsAttributeSets endpoint.
|
|
835
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
836
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
837
|
+
*
|
|
838
|
+
|
|
839
|
+
*
|
|
840
|
+
* @path /v1/contacts/attribute-sets
|
|
841
|
+
*
|
|
842
|
+
* @see {@link POST_ContactsAttributeSets_Response_201} - 201 response type
|
|
843
|
+
* @see {@link POST_ContactsAttributeSets_Response_422} - 422 response type
|
|
844
|
+
*
|
|
845
|
+
|
|
846
|
+
*/
|
|
847
|
+
export type POST_ContactsAttributeSets_Response = POST_ContactsAttributeSets_Response_201 | POST_ContactsAttributeSets_Response_422;
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* 201 response for POST ContactsAttributeSets endpoint
|
|
851
|
+
*
|
|
852
|
+
* @remarks
|
|
853
|
+
* This type defines the response structure for the 201 status code
|
|
854
|
+
* of the POST ContactsAttributeSets endpoint.
|
|
855
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
856
|
+
*
|
|
857
|
+
|
|
858
|
+
*
|
|
859
|
+
* @path /v1/contacts/attribute-sets
|
|
860
|
+
*
|
|
861
|
+
* @see {@link POST_ContactsAttributeSets_Response} - The main response type definition
|
|
862
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
863
|
+
*/
|
|
864
|
+
export type POST_ContactsAttributeSets_Response_201 = ContactAttributeSet
|
|
865
|
+
|
|
866
|
+
/**
|
|
867
|
+
* 422 response for POST ContactsAttributeSets endpoint
|
|
868
|
+
*
|
|
869
|
+
* @remarks
|
|
870
|
+
* This type defines the response structure for the 422 status code
|
|
871
|
+
* of the POST ContactsAttributeSets endpoint.
|
|
872
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
873
|
+
*
|
|
874
|
+
|
|
875
|
+
*
|
|
876
|
+
* @path /v1/contacts/attribute-sets
|
|
877
|
+
*
|
|
878
|
+
* @see {@link POST_ContactsAttributeSets_Response} - The main response type definition
|
|
879
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
880
|
+
*/
|
|
881
|
+
export type POST_ContactsAttributeSets_Response_422 = HTTPValidationError
|
|
882
|
+
|
|
883
|
+
/**
|
|
884
|
+
* Response types for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
885
|
+
*
|
|
886
|
+
* Delete a contact attribute set
|
|
887
|
+
*
|
|
888
|
+
* @remarks
|
|
889
|
+
* This type defines all possible response structures for the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
890
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
891
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
892
|
+
*
|
|
893
|
+
|
|
894
|
+
*
|
|
895
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
896
|
+
*
|
|
897
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
898
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
899
|
+
*
|
|
900
|
+
|
|
901
|
+
*/
|
|
902
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response = DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404 | DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* 404 response for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
906
|
+
*
|
|
907
|
+
* @remarks
|
|
908
|
+
* This type defines the response structure for the 404 status code
|
|
909
|
+
* of the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
910
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
911
|
+
*
|
|
912
|
+
|
|
913
|
+
*
|
|
914
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
915
|
+
*
|
|
916
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
917
|
+
* @see {@link Problem} - The actual schema type definition
|
|
918
|
+
*/
|
|
919
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* 422 response for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
923
|
+
*
|
|
924
|
+
* @remarks
|
|
925
|
+
* This type defines the response structure for the 422 status code
|
|
926
|
+
* of the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
927
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
928
|
+
*
|
|
929
|
+
|
|
930
|
+
*
|
|
931
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
932
|
+
*
|
|
933
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
934
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
935
|
+
*/
|
|
936
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* Response types for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
940
|
+
*
|
|
941
|
+
* Retrieve a contact attribute set
|
|
942
|
+
*
|
|
943
|
+
* @remarks
|
|
944
|
+
* This type defines all possible response structures for the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
945
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
946
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
947
|
+
*
|
|
948
|
+
|
|
949
|
+
*
|
|
950
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
951
|
+
*
|
|
952
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_200} - 200 response type
|
|
953
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
954
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
955
|
+
*
|
|
956
|
+
|
|
957
|
+
*/
|
|
958
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response = GET_ContactsAttributeSetsByContactAttributeSetId_Response_200 | GET_ContactsAttributeSetsByContactAttributeSetId_Response_404 | GET_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
959
|
+
|
|
960
|
+
/**
|
|
961
|
+
* 200 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
962
|
+
*
|
|
963
|
+
* @remarks
|
|
964
|
+
* This type defines the response structure for the 200 status code
|
|
965
|
+
* of the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
966
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
967
|
+
*
|
|
968
|
+
|
|
969
|
+
*
|
|
970
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
971
|
+
*
|
|
972
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
973
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
974
|
+
*/
|
|
975
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_200 = ContactAttributeSet
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* 404 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
979
|
+
*
|
|
980
|
+
* @remarks
|
|
981
|
+
* This type defines the response structure for the 404 status code
|
|
982
|
+
* of the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
983
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
984
|
+
*
|
|
985
|
+
|
|
986
|
+
*
|
|
987
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
988
|
+
*
|
|
989
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
990
|
+
* @see {@link Problem} - The actual schema type definition
|
|
991
|
+
*/
|
|
992
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* 422 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
996
|
+
*
|
|
997
|
+
* @remarks
|
|
998
|
+
* This type defines the response structure for the 422 status code
|
|
999
|
+
* of the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1000
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1001
|
+
*
|
|
1002
|
+
|
|
1003
|
+
*
|
|
1004
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1005
|
+
*
|
|
1006
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1007
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1008
|
+
*/
|
|
1009
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
1010
|
+
|
|
1011
|
+
/**
|
|
1012
|
+
* Response types for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
1013
|
+
*
|
|
1014
|
+
* Update a contact attribute set
|
|
1015
|
+
*
|
|
1016
|
+
* @remarks
|
|
1017
|
+
* This type defines all possible response structures for the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1018
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1019
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1020
|
+
*
|
|
1021
|
+
|
|
1022
|
+
*
|
|
1023
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1024
|
+
*
|
|
1025
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200} - 200 response type
|
|
1026
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
1027
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
1028
|
+
*
|
|
1029
|
+
|
|
1030
|
+
*/
|
|
1031
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response = PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200 | PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404 | PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* 200 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
1035
|
+
*
|
|
1036
|
+
* @remarks
|
|
1037
|
+
* This type defines the response structure for the 200 status code
|
|
1038
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1039
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1040
|
+
*
|
|
1041
|
+
|
|
1042
|
+
*
|
|
1043
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1044
|
+
*
|
|
1045
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1046
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
1047
|
+
*/
|
|
1048
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200 = ContactAttributeSet
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* 404 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
1052
|
+
*
|
|
1053
|
+
* @remarks
|
|
1054
|
+
* This type defines the response structure for the 404 status code
|
|
1055
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1056
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1057
|
+
*
|
|
1058
|
+
|
|
1059
|
+
*
|
|
1060
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1061
|
+
*
|
|
1062
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1063
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1064
|
+
*/
|
|
1065
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* 422 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
1069
|
+
*
|
|
1070
|
+
* @remarks
|
|
1071
|
+
* This type defines the response structure for the 422 status code
|
|
1072
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1073
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1074
|
+
*
|
|
1075
|
+
|
|
1076
|
+
*
|
|
1077
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1078
|
+
*
|
|
1079
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1080
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1081
|
+
*/
|
|
1082
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
1083
|
+
|
|
679
1084
|
/**
|
|
680
1085
|
* Response types for DELETE ContactsByContactId endpoint
|
|
681
1086
|
*
|
|
@@ -754,7 +1159,6 @@ export type DELETE_ContactsByContactId_Response_422 = HTTPValidationError
|
|
|
754
1159
|
* Response types for GET ContactsByContactId endpoint
|
|
755
1160
|
*
|
|
756
1161
|
* Retrieve a contact
|
|
757
|
-
* Retrieves a contact object
|
|
758
1162
|
*
|
|
759
1163
|
* @remarks
|
|
760
1164
|
* This type defines all possible response structures for the GET ContactsByContactId endpoint.
|
|
@@ -786,9 +1190,9 @@ export type GET_ContactsByContactId_Response = GET_ContactsByContactId_Response_
|
|
|
786
1190
|
* @path /v1/contacts/{contact_id}
|
|
787
1191
|
*
|
|
788
1192
|
* @see {@link GET_ContactsByContactId_Response} - The main response type definition
|
|
789
|
-
* @see {@link
|
|
1193
|
+
* @see {@link ContactDetail} - The actual schema type definition
|
|
790
1194
|
*/
|
|
791
|
-
export type GET_ContactsByContactId_Response_200 =
|
|
1195
|
+
export type GET_ContactsByContactId_Response_200 = ContactDetail
|
|
792
1196
|
|
|
793
1197
|
/**
|
|
794
1198
|
* 404 response for GET ContactsByContactId endpoint
|
|
@@ -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 { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -135,6 +135,20 @@ export type AttributeConditionArray = AttributeCondition[];
|
|
|
135
135
|
* @see {@link DomainContactType} - The individual DomainContactType type definition
|
|
136
136
|
*/
|
|
137
137
|
export type DomainContactTypeArray = DomainContactType[];
|
|
138
|
+
/**
|
|
139
|
+
* ContactAttributeLinkDetail
|
|
140
|
+
*
|
|
141
|
+
* @remarks
|
|
142
|
+
* Array type for ContactAttributeLinkDetail objects. Used when the API returns a collection of ContactAttributeLinkDetail instances.
|
|
143
|
+
*
|
|
144
|
+
* @example
|
|
145
|
+
* ```typescript
|
|
146
|
+
* const items: ContactAttributeLinkDetailArray = await api.getContactAttributeLinkDetails();
|
|
147
|
+
* ```
|
|
148
|
+
*
|
|
149
|
+
* @see {@link ContactAttributeLinkDetail} - The individual ContactAttributeLinkDetail type definition
|
|
150
|
+
*/
|
|
151
|
+
export type ContactAttributeLinkDetailArray = ContactAttributeLinkDetail[];
|
|
138
152
|
/**
|
|
139
153
|
* ContactAttributeDefinition. Definition of a possible attribute for a TLD.
|
|
140
154
|
*
|
|
@@ -765,6 +779,20 @@ export type UserCreateArray = UserCreate[];
|
|
|
765
779
|
* @see {@link BillingTransaction} - The individual BillingTransactionResponse type definition
|
|
766
780
|
*/
|
|
767
781
|
export type BillingTransactionArray = BillingTransaction[];
|
|
782
|
+
/**
|
|
783
|
+
* ContactAttributeSetResponse
|
|
784
|
+
*
|
|
785
|
+
* @remarks
|
|
786
|
+
* Array type for ContactAttributeSetResponse objects. Used when the API returns a collection of ContactAttributeSetResponse instances.
|
|
787
|
+
*
|
|
788
|
+
* @example
|
|
789
|
+
* ```typescript
|
|
790
|
+
* const items: ContactAttributeSetArray = await api.getContactAttributeSets();
|
|
791
|
+
* ```
|
|
792
|
+
*
|
|
793
|
+
* @see {@link ContactAttributeSet} - The individual ContactAttributeSetResponse type definition
|
|
794
|
+
*/
|
|
795
|
+
export type ContactAttributeSetArray = ContactAttributeSet[];
|
|
768
796
|
/**
|
|
769
797
|
* ContactSchema
|
|
770
798
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -266,6 +266,102 @@ export type ConditionOperator = components['schemas']['ConditionOperator'];
|
|
|
266
266
|
* @see {@link components} - The OpenAPI components schema definition
|
|
267
267
|
*/
|
|
268
268
|
export type ContactAttributeDefinition = components['schemas']['ContactAttributeDefinition'];
|
|
269
|
+
/**
|
|
270
|
+
* ContactAttributeLinkCreate
|
|
271
|
+
*
|
|
272
|
+
* @remarks
|
|
273
|
+
* Type alias for the `ContactAttributeLinkCreate` OpenAPI schema.
|
|
274
|
+
* This type represents contactattributelinkcreate data structures used in API requests and responses.
|
|
275
|
+
*
|
|
276
|
+
* @example
|
|
277
|
+
* ```typescript
|
|
278
|
+
* const response = await api.getContactAttributeLinkCreate();
|
|
279
|
+
* const item: ContactAttributeLinkCreate = response.results;
|
|
280
|
+
* ```
|
|
281
|
+
*
|
|
282
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
283
|
+
*/
|
|
284
|
+
export type ContactAttributeLinkCreate = components['schemas']['ContactAttributeLinkCreate'];
|
|
285
|
+
/**
|
|
286
|
+
* ContactAttributeLinkDetail
|
|
287
|
+
*
|
|
288
|
+
* @remarks
|
|
289
|
+
* Type alias for the `ContactAttributeLinkDetail` OpenAPI schema.
|
|
290
|
+
* This type represents contactattributelinkdetail data structures used in API requests and responses.
|
|
291
|
+
*
|
|
292
|
+
* @example
|
|
293
|
+
* ```typescript
|
|
294
|
+
* const response = await api.getContactAttributeLinkDetail();
|
|
295
|
+
* const item: ContactAttributeLinkDetail = response.results;
|
|
296
|
+
* ```
|
|
297
|
+
*
|
|
298
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
299
|
+
*/
|
|
300
|
+
export type ContactAttributeLinkDetail = components['schemas']['ContactAttributeLinkDetail'];
|
|
301
|
+
/**
|
|
302
|
+
* ContactAttributeLinkResponse
|
|
303
|
+
*
|
|
304
|
+
* @remarks
|
|
305
|
+
* Type alias for the `ContactAttributeLinkResponse` OpenAPI schema.
|
|
306
|
+
* This type represents contactattributelinkresponse data structures used in API requests and responses.
|
|
307
|
+
*
|
|
308
|
+
* @example
|
|
309
|
+
* ```typescript
|
|
310
|
+
* const response = await api.getContactAttributeLink();
|
|
311
|
+
* const item: ContactAttributeLink = response.results;
|
|
312
|
+
* ```
|
|
313
|
+
*
|
|
314
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
315
|
+
*/
|
|
316
|
+
export type ContactAttributeLink = components['schemas']['ContactAttributeLinkResponse'];
|
|
317
|
+
/**
|
|
318
|
+
* ContactAttributeSetCreate
|
|
319
|
+
*
|
|
320
|
+
* @remarks
|
|
321
|
+
* Type alias for the `ContactAttributeSetCreate` OpenAPI schema.
|
|
322
|
+
* This type represents contactattributesetcreate data structures used in API requests and responses.
|
|
323
|
+
*
|
|
324
|
+
* @example
|
|
325
|
+
* ```typescript
|
|
326
|
+
* const response = await api.getContactAttributeSetCreate();
|
|
327
|
+
* const item: ContactAttributeSetCreate = response.results;
|
|
328
|
+
* ```
|
|
329
|
+
*
|
|
330
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
331
|
+
*/
|
|
332
|
+
export type ContactAttributeSetCreate = components['schemas']['ContactAttributeSetCreate'];
|
|
333
|
+
/**
|
|
334
|
+
* ContactAttributeSetResponse
|
|
335
|
+
*
|
|
336
|
+
* @remarks
|
|
337
|
+
* Type alias for the `ContactAttributeSetResponse` OpenAPI schema.
|
|
338
|
+
* This type represents contactattributesetresponse data structures used in API requests and responses.
|
|
339
|
+
*
|
|
340
|
+
* @example
|
|
341
|
+
* ```typescript
|
|
342
|
+
* const response = await api.getContactAttributeSet();
|
|
343
|
+
* const item: ContactAttributeSet = response.results;
|
|
344
|
+
* ```
|
|
345
|
+
*
|
|
346
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
347
|
+
*/
|
|
348
|
+
export type ContactAttributeSet = components['schemas']['ContactAttributeSetResponse'];
|
|
349
|
+
/**
|
|
350
|
+
* ContactAttributeSetUpdate
|
|
351
|
+
*
|
|
352
|
+
* @remarks
|
|
353
|
+
* Type alias for the `ContactAttributeSetUpdate` OpenAPI schema.
|
|
354
|
+
* This type represents contactattributesetupdate data structures used in API requests and responses.
|
|
355
|
+
*
|
|
356
|
+
* @example
|
|
357
|
+
* ```typescript
|
|
358
|
+
* const response = await api.getContactAttributeSetUpdate();
|
|
359
|
+
* const item: ContactAttributeSetUpdate = response.results;
|
|
360
|
+
* ```
|
|
361
|
+
*
|
|
362
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
363
|
+
*/
|
|
364
|
+
export type ContactAttributeSetUpdate = components['schemas']['ContactAttributeSetUpdate'];
|
|
269
365
|
/**
|
|
270
366
|
* ContactConfigBase
|
|
271
367
|
*
|
|
@@ -298,6 +394,22 @@ export type ContactConfigBase = components['schemas']['ContactConfigBase'];
|
|
|
298
394
|
* @see {@link components} - The OpenAPI components schema definition
|
|
299
395
|
*/
|
|
300
396
|
export type ContactCreate = components['schemas']['ContactCreate'];
|
|
397
|
+
/**
|
|
398
|
+
* ContactDetailResponse
|
|
399
|
+
*
|
|
400
|
+
* @remarks
|
|
401
|
+
* Type alias for the `ContactDetailResponse` OpenAPI schema.
|
|
402
|
+
* This type represents contactdetailresponse data structures used in API requests and responses.
|
|
403
|
+
*
|
|
404
|
+
* @example
|
|
405
|
+
* ```typescript
|
|
406
|
+
* const response = await api.getContactDetail();
|
|
407
|
+
* const item: ContactDetail = response.results;
|
|
408
|
+
* ```
|
|
409
|
+
*
|
|
410
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
411
|
+
*/
|
|
412
|
+
export type ContactDetail = components['schemas']['ContactDetailResponse'];
|
|
301
413
|
/**
|
|
302
414
|
* ContactHandle
|
|
303
415
|
*
|
|
@@ -2948,6 +3060,22 @@ export type PaginationMetadata = components['schemas']['PaginationMetadata'];
|
|
|
2948
3060
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2949
3061
|
*/
|
|
2950
3062
|
export type Pagination_BillingTransaction = components['schemas']['Pagination_BillingTransactionResponse_'];
|
|
3063
|
+
/**
|
|
3064
|
+
* Pagination[ContactAttributeSetResponse]
|
|
3065
|
+
*
|
|
3066
|
+
* @remarks
|
|
3067
|
+
* Type alias for the `Pagination_ContactAttributeSetResponse_` OpenAPI schema.
|
|
3068
|
+
* This type represents pagination[contactattributesetresponse] data structures used in API requests and responses.
|
|
3069
|
+
*
|
|
3070
|
+
* @example
|
|
3071
|
+
* ```typescript
|
|
3072
|
+
* const response = await api.getPagination_ContactAttributeSet();
|
|
3073
|
+
* const item: Pagination_ContactAttributeSet = response.results;
|
|
3074
|
+
* ```
|
|
3075
|
+
*
|
|
3076
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3077
|
+
*/
|
|
3078
|
+
export type Pagination_ContactAttributeSet = components['schemas']['Pagination_ContactAttributeSetResponse_'];
|
|
2951
3079
|
/**
|
|
2952
3080
|
* Pagination[ContactSchema]
|
|
2953
3081
|
*
|