@opusdns/api 0.54.0 → 0.55.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 +1 -51
- package/src/helpers/keys.ts +0 -1273
- package/src/helpers/requests.d.ts +1 -255
- package/src/helpers/responses.d.ts +1 -295
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +0 -128
- package/src/openapi.yaml +1 -503
- package/src/schema.d.ts +0 -492
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate,
|
|
37
|
+
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -2422,260 +2422,6 @@ export type PATCH_EventsEventId_Request = {
|
|
|
2422
2422
|
*/
|
|
2423
2423
|
export type PATCH_EventsEventId_Request_Path = PATCH_EventsEventId_Request['parameters']['path'];
|
|
2424
2424
|
|
|
2425
|
-
/**
|
|
2426
|
-
* Request type for GET Notifications endpoint
|
|
2427
|
-
*
|
|
2428
|
-
* List Notifications
|
|
2429
|
-
*
|
|
2430
|
-
* @remarks
|
|
2431
|
-
* This type defines the complete request structure for the GET Notifications endpoint.
|
|
2432
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2433
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2434
|
-
*
|
|
2435
|
-
* @example
|
|
2436
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2437
|
-
*
|
|
2438
|
-
* @path /v1/notifications
|
|
2439
|
-
*
|
|
2440
|
-
* @see {@link GET_Notifications_Request_Query} - Query parameters type
|
|
2441
|
-
* @see {@link GET_Notifications_Request_Path} - Path parameters type
|
|
2442
|
-
* @see {@link GET_Notifications_Request_Body} - Request body type
|
|
2443
|
-
*/
|
|
2444
|
-
export type GET_Notifications_Request = {
|
|
2445
|
-
parameters: {
|
|
2446
|
-
query: operations['list_notifications_v1_notifications_get']['parameters']['query'];
|
|
2447
|
-
};
|
|
2448
|
-
}
|
|
2449
|
-
/**
|
|
2450
|
-
* Query parameters for GET /v1/notifications
|
|
2451
|
-
*
|
|
2452
|
-
* @remarks
|
|
2453
|
-
* This type defines the query parameters for the GET /v1/notifications endpoint.
|
|
2454
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
2455
|
-
*
|
|
2456
|
-
* @example
|
|
2457
|
-
* Use this type to ensure type safety for query parameters.
|
|
2458
|
-
*
|
|
2459
|
-
* @path /v1/notifications
|
|
2460
|
-
*/
|
|
2461
|
-
export type GET_Notifications_Request_Query = GET_Notifications_Request['parameters']['query'];
|
|
2462
|
-
|
|
2463
|
-
/**
|
|
2464
|
-
* Request type for POST Notifications endpoint
|
|
2465
|
-
*
|
|
2466
|
-
* Create Notification
|
|
2467
|
-
*
|
|
2468
|
-
* @remarks
|
|
2469
|
-
* This type defines the complete request structure for the POST Notifications endpoint.
|
|
2470
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2471
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2472
|
-
*
|
|
2473
|
-
* @example
|
|
2474
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2475
|
-
*
|
|
2476
|
-
* @path /v1/notifications
|
|
2477
|
-
*
|
|
2478
|
-
* @see {@link POST_Notifications_Request_Query} - Query parameters type
|
|
2479
|
-
* @see {@link POST_Notifications_Request_Path} - Path parameters type
|
|
2480
|
-
* @see {@link POST_Notifications_Request_Body} - Request body type
|
|
2481
|
-
*/
|
|
2482
|
-
export type POST_Notifications_Request = {
|
|
2483
|
-
requestBody: NotificationCreate;
|
|
2484
|
-
}
|
|
2485
|
-
/**
|
|
2486
|
-
* Request body for POST /v1/notifications
|
|
2487
|
-
*
|
|
2488
|
-
* @remarks
|
|
2489
|
-
* This type defines the request body structure for the POST /v1/notifications endpoint.
|
|
2490
|
-
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
2491
|
-
*
|
|
2492
|
-
* @example
|
|
2493
|
-
* Use this type to ensure type safety for request body structure.
|
|
2494
|
-
*
|
|
2495
|
-
* @path /v1/notifications
|
|
2496
|
-
*/
|
|
2497
|
-
export type POST_Notifications_Request_Body = POST_Notifications_Request['requestBody'];
|
|
2498
|
-
|
|
2499
|
-
/**
|
|
2500
|
-
* Request type for DELETE NotificationsNotificationId endpoint
|
|
2501
|
-
*
|
|
2502
|
-
* Delete Notification
|
|
2503
|
-
*
|
|
2504
|
-
* @remarks
|
|
2505
|
-
* This type defines the complete request structure for the DELETE NotificationsNotificationId endpoint.
|
|
2506
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2507
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2508
|
-
*
|
|
2509
|
-
* @example
|
|
2510
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2511
|
-
*
|
|
2512
|
-
* @path /v1/notifications/{notification_id}
|
|
2513
|
-
*
|
|
2514
|
-
* @see {@link DELETE_NotificationsNotificationId_Request_Query} - Query parameters type
|
|
2515
|
-
* @see {@link DELETE_NotificationsNotificationId_Request_Path} - Path parameters type
|
|
2516
|
-
* @see {@link DELETE_NotificationsNotificationId_Request_Body} - Request body type
|
|
2517
|
-
*/
|
|
2518
|
-
export type DELETE_NotificationsNotificationId_Request = {
|
|
2519
|
-
parameters: {
|
|
2520
|
-
path: operations['delete_notification_v1_notifications__notification_id__delete']['parameters']['path'];
|
|
2521
|
-
};
|
|
2522
|
-
}
|
|
2523
|
-
/**
|
|
2524
|
-
* Path parameters for DELETE /v1/notifications/{notification_id}
|
|
2525
|
-
*
|
|
2526
|
-
* @remarks
|
|
2527
|
-
* This type defines the path parameters for the DELETE /v1/notifications/{notification_id} endpoint.
|
|
2528
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2529
|
-
*
|
|
2530
|
-
* @example
|
|
2531
|
-
* Use this type to ensure type safety for path parameters.
|
|
2532
|
-
*
|
|
2533
|
-
* @path /v1/notifications/{notification_id}
|
|
2534
|
-
*/
|
|
2535
|
-
export type DELETE_NotificationsNotificationId_Request_Path = DELETE_NotificationsNotificationId_Request['parameters']['path'];
|
|
2536
|
-
|
|
2537
|
-
/**
|
|
2538
|
-
* Request type for GET NotificationsNotificationId endpoint
|
|
2539
|
-
*
|
|
2540
|
-
* Get Notification
|
|
2541
|
-
*
|
|
2542
|
-
* @remarks
|
|
2543
|
-
* This type defines the complete request structure for the GET NotificationsNotificationId endpoint.
|
|
2544
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2545
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2546
|
-
*
|
|
2547
|
-
* @example
|
|
2548
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2549
|
-
*
|
|
2550
|
-
* @path /v1/notifications/{notification_id}
|
|
2551
|
-
*
|
|
2552
|
-
* @see {@link GET_NotificationsNotificationId_Request_Query} - Query parameters type
|
|
2553
|
-
* @see {@link GET_NotificationsNotificationId_Request_Path} - Path parameters type
|
|
2554
|
-
* @see {@link GET_NotificationsNotificationId_Request_Body} - Request body type
|
|
2555
|
-
*/
|
|
2556
|
-
export type GET_NotificationsNotificationId_Request = {
|
|
2557
|
-
parameters: {
|
|
2558
|
-
query: operations['get_notification_v1_notifications__notification_id__get']['parameters']['query'];
|
|
2559
|
-
path: operations['get_notification_v1_notifications__notification_id__get']['parameters']['path'];
|
|
2560
|
-
};
|
|
2561
|
-
}
|
|
2562
|
-
/**
|
|
2563
|
-
* Query parameters for GET /v1/notifications/{notification_id}
|
|
2564
|
-
*
|
|
2565
|
-
* @remarks
|
|
2566
|
-
* This type defines the query parameters for the GET /v1/notifications/{notification_id} endpoint.
|
|
2567
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
2568
|
-
*
|
|
2569
|
-
* @example
|
|
2570
|
-
* Use this type to ensure type safety for query parameters.
|
|
2571
|
-
*
|
|
2572
|
-
* @path /v1/notifications/{notification_id}
|
|
2573
|
-
*/
|
|
2574
|
-
export type GET_NotificationsNotificationId_Request_Query = GET_NotificationsNotificationId_Request['parameters']['query'];
|
|
2575
|
-
/**
|
|
2576
|
-
* Path parameters for GET /v1/notifications/{notification_id}
|
|
2577
|
-
*
|
|
2578
|
-
* @remarks
|
|
2579
|
-
* This type defines the path parameters for the GET /v1/notifications/{notification_id} endpoint.
|
|
2580
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2581
|
-
*
|
|
2582
|
-
* @example
|
|
2583
|
-
* Use this type to ensure type safety for path parameters.
|
|
2584
|
-
*
|
|
2585
|
-
* @path /v1/notifications/{notification_id}
|
|
2586
|
-
*/
|
|
2587
|
-
export type GET_NotificationsNotificationId_Request_Path = GET_NotificationsNotificationId_Request['parameters']['path'];
|
|
2588
|
-
|
|
2589
|
-
/**
|
|
2590
|
-
* Request type for PUT NotificationsNotificationId endpoint
|
|
2591
|
-
*
|
|
2592
|
-
* Update Notification
|
|
2593
|
-
*
|
|
2594
|
-
* @remarks
|
|
2595
|
-
* This type defines the complete request structure for the PUT NotificationsNotificationId endpoint.
|
|
2596
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2597
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2598
|
-
*
|
|
2599
|
-
* @example
|
|
2600
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2601
|
-
*
|
|
2602
|
-
* @path /v1/notifications/{notification_id}
|
|
2603
|
-
*
|
|
2604
|
-
* @see {@link PUT_NotificationsNotificationId_Request_Query} - Query parameters type
|
|
2605
|
-
* @see {@link PUT_NotificationsNotificationId_Request_Path} - Path parameters type
|
|
2606
|
-
* @see {@link PUT_NotificationsNotificationId_Request_Body} - Request body type
|
|
2607
|
-
*/
|
|
2608
|
-
export type PUT_NotificationsNotificationId_Request = {
|
|
2609
|
-
parameters: {
|
|
2610
|
-
path: operations['update_notification_v1_notifications__notification_id__put']['parameters']['path'];
|
|
2611
|
-
};
|
|
2612
|
-
requestBody: NotificationUpdate;
|
|
2613
|
-
}
|
|
2614
|
-
/**
|
|
2615
|
-
* Path parameters for PUT /v1/notifications/{notification_id}
|
|
2616
|
-
*
|
|
2617
|
-
* @remarks
|
|
2618
|
-
* This type defines the path parameters for the PUT /v1/notifications/{notification_id} endpoint.
|
|
2619
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2620
|
-
*
|
|
2621
|
-
* @example
|
|
2622
|
-
* Use this type to ensure type safety for path parameters.
|
|
2623
|
-
*
|
|
2624
|
-
* @path /v1/notifications/{notification_id}
|
|
2625
|
-
*/
|
|
2626
|
-
export type PUT_NotificationsNotificationId_Request_Path = PUT_NotificationsNotificationId_Request['parameters']['path'];
|
|
2627
|
-
/**
|
|
2628
|
-
* Request body for PUT /v1/notifications/{notification_id}
|
|
2629
|
-
*
|
|
2630
|
-
* @remarks
|
|
2631
|
-
* This type defines the request body structure for the PUT /v1/notifications/{notification_id} endpoint.
|
|
2632
|
-
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
2633
|
-
*
|
|
2634
|
-
* @example
|
|
2635
|
-
* Use this type to ensure type safety for request body structure.
|
|
2636
|
-
*
|
|
2637
|
-
* @path /v1/notifications/{notification_id}
|
|
2638
|
-
*/
|
|
2639
|
-
export type PUT_NotificationsNotificationId_Request_Body = PUT_NotificationsNotificationId_Request['requestBody'];
|
|
2640
|
-
|
|
2641
|
-
/**
|
|
2642
|
-
* Request type for PATCH NotificationsNotificationIdRead endpoint
|
|
2643
|
-
*
|
|
2644
|
-
* Update Notification Read
|
|
2645
|
-
*
|
|
2646
|
-
* @remarks
|
|
2647
|
-
* This type defines the complete request structure for the PATCH NotificationsNotificationIdRead endpoint.
|
|
2648
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2649
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2650
|
-
*
|
|
2651
|
-
* @example
|
|
2652
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2653
|
-
*
|
|
2654
|
-
* @path /v1/notifications/{notification_id}/read
|
|
2655
|
-
*
|
|
2656
|
-
* @see {@link PATCH_NotificationsNotificationIdRead_Request_Query} - Query parameters type
|
|
2657
|
-
* @see {@link PATCH_NotificationsNotificationIdRead_Request_Path} - Path parameters type
|
|
2658
|
-
* @see {@link PATCH_NotificationsNotificationIdRead_Request_Body} - Request body type
|
|
2659
|
-
*/
|
|
2660
|
-
export type PATCH_NotificationsNotificationIdRead_Request = {
|
|
2661
|
-
parameters: {
|
|
2662
|
-
path: operations['update_notification_read_v1_notifications__notification_id__read_patch']['parameters']['path'];
|
|
2663
|
-
};
|
|
2664
|
-
}
|
|
2665
|
-
/**
|
|
2666
|
-
* Path parameters for PATCH /v1/notifications/{notification_id}/read
|
|
2667
|
-
*
|
|
2668
|
-
* @remarks
|
|
2669
|
-
* This type defines the path parameters for the PATCH /v1/notifications/{notification_id}/read endpoint.
|
|
2670
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2671
|
-
*
|
|
2672
|
-
* @example
|
|
2673
|
-
* Use this type to ensure type safety for path parameters.
|
|
2674
|
-
*
|
|
2675
|
-
* @path /v1/notifications/{notification_id}/read
|
|
2676
|
-
*/
|
|
2677
|
-
export type PATCH_NotificationsNotificationIdRead_Request_Path = PATCH_NotificationsNotificationIdRead_Request['parameters']['path'];
|
|
2678
|
-
|
|
2679
2425
|
/**
|
|
2680
2426
|
* Request type for GET Organizations endpoint
|
|
2681
2427
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema,
|
|
37
|
+
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AuthClientCredentials endpoint
|
|
@@ -3868,300 +3868,6 @@ export type PATCH_EventsByEventId_Response_404 = Problem
|
|
|
3868
3868
|
*/
|
|
3869
3869
|
export type PATCH_EventsByEventId_Response_422 = HTTPValidationError
|
|
3870
3870
|
|
|
3871
|
-
/**
|
|
3872
|
-
* Response types for GET Notifications endpoint
|
|
3873
|
-
*
|
|
3874
|
-
* List Notifications
|
|
3875
|
-
*
|
|
3876
|
-
* @remarks
|
|
3877
|
-
* This type defines all possible response structures for the GET Notifications endpoint.
|
|
3878
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
3879
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
3880
|
-
*
|
|
3881
|
-
|
|
3882
|
-
*
|
|
3883
|
-
* @path /v1/notifications
|
|
3884
|
-
*
|
|
3885
|
-
* @see {@link GET_Notifications_Response_200} - 200 response type
|
|
3886
|
-
* @see {@link GET_Notifications_Response_422} - 422 response type
|
|
3887
|
-
*
|
|
3888
|
-
|
|
3889
|
-
*/
|
|
3890
|
-
export type GET_Notifications_Response = GET_Notifications_Response_200 | GET_Notifications_Response_422;
|
|
3891
|
-
|
|
3892
|
-
/**
|
|
3893
|
-
* 200 response for GET Notifications endpoint
|
|
3894
|
-
*
|
|
3895
|
-
* @remarks
|
|
3896
|
-
* This type defines the response structure for the 200 status code
|
|
3897
|
-
* of the GET Notifications endpoint.
|
|
3898
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3899
|
-
*
|
|
3900
|
-
|
|
3901
|
-
*
|
|
3902
|
-
* @path /v1/notifications
|
|
3903
|
-
*
|
|
3904
|
-
* @see {@link GET_Notifications_Response} - The main response type definition
|
|
3905
|
-
* @see {@link Pagination_UserNotificationSummary} - The actual schema type definition
|
|
3906
|
-
*/
|
|
3907
|
-
export type GET_Notifications_Response_200 = Pagination_UserNotificationSummary
|
|
3908
|
-
|
|
3909
|
-
/**
|
|
3910
|
-
* 422 response for GET Notifications endpoint
|
|
3911
|
-
*
|
|
3912
|
-
* @remarks
|
|
3913
|
-
* This type defines the response structure for the 422 status code
|
|
3914
|
-
* of the GET Notifications endpoint.
|
|
3915
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3916
|
-
*
|
|
3917
|
-
|
|
3918
|
-
*
|
|
3919
|
-
* @path /v1/notifications
|
|
3920
|
-
*
|
|
3921
|
-
* @see {@link GET_Notifications_Response} - The main response type definition
|
|
3922
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
3923
|
-
*/
|
|
3924
|
-
export type GET_Notifications_Response_422 = HTTPValidationError
|
|
3925
|
-
|
|
3926
|
-
/**
|
|
3927
|
-
* Response types for POST Notifications endpoint
|
|
3928
|
-
*
|
|
3929
|
-
* Create Notification
|
|
3930
|
-
*
|
|
3931
|
-
* @remarks
|
|
3932
|
-
* This type defines all possible response structures for the POST Notifications endpoint.
|
|
3933
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
3934
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
3935
|
-
*
|
|
3936
|
-
|
|
3937
|
-
*
|
|
3938
|
-
* @path /v1/notifications
|
|
3939
|
-
*
|
|
3940
|
-
* @see {@link POST_Notifications_Response_201} - 201 response type
|
|
3941
|
-
* @see {@link POST_Notifications_Response_422} - 422 response type
|
|
3942
|
-
*
|
|
3943
|
-
|
|
3944
|
-
*/
|
|
3945
|
-
export type POST_Notifications_Response = POST_Notifications_Response_201 | POST_Notifications_Response_422;
|
|
3946
|
-
|
|
3947
|
-
/**
|
|
3948
|
-
* 201 response for POST Notifications endpoint
|
|
3949
|
-
*
|
|
3950
|
-
* @remarks
|
|
3951
|
-
* This type defines the response structure for the 201 status code
|
|
3952
|
-
* of the POST Notifications endpoint.
|
|
3953
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3954
|
-
*
|
|
3955
|
-
|
|
3956
|
-
*
|
|
3957
|
-
* @path /v1/notifications
|
|
3958
|
-
*
|
|
3959
|
-
* @see {@link POST_Notifications_Response} - The main response type definition
|
|
3960
|
-
* @see {@link Notification} - The actual schema type definition
|
|
3961
|
-
*/
|
|
3962
|
-
export type POST_Notifications_Response_201 = Notification
|
|
3963
|
-
|
|
3964
|
-
/**
|
|
3965
|
-
* 422 response for POST Notifications endpoint
|
|
3966
|
-
*
|
|
3967
|
-
* @remarks
|
|
3968
|
-
* This type defines the response structure for the 422 status code
|
|
3969
|
-
* of the POST Notifications endpoint.
|
|
3970
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3971
|
-
*
|
|
3972
|
-
|
|
3973
|
-
*
|
|
3974
|
-
* @path /v1/notifications
|
|
3975
|
-
*
|
|
3976
|
-
* @see {@link POST_Notifications_Response} - The main response type definition
|
|
3977
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
3978
|
-
*/
|
|
3979
|
-
export type POST_Notifications_Response_422 = HTTPValidationError
|
|
3980
|
-
|
|
3981
|
-
/**
|
|
3982
|
-
* Response types for DELETE NotificationsByNotificationId endpoint
|
|
3983
|
-
*
|
|
3984
|
-
* Delete Notification
|
|
3985
|
-
*
|
|
3986
|
-
* @remarks
|
|
3987
|
-
* This type defines all possible response structures for the DELETE NotificationsByNotificationId endpoint.
|
|
3988
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
3989
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
3990
|
-
*
|
|
3991
|
-
|
|
3992
|
-
*
|
|
3993
|
-
* @path /v1/notifications/{notification_id}
|
|
3994
|
-
*
|
|
3995
|
-
* @see {@link DELETE_NotificationsByNotificationId_Response_422} - 422 response type
|
|
3996
|
-
*
|
|
3997
|
-
|
|
3998
|
-
*/
|
|
3999
|
-
export type DELETE_NotificationsByNotificationId_Response = DELETE_NotificationsByNotificationId_Response_422;
|
|
4000
|
-
|
|
4001
|
-
/**
|
|
4002
|
-
* 422 response for DELETE NotificationsByNotificationId endpoint
|
|
4003
|
-
*
|
|
4004
|
-
* @remarks
|
|
4005
|
-
* This type defines the response structure for the 422 status code
|
|
4006
|
-
* of the DELETE NotificationsByNotificationId endpoint.
|
|
4007
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4008
|
-
*
|
|
4009
|
-
|
|
4010
|
-
*
|
|
4011
|
-
* @path /v1/notifications/{notification_id}
|
|
4012
|
-
*
|
|
4013
|
-
* @see {@link DELETE_NotificationsByNotificationId_Response} - The main response type definition
|
|
4014
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4015
|
-
*/
|
|
4016
|
-
export type DELETE_NotificationsByNotificationId_Response_422 = HTTPValidationError
|
|
4017
|
-
|
|
4018
|
-
/**
|
|
4019
|
-
* Response types for GET NotificationsByNotificationId endpoint
|
|
4020
|
-
*
|
|
4021
|
-
* Get Notification
|
|
4022
|
-
*
|
|
4023
|
-
* @remarks
|
|
4024
|
-
* This type defines all possible response structures for the GET NotificationsByNotificationId endpoint.
|
|
4025
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4026
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4027
|
-
*
|
|
4028
|
-
|
|
4029
|
-
*
|
|
4030
|
-
* @path /v1/notifications/{notification_id}
|
|
4031
|
-
*
|
|
4032
|
-
* @see {@link GET_NotificationsByNotificationId_Response_200} - 200 response type
|
|
4033
|
-
* @see {@link GET_NotificationsByNotificationId_Response_422} - 422 response type
|
|
4034
|
-
*
|
|
4035
|
-
|
|
4036
|
-
*/
|
|
4037
|
-
export type GET_NotificationsByNotificationId_Response = GET_NotificationsByNotificationId_Response_200 | GET_NotificationsByNotificationId_Response_422;
|
|
4038
|
-
|
|
4039
|
-
/**
|
|
4040
|
-
* 200 response for GET NotificationsByNotificationId endpoint
|
|
4041
|
-
*
|
|
4042
|
-
* @remarks
|
|
4043
|
-
* This type defines the response structure for the 200 status code
|
|
4044
|
-
* of the GET NotificationsByNotificationId endpoint.
|
|
4045
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4046
|
-
*
|
|
4047
|
-
|
|
4048
|
-
*
|
|
4049
|
-
* @path /v1/notifications/{notification_id}
|
|
4050
|
-
*
|
|
4051
|
-
* @see {@link GET_NotificationsByNotificationId_Response} - The main response type definition
|
|
4052
|
-
* @see {@link UserNotification} - The actual schema type definition
|
|
4053
|
-
*/
|
|
4054
|
-
export type GET_NotificationsByNotificationId_Response_200 = UserNotification
|
|
4055
|
-
|
|
4056
|
-
/**
|
|
4057
|
-
* 422 response for GET NotificationsByNotificationId endpoint
|
|
4058
|
-
*
|
|
4059
|
-
* @remarks
|
|
4060
|
-
* This type defines the response structure for the 422 status code
|
|
4061
|
-
* of the GET NotificationsByNotificationId endpoint.
|
|
4062
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4063
|
-
*
|
|
4064
|
-
|
|
4065
|
-
*
|
|
4066
|
-
* @path /v1/notifications/{notification_id}
|
|
4067
|
-
*
|
|
4068
|
-
* @see {@link GET_NotificationsByNotificationId_Response} - The main response type definition
|
|
4069
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4070
|
-
*/
|
|
4071
|
-
export type GET_NotificationsByNotificationId_Response_422 = HTTPValidationError
|
|
4072
|
-
|
|
4073
|
-
/**
|
|
4074
|
-
* Response types for PUT NotificationsByNotificationId endpoint
|
|
4075
|
-
*
|
|
4076
|
-
* Update Notification
|
|
4077
|
-
*
|
|
4078
|
-
* @remarks
|
|
4079
|
-
* This type defines all possible response structures for the PUT NotificationsByNotificationId endpoint.
|
|
4080
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4081
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4082
|
-
*
|
|
4083
|
-
|
|
4084
|
-
*
|
|
4085
|
-
* @path /v1/notifications/{notification_id}
|
|
4086
|
-
*
|
|
4087
|
-
* @see {@link PUT_NotificationsByNotificationId_Response_200} - 200 response type
|
|
4088
|
-
* @see {@link PUT_NotificationsByNotificationId_Response_422} - 422 response type
|
|
4089
|
-
*
|
|
4090
|
-
|
|
4091
|
-
*/
|
|
4092
|
-
export type PUT_NotificationsByNotificationId_Response = PUT_NotificationsByNotificationId_Response_200 | PUT_NotificationsByNotificationId_Response_422;
|
|
4093
|
-
|
|
4094
|
-
/**
|
|
4095
|
-
* 200 response for PUT NotificationsByNotificationId endpoint
|
|
4096
|
-
*
|
|
4097
|
-
* @remarks
|
|
4098
|
-
* This type defines the response structure for the 200 status code
|
|
4099
|
-
* of the PUT NotificationsByNotificationId endpoint.
|
|
4100
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4101
|
-
*
|
|
4102
|
-
|
|
4103
|
-
*
|
|
4104
|
-
* @path /v1/notifications/{notification_id}
|
|
4105
|
-
*
|
|
4106
|
-
* @see {@link PUT_NotificationsByNotificationId_Response} - The main response type definition
|
|
4107
|
-
* @see {@link Notification} - The actual schema type definition
|
|
4108
|
-
*/
|
|
4109
|
-
export type PUT_NotificationsByNotificationId_Response_200 = Notification
|
|
4110
|
-
|
|
4111
|
-
/**
|
|
4112
|
-
* 422 response for PUT NotificationsByNotificationId endpoint
|
|
4113
|
-
*
|
|
4114
|
-
* @remarks
|
|
4115
|
-
* This type defines the response structure for the 422 status code
|
|
4116
|
-
* of the PUT NotificationsByNotificationId endpoint.
|
|
4117
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4118
|
-
*
|
|
4119
|
-
|
|
4120
|
-
*
|
|
4121
|
-
* @path /v1/notifications/{notification_id}
|
|
4122
|
-
*
|
|
4123
|
-
* @see {@link PUT_NotificationsByNotificationId_Response} - The main response type definition
|
|
4124
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4125
|
-
*/
|
|
4126
|
-
export type PUT_NotificationsByNotificationId_Response_422 = HTTPValidationError
|
|
4127
|
-
|
|
4128
|
-
/**
|
|
4129
|
-
* Response types for PATCH NotificationsByNotificationIdRead endpoint
|
|
4130
|
-
*
|
|
4131
|
-
* Update Notification Read
|
|
4132
|
-
*
|
|
4133
|
-
* @remarks
|
|
4134
|
-
* This type defines all possible response structures for the PATCH NotificationsByNotificationIdRead endpoint.
|
|
4135
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4136
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4137
|
-
*
|
|
4138
|
-
|
|
4139
|
-
*
|
|
4140
|
-
* @path /v1/notifications/{notification_id}/read
|
|
4141
|
-
*
|
|
4142
|
-
* @see {@link PATCH_NotificationsByNotificationIdRead_Response_422} - 422 response type
|
|
4143
|
-
*
|
|
4144
|
-
|
|
4145
|
-
*/
|
|
4146
|
-
export type PATCH_NotificationsByNotificationIdRead_Response = PATCH_NotificationsByNotificationIdRead_Response_422;
|
|
4147
|
-
|
|
4148
|
-
/**
|
|
4149
|
-
* 422 response for PATCH NotificationsByNotificationIdRead endpoint
|
|
4150
|
-
*
|
|
4151
|
-
* @remarks
|
|
4152
|
-
* This type defines the response structure for the 422 status code
|
|
4153
|
-
* of the PATCH NotificationsByNotificationIdRead endpoint.
|
|
4154
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4155
|
-
*
|
|
4156
|
-
|
|
4157
|
-
*
|
|
4158
|
-
* @path /v1/notifications/{notification_id}/read
|
|
4159
|
-
*
|
|
4160
|
-
* @see {@link PATCH_NotificationsByNotificationIdRead_Response} - The main response type definition
|
|
4161
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4162
|
-
*/
|
|
4163
|
-
export type PATCH_NotificationsByNotificationIdRead_Response_422 = HTTPValidationError
|
|
4164
|
-
|
|
4165
3871
|
/**
|
|
4166
3872
|
* Response types for GET Organizations endpoint
|
|
4167
3873
|
*
|
|
@@ -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, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -597,20 +597,6 @@ export type OrganizationCredentialArray = OrganizationCredential[];
|
|
|
597
597
|
* @see {@link Organization} - The individual Organization type definition
|
|
598
598
|
*/
|
|
599
599
|
export type OrganizationArray = Organization[];
|
|
600
|
-
/**
|
|
601
|
-
* UserNotificationSummary
|
|
602
|
-
*
|
|
603
|
-
* @remarks
|
|
604
|
-
* Array type for UserNotificationSummary objects. Used when the API returns a collection of UserNotificationSummary instances.
|
|
605
|
-
*
|
|
606
|
-
* @example
|
|
607
|
-
* ```typescript
|
|
608
|
-
* const items: UserNotificationSummaryArray = await api.getUserNotificationSummarys();
|
|
609
|
-
* ```
|
|
610
|
-
*
|
|
611
|
-
* @see {@link UserNotificationSummary} - The individual UserNotificationSummary type definition
|
|
612
|
-
*/
|
|
613
|
-
export type UserNotificationSummaryArray = UserNotificationSummary[];
|
|
614
600
|
/**
|
|
615
601
|
* Period
|
|
616
602
|
*
|