@opusdns/api 0.199.0 → 0.201.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 +1334 -165
- package/src/helpers/requests.d.ts +243 -2
- package/src/helpers/responses.d.ts +446 -6
- package/src/helpers/schemas-arrays.d.ts +34 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +654 -7
- package/src/schema.d.ts +609 -9
|
@@ -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,
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactDetail, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, ContactDetail, ContactAttributeLink, 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
|
|
@@ -599,9 +599,9 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
|
|
|
599
599
|
* @path /v1/contacts
|
|
600
600
|
*
|
|
601
601
|
* @see {@link GET_Contacts_Response} - The main response type definition
|
|
602
|
-
* @see {@link
|
|
602
|
+
* @see {@link Pagination_ContactDetail} - The actual schema type definition
|
|
603
603
|
*/
|
|
604
|
-
export type GET_Contacts_Response_200 =
|
|
604
|
+
export type GET_Contacts_Response_200 = Pagination_ContactDetail
|
|
605
605
|
|
|
606
606
|
/**
|
|
607
607
|
* 422 response for GET Contacts endpoint
|
|
@@ -676,6 +676,356 @@ 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 GET ContactsAttributeSets endpoint
|
|
681
|
+
*
|
|
682
|
+
* List contact attribute sets
|
|
683
|
+
*
|
|
684
|
+
* @remarks
|
|
685
|
+
* This type defines all possible response structures for the GET ContactsAttributeSets 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-sets
|
|
692
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
693
|
+
*
|
|
694
|
+
* @see {@link GET_ContactsAttributeSets_Response_200} - 200 response type
|
|
695
|
+
* @see {@link GET_ContactsAttributeSets_Response_422} - 422 response type
|
|
696
|
+
*
|
|
697
|
+
|
|
698
|
+
*/
|
|
699
|
+
export type GET_ContactsAttributeSets_Response = GET_ContactsAttributeSets_Response_200 | GET_ContactsAttributeSets_Response_422;
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* 200 response for GET ContactsAttributeSets endpoint
|
|
703
|
+
*
|
|
704
|
+
* @remarks
|
|
705
|
+
* This type defines the response structure for the 200 status code
|
|
706
|
+
* of the GET ContactsAttributeSets endpoint.
|
|
707
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
708
|
+
*
|
|
709
|
+
|
|
710
|
+
*
|
|
711
|
+
* @path /v1/contacts/attribute-sets
|
|
712
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
713
|
+
*
|
|
714
|
+
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
715
|
+
* @see {@link Pagination_ContactAttributeSet} - The actual schema type definition
|
|
716
|
+
*/
|
|
717
|
+
export type GET_ContactsAttributeSets_Response_200 = Pagination_ContactAttributeSet
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* 422 response for GET ContactsAttributeSets endpoint
|
|
721
|
+
*
|
|
722
|
+
* @remarks
|
|
723
|
+
* This type defines the response structure for the 422 status code
|
|
724
|
+
* of the GET ContactsAttributeSets 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-sets
|
|
730
|
+
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
731
|
+
*
|
|
732
|
+
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
733
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
734
|
+
*/
|
|
735
|
+
export type GET_ContactsAttributeSets_Response_422 = HTTPValidationError
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Response types for POST ContactsAttributeSets endpoint
|
|
739
|
+
*
|
|
740
|
+
* Create a contact attribute set
|
|
741
|
+
*
|
|
742
|
+
* @remarks
|
|
743
|
+
* This type defines all possible response structures for the POST ContactsAttributeSets endpoint.
|
|
744
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
745
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
746
|
+
*
|
|
747
|
+
|
|
748
|
+
*
|
|
749
|
+
* @path /v1/contacts/attribute-sets
|
|
750
|
+
*
|
|
751
|
+
* @see {@link POST_ContactsAttributeSets_Response_201} - 201 response type
|
|
752
|
+
* @see {@link POST_ContactsAttributeSets_Response_409} - 409 response type
|
|
753
|
+
* @see {@link POST_ContactsAttributeSets_Response_422} - 422 response type
|
|
754
|
+
*
|
|
755
|
+
|
|
756
|
+
*/
|
|
757
|
+
export type POST_ContactsAttributeSets_Response = POST_ContactsAttributeSets_Response_201 | POST_ContactsAttributeSets_Response_409 | POST_ContactsAttributeSets_Response_422;
|
|
758
|
+
|
|
759
|
+
/**
|
|
760
|
+
* 201 response for POST ContactsAttributeSets endpoint
|
|
761
|
+
*
|
|
762
|
+
* @remarks
|
|
763
|
+
* This type defines the response structure for the 201 status code
|
|
764
|
+
* of the POST ContactsAttributeSets endpoint.
|
|
765
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
766
|
+
*
|
|
767
|
+
|
|
768
|
+
*
|
|
769
|
+
* @path /v1/contacts/attribute-sets
|
|
770
|
+
*
|
|
771
|
+
* @see {@link POST_ContactsAttributeSets_Response} - The main response type definition
|
|
772
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
773
|
+
*/
|
|
774
|
+
export type POST_ContactsAttributeSets_Response_201 = ContactAttributeSet
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* 409 response for POST ContactsAttributeSets endpoint
|
|
778
|
+
*
|
|
779
|
+
* @remarks
|
|
780
|
+
* This type defines the response structure for the 409 status code
|
|
781
|
+
* of the POST ContactsAttributeSets endpoint.
|
|
782
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
783
|
+
*
|
|
784
|
+
|
|
785
|
+
*
|
|
786
|
+
* @path /v1/contacts/attribute-sets
|
|
787
|
+
*
|
|
788
|
+
* @see {@link POST_ContactsAttributeSets_Response} - The main response type definition
|
|
789
|
+
* @see {@link Problem} - The actual schema type definition
|
|
790
|
+
*/
|
|
791
|
+
export type POST_ContactsAttributeSets_Response_409 = Problem
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* 422 response for POST ContactsAttributeSets endpoint
|
|
795
|
+
*
|
|
796
|
+
* @remarks
|
|
797
|
+
* This type defines the response structure for the 422 status code
|
|
798
|
+
* of the POST ContactsAttributeSets endpoint.
|
|
799
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
800
|
+
*
|
|
801
|
+
|
|
802
|
+
*
|
|
803
|
+
* @path /v1/contacts/attribute-sets
|
|
804
|
+
*
|
|
805
|
+
* @see {@link POST_ContactsAttributeSets_Response} - The main response type definition
|
|
806
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
807
|
+
*/
|
|
808
|
+
export type POST_ContactsAttributeSets_Response_422 = HTTPValidationError
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* Response types for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
812
|
+
*
|
|
813
|
+
* Delete a contact attribute set
|
|
814
|
+
*
|
|
815
|
+
* @remarks
|
|
816
|
+
* This type defines all possible response structures for the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
817
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
818
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
819
|
+
*
|
|
820
|
+
|
|
821
|
+
*
|
|
822
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
823
|
+
*
|
|
824
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
825
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
826
|
+
*
|
|
827
|
+
|
|
828
|
+
*/
|
|
829
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response = DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404 | DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* 404 response for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
833
|
+
*
|
|
834
|
+
* @remarks
|
|
835
|
+
* This type defines the response structure for the 404 status code
|
|
836
|
+
* of the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
837
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
838
|
+
*
|
|
839
|
+
|
|
840
|
+
*
|
|
841
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
842
|
+
*
|
|
843
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
844
|
+
* @see {@link Problem} - The actual schema type definition
|
|
845
|
+
*/
|
|
846
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* 422 response for DELETE ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
850
|
+
*
|
|
851
|
+
* @remarks
|
|
852
|
+
* This type defines the response structure for the 422 status code
|
|
853
|
+
* of the DELETE ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
854
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
855
|
+
*
|
|
856
|
+
|
|
857
|
+
*
|
|
858
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
859
|
+
*
|
|
860
|
+
* @see {@link DELETE_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
861
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
862
|
+
*/
|
|
863
|
+
export type DELETE_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Response types for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
867
|
+
*
|
|
868
|
+
* Retrieve a contact attribute set
|
|
869
|
+
*
|
|
870
|
+
* @remarks
|
|
871
|
+
* This type defines all possible response structures for the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
872
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
873
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
874
|
+
*
|
|
875
|
+
|
|
876
|
+
*
|
|
877
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
878
|
+
*
|
|
879
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_200} - 200 response type
|
|
880
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
881
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
882
|
+
*
|
|
883
|
+
|
|
884
|
+
*/
|
|
885
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response = GET_ContactsAttributeSetsByContactAttributeSetId_Response_200 | GET_ContactsAttributeSetsByContactAttributeSetId_Response_404 | GET_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
886
|
+
|
|
887
|
+
/**
|
|
888
|
+
* 200 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
889
|
+
*
|
|
890
|
+
* @remarks
|
|
891
|
+
* This type defines the response structure for the 200 status code
|
|
892
|
+
* of the GET ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
893
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
894
|
+
*
|
|
895
|
+
|
|
896
|
+
*
|
|
897
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
898
|
+
*
|
|
899
|
+
* @see {@link GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
900
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
901
|
+
*/
|
|
902
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_200 = ContactAttributeSet
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* 404 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
906
|
+
*
|
|
907
|
+
* @remarks
|
|
908
|
+
* This type defines the response structure for the 404 status code
|
|
909
|
+
* of the GET 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 GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
917
|
+
* @see {@link Problem} - The actual schema type definition
|
|
918
|
+
*/
|
|
919
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* 422 response for GET ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
923
|
+
*
|
|
924
|
+
* @remarks
|
|
925
|
+
* This type defines the response structure for the 422 status code
|
|
926
|
+
* of the GET 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 GET_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
934
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
935
|
+
*/
|
|
936
|
+
export type GET_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* Response types for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
940
|
+
*
|
|
941
|
+
* Update a contact attribute set
|
|
942
|
+
*
|
|
943
|
+
* @remarks
|
|
944
|
+
* This type defines all possible response structures for the PATCH 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 PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200} - 200 response type
|
|
953
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404} - 404 response type
|
|
954
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_409} - 409 response type
|
|
955
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422} - 422 response type
|
|
956
|
+
*
|
|
957
|
+
|
|
958
|
+
*/
|
|
959
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response = PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200 | PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404 | PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_409 | PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422;
|
|
960
|
+
|
|
961
|
+
/**
|
|
962
|
+
* 200 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
963
|
+
*
|
|
964
|
+
* @remarks
|
|
965
|
+
* This type defines the response structure for the 200 status code
|
|
966
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
967
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
968
|
+
*
|
|
969
|
+
|
|
970
|
+
*
|
|
971
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
972
|
+
*
|
|
973
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
974
|
+
* @see {@link ContactAttributeSet} - The actual schema type definition
|
|
975
|
+
*/
|
|
976
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_200 = ContactAttributeSet
|
|
977
|
+
|
|
978
|
+
/**
|
|
979
|
+
* 404 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
980
|
+
*
|
|
981
|
+
* @remarks
|
|
982
|
+
* This type defines the response structure for the 404 status code
|
|
983
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
984
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
985
|
+
*
|
|
986
|
+
|
|
987
|
+
*
|
|
988
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
989
|
+
*
|
|
990
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
991
|
+
* @see {@link Problem} - The actual schema type definition
|
|
992
|
+
*/
|
|
993
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_404 = Problem
|
|
994
|
+
|
|
995
|
+
/**
|
|
996
|
+
* 409 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
997
|
+
*
|
|
998
|
+
* @remarks
|
|
999
|
+
* This type defines the response structure for the 409 status code
|
|
1000
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1001
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1002
|
+
*
|
|
1003
|
+
|
|
1004
|
+
*
|
|
1005
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1006
|
+
*
|
|
1007
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1008
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1009
|
+
*/
|
|
1010
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_409 = Problem
|
|
1011
|
+
|
|
1012
|
+
/**
|
|
1013
|
+
* 422 response for PATCH ContactsAttributeSetsByContactAttributeSetId endpoint
|
|
1014
|
+
*
|
|
1015
|
+
* @remarks
|
|
1016
|
+
* This type defines the response structure for the 422 status code
|
|
1017
|
+
* of the PATCH ContactsAttributeSetsByContactAttributeSetId endpoint.
|
|
1018
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1019
|
+
*
|
|
1020
|
+
|
|
1021
|
+
*
|
|
1022
|
+
* @path /v1/contacts/attribute-sets/{contact_attribute_set_id}
|
|
1023
|
+
*
|
|
1024
|
+
* @see {@link PATCH_ContactsAttributeSetsByContactAttributeSetId_Response} - The main response type definition
|
|
1025
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1026
|
+
*/
|
|
1027
|
+
export type PATCH_ContactsAttributeSetsByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
1028
|
+
|
|
679
1029
|
/**
|
|
680
1030
|
* Response types for DELETE ContactsByContactId endpoint
|
|
681
1031
|
*
|
|
@@ -754,7 +1104,6 @@ export type DELETE_ContactsByContactId_Response_422 = HTTPValidationError
|
|
|
754
1104
|
* Response types for GET ContactsByContactId endpoint
|
|
755
1105
|
*
|
|
756
1106
|
* Retrieve a contact
|
|
757
|
-
* Retrieves a contact object
|
|
758
1107
|
*
|
|
759
1108
|
* @remarks
|
|
760
1109
|
* This type defines all possible response structures for the GET ContactsByContactId endpoint.
|
|
@@ -786,9 +1135,9 @@ export type GET_ContactsByContactId_Response = GET_ContactsByContactId_Response_
|
|
|
786
1135
|
* @path /v1/contacts/{contact_id}
|
|
787
1136
|
*
|
|
788
1137
|
* @see {@link GET_ContactsByContactId_Response} - The main response type definition
|
|
789
|
-
* @see {@link
|
|
1138
|
+
* @see {@link ContactDetail} - The actual schema type definition
|
|
790
1139
|
*/
|
|
791
|
-
export type GET_ContactsByContactId_Response_200 =
|
|
1140
|
+
export type GET_ContactsByContactId_Response_200 = ContactDetail
|
|
792
1141
|
|
|
793
1142
|
/**
|
|
794
1143
|
* 404 response for GET ContactsByContactId endpoint
|
|
@@ -824,6 +1173,97 @@ export type GET_ContactsByContactId_Response_404 = Problem
|
|
|
824
1173
|
*/
|
|
825
1174
|
export type GET_ContactsByContactId_Response_422 = HTTPValidationError
|
|
826
1175
|
|
|
1176
|
+
/**
|
|
1177
|
+
* Response types for PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint
|
|
1178
|
+
*
|
|
1179
|
+
* Link a contact to a contact attribute set
|
|
1180
|
+
*
|
|
1181
|
+
* @remarks
|
|
1182
|
+
* This type defines all possible response structures for the PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint.
|
|
1183
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1184
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1185
|
+
*
|
|
1186
|
+
|
|
1187
|
+
*
|
|
1188
|
+
* @path /v1/contacts/{contact_id}/link/{contact_attribute_set_id}
|
|
1189
|
+
*
|
|
1190
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_200} - 200 response type
|
|
1191
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_404} - 404 response type
|
|
1192
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_409} - 409 response type
|
|
1193
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_422} - 422 response type
|
|
1194
|
+
*
|
|
1195
|
+
|
|
1196
|
+
*/
|
|
1197
|
+
export type PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response = PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_200 | PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_404 | PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_409 | PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_422;
|
|
1198
|
+
|
|
1199
|
+
/**
|
|
1200
|
+
* 200 response for PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint
|
|
1201
|
+
*
|
|
1202
|
+
* @remarks
|
|
1203
|
+
* This type defines the response structure for the 200 status code
|
|
1204
|
+
* of the PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint.
|
|
1205
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1206
|
+
*
|
|
1207
|
+
|
|
1208
|
+
*
|
|
1209
|
+
* @path /v1/contacts/{contact_id}/link/{contact_attribute_set_id}
|
|
1210
|
+
*
|
|
1211
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response} - The main response type definition
|
|
1212
|
+
* @see {@link ContactAttributeLink} - The actual schema type definition
|
|
1213
|
+
*/
|
|
1214
|
+
export type PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_200 = ContactAttributeLink
|
|
1215
|
+
|
|
1216
|
+
/**
|
|
1217
|
+
* 404 response for PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint
|
|
1218
|
+
*
|
|
1219
|
+
* @remarks
|
|
1220
|
+
* This type defines the response structure for the 404 status code
|
|
1221
|
+
* of the PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint.
|
|
1222
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1223
|
+
*
|
|
1224
|
+
|
|
1225
|
+
*
|
|
1226
|
+
* @path /v1/contacts/{contact_id}/link/{contact_attribute_set_id}
|
|
1227
|
+
*
|
|
1228
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response} - The main response type definition
|
|
1229
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1230
|
+
*/
|
|
1231
|
+
export type PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_404 = Problem
|
|
1232
|
+
|
|
1233
|
+
/**
|
|
1234
|
+
* 409 response for PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint
|
|
1235
|
+
*
|
|
1236
|
+
* @remarks
|
|
1237
|
+
* This type defines the response structure for the 409 status code
|
|
1238
|
+
* of the PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint.
|
|
1239
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1240
|
+
*
|
|
1241
|
+
|
|
1242
|
+
*
|
|
1243
|
+
* @path /v1/contacts/{contact_id}/link/{contact_attribute_set_id}
|
|
1244
|
+
*
|
|
1245
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response} - The main response type definition
|
|
1246
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1247
|
+
*/
|
|
1248
|
+
export type PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_409 = Problem
|
|
1249
|
+
|
|
1250
|
+
/**
|
|
1251
|
+
* 422 response for PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint
|
|
1252
|
+
*
|
|
1253
|
+
* @remarks
|
|
1254
|
+
* This type defines the response structure for the 422 status code
|
|
1255
|
+
* of the PATCH ContactsByContactIdLinkByContactAttributeSetId endpoint.
|
|
1256
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1257
|
+
*
|
|
1258
|
+
|
|
1259
|
+
*
|
|
1260
|
+
* @path /v1/contacts/{contact_id}/link/{contact_attribute_set_id}
|
|
1261
|
+
*
|
|
1262
|
+
* @see {@link PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response} - The main response type definition
|
|
1263
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1264
|
+
*/
|
|
1265
|
+
export type PATCH_ContactsByContactIdLinkByContactAttributeSetId_Response_422 = HTTPValidationError
|
|
1266
|
+
|
|
827
1267
|
/**
|
|
828
1268
|
* Response types for DELETE ContactsByContactIdVerification endpoint
|
|
829
1269
|
*
|
|
@@ -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,
|
|
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, ContactDetail, 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
|
*
|
|
@@ -766,19 +780,33 @@ export type UserCreateArray = UserCreate[];
|
|
|
766
780
|
*/
|
|
767
781
|
export type BillingTransactionArray = BillingTransaction[];
|
|
768
782
|
/**
|
|
769
|
-
*
|
|
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[];
|
|
796
|
+
/**
|
|
797
|
+
* ContactDetailResponse
|
|
770
798
|
*
|
|
771
799
|
* @remarks
|
|
772
|
-
* Array type for
|
|
800
|
+
* Array type for ContactDetailResponse objects. Used when the API returns a collection of ContactDetailResponse instances.
|
|
773
801
|
*
|
|
774
802
|
* @example
|
|
775
803
|
* ```typescript
|
|
776
|
-
* const items:
|
|
804
|
+
* const items: ContactDetailArray = await api.getContactDetails();
|
|
777
805
|
* ```
|
|
778
806
|
*
|
|
779
|
-
* @see {@link
|
|
807
|
+
* @see {@link ContactDetail} - The individual ContactDetailResponse type definition
|
|
780
808
|
*/
|
|
781
|
-
export type
|
|
809
|
+
export type ContactDetailArray = ContactDetail[];
|
|
782
810
|
/**
|
|
783
811
|
* DnsZoneResponse
|
|
784
812
|
*
|