@opusdns/api 0.167.0 → 0.169.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 +111 -297
- package/src/helpers/requests.d.ts +58 -1
- package/src/helpers/responses.d.ts +103 -21
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +16 -32
- package/src/openapi.yaml +133 -107
- package/src/schema.d.ts +114 -70
package/src/schema.d.ts
CHANGED
|
@@ -1568,6 +1568,26 @@ export interface paths {
|
|
|
1568
1568
|
patch?: never;
|
|
1569
1569
|
trace?: never;
|
|
1570
1570
|
};
|
|
1571
|
+
"/v1/parking/metrics": {
|
|
1572
|
+
parameters: {
|
|
1573
|
+
query?: never;
|
|
1574
|
+
header?: never;
|
|
1575
|
+
path?: never;
|
|
1576
|
+
cookie?: never;
|
|
1577
|
+
};
|
|
1578
|
+
/**
|
|
1579
|
+
* Get total metrics for all parking entries
|
|
1580
|
+
* @description Retrieves aggregated metrics for all parking entries of the organization.
|
|
1581
|
+
*/
|
|
1582
|
+
get: operations["get_total_parking_metrics_v1_parking_metrics_get"];
|
|
1583
|
+
put?: never;
|
|
1584
|
+
post?: never;
|
|
1585
|
+
delete?: never;
|
|
1586
|
+
options?: never;
|
|
1587
|
+
head?: never;
|
|
1588
|
+
patch?: never;
|
|
1589
|
+
trace?: never;
|
|
1590
|
+
};
|
|
1571
1591
|
"/v1/parking/{parking_id}/metrics": {
|
|
1572
1592
|
parameters: {
|
|
1573
1593
|
query?: never;
|
|
@@ -1577,7 +1597,7 @@ export interface paths {
|
|
|
1577
1597
|
};
|
|
1578
1598
|
/**
|
|
1579
1599
|
* Get metrics for a parking entry
|
|
1580
|
-
* @description Retrieves metrics for a specific parking entry by ID
|
|
1600
|
+
* @description Retrieves metrics for a specific parking entry by ID.
|
|
1581
1601
|
*/
|
|
1582
1602
|
get: operations["get_parking_metrics_v1_parking__parking_id__metrics_get"];
|
|
1583
1603
|
put?: never;
|
|
@@ -5021,12 +5041,6 @@ export interface components {
|
|
|
5021
5041
|
/** Results */
|
|
5022
5042
|
results: components["schemas"]["Organization"][];
|
|
5023
5043
|
};
|
|
5024
|
-
/** Pagination[ParkingResponse] */
|
|
5025
|
-
Pagination_ParkingResponse_: {
|
|
5026
|
-
pagination: components["schemas"]["PaginationMetadata"];
|
|
5027
|
-
/** Results */
|
|
5028
|
-
results: components["schemas"]["ParkingResponse"][];
|
|
5029
|
-
};
|
|
5030
5044
|
/** Pagination[RequestHistory] */
|
|
5031
5045
|
Pagination_RequestHistory_: {
|
|
5032
5046
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -5041,64 +5055,18 @@ export interface components {
|
|
|
5041
5055
|
};
|
|
5042
5056
|
/** ParkingMetricsResponse */
|
|
5043
5057
|
ParkingMetricsResponse: {
|
|
5058
|
+
/** @description Metrics for the parking entry */
|
|
5059
|
+
metrics: components["schemas"]["ParkingStatistics"];
|
|
5044
5060
|
/**
|
|
5045
|
-
*
|
|
5046
|
-
*
|
|
5047
|
-
* @description Unique identifier for the parking entry
|
|
5048
|
-
* @example parking_01h45ytscbebyvny4gc8cr8ma2
|
|
5049
|
-
*/
|
|
5050
|
-
parking_id: TypeId<"parking">;
|
|
5051
|
-
/** @description Statistics for the parking entry */
|
|
5052
|
-
statistics: components["schemas"]["ParkingStatistics"];
|
|
5053
|
-
};
|
|
5054
|
-
/** ParkingResponse */
|
|
5055
|
-
ParkingResponse: {
|
|
5056
|
-
/** @description The compliance status of the parking ad */
|
|
5057
|
-
compliance_status?: components["schemas"]["ComplianceStatus"] | null;
|
|
5058
|
-
/**
|
|
5059
|
-
* Content Language
|
|
5060
|
-
* @description The primary language code for the ad content
|
|
5061
|
-
*/
|
|
5062
|
-
content_language?: string | null;
|
|
5063
|
-
/**
|
|
5064
|
-
* Content Url
|
|
5065
|
-
* @description The content URL for approved parking ads
|
|
5066
|
-
*/
|
|
5067
|
-
content_url?: string | null;
|
|
5068
|
-
/**
|
|
5069
|
-
* Created On
|
|
5070
|
-
* Format: date-time
|
|
5071
|
-
* @description When the parking entry was created
|
|
5061
|
+
* Renewal Cost
|
|
5062
|
+
* @description Yearly renewal cost for the parked domain
|
|
5072
5063
|
*/
|
|
5073
|
-
|
|
5064
|
+
renewal_cost: string;
|
|
5074
5065
|
/**
|
|
5075
|
-
*
|
|
5076
|
-
* @description
|
|
5066
|
+
* Revenue Progress
|
|
5067
|
+
* @description Revenue progress percentage towards covering renewal cost
|
|
5077
5068
|
*/
|
|
5078
|
-
|
|
5079
|
-
/**
|
|
5080
|
-
* Enabled
|
|
5081
|
-
* @description Whether parking is enabled
|
|
5082
|
-
*/
|
|
5083
|
-
enabled: boolean;
|
|
5084
|
-
/**
|
|
5085
|
-
* Note
|
|
5086
|
-
* @description Additional notes about the parking ad
|
|
5087
|
-
*/
|
|
5088
|
-
note?: string | null;
|
|
5089
|
-
/**
|
|
5090
|
-
* Parking Id
|
|
5091
|
-
* Format: typeid
|
|
5092
|
-
* @description Unique identifier for the parking entry
|
|
5093
|
-
* @example parking_01h45ytscbebyvny4gc8cr8ma2
|
|
5094
|
-
*/
|
|
5095
|
-
parking_id: TypeId<"parking">;
|
|
5096
|
-
/**
|
|
5097
|
-
* Updated On
|
|
5098
|
-
* Format: date-time
|
|
5099
|
-
* @description When the parking entry was last updated
|
|
5100
|
-
*/
|
|
5101
|
-
updated_on: Date;
|
|
5069
|
+
revenue_progress: string;
|
|
5102
5070
|
};
|
|
5103
5071
|
/**
|
|
5104
5072
|
* ParkingSortField
|
|
@@ -5112,11 +5080,6 @@ export interface components {
|
|
|
5112
5080
|
* @description Number of conversions
|
|
5113
5081
|
*/
|
|
5114
5082
|
conversions: number;
|
|
5115
|
-
/**
|
|
5116
|
-
* Profit
|
|
5117
|
-
* @description Total profit
|
|
5118
|
-
*/
|
|
5119
|
-
profit: string;
|
|
5120
5083
|
/**
|
|
5121
5084
|
* Revenue
|
|
5122
5085
|
* @description Total revenue
|
|
@@ -5138,6 +5101,16 @@ export interface components {
|
|
|
5138
5101
|
*/
|
|
5139
5102
|
views: number;
|
|
5140
5103
|
};
|
|
5104
|
+
/** ParkingTotalMetricsResponse */
|
|
5105
|
+
ParkingTotalMetricsResponse: {
|
|
5106
|
+
/**
|
|
5107
|
+
* Total Count
|
|
5108
|
+
* @description Total number of parking entries
|
|
5109
|
+
*/
|
|
5110
|
+
total_count: number;
|
|
5111
|
+
/** @description Aggregated metrics for all parking entries */
|
|
5112
|
+
total_metrics: components["schemas"]["ParkingStatistics"];
|
|
5113
|
+
};
|
|
5141
5114
|
/** PasswordUpdate */
|
|
5142
5115
|
PasswordUpdate: {
|
|
5143
5116
|
/**
|
|
@@ -12730,13 +12703,15 @@ export interface operations {
|
|
|
12730
12703
|
list_parking_v1_parking_get: {
|
|
12731
12704
|
parameters: {
|
|
12732
12705
|
query?: {
|
|
12706
|
+
/** @description Page number */
|
|
12707
|
+
page?: number;
|
|
12708
|
+
/** @description Page size */
|
|
12709
|
+
page_size?: number;
|
|
12733
12710
|
sort_by?: components["schemas"]["ParkingSortField"];
|
|
12734
12711
|
sort_order?: components["schemas"]["SortOrder"];
|
|
12735
12712
|
search?: string | null;
|
|
12736
12713
|
enabled?: boolean | null;
|
|
12737
12714
|
compliance_status?: components["schemas"]["ComplianceStatus"] | null;
|
|
12738
|
-
page?: number;
|
|
12739
|
-
page_size?: number;
|
|
12740
12715
|
};
|
|
12741
12716
|
header?: never;
|
|
12742
12717
|
path?: never;
|
|
@@ -12750,7 +12725,73 @@ export interface operations {
|
|
|
12750
12725
|
[name: string]: unknown;
|
|
12751
12726
|
};
|
|
12752
12727
|
content: {
|
|
12753
|
-
"application/json":
|
|
12728
|
+
"application/json": {
|
|
12729
|
+
[key: string]: unknown;
|
|
12730
|
+
};
|
|
12731
|
+
};
|
|
12732
|
+
};
|
|
12733
|
+
/** @description Unauthorized */
|
|
12734
|
+
401: {
|
|
12735
|
+
headers: {
|
|
12736
|
+
[name: string]: unknown;
|
|
12737
|
+
};
|
|
12738
|
+
content: {
|
|
12739
|
+
/** @example {
|
|
12740
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
12741
|
+
* "detail": "Additional error context.",
|
|
12742
|
+
* "status": 401,
|
|
12743
|
+
* "title": "Authentication Error",
|
|
12744
|
+
* "type": "authentication"
|
|
12745
|
+
* } */
|
|
12746
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
12747
|
+
};
|
|
12748
|
+
};
|
|
12749
|
+
/** @description Forbidden */
|
|
12750
|
+
403: {
|
|
12751
|
+
headers: {
|
|
12752
|
+
[name: string]: unknown;
|
|
12753
|
+
};
|
|
12754
|
+
content: {
|
|
12755
|
+
/** @example {
|
|
12756
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
12757
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
12758
|
+
* "status": 403,
|
|
12759
|
+
* "title": "Permission Denied",
|
|
12760
|
+
* "type": "permission-denied"
|
|
12761
|
+
* } */
|
|
12762
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
12763
|
+
};
|
|
12764
|
+
};
|
|
12765
|
+
/** @description Validation Error */
|
|
12766
|
+
422: {
|
|
12767
|
+
headers: {
|
|
12768
|
+
[name: string]: unknown;
|
|
12769
|
+
};
|
|
12770
|
+
content: {
|
|
12771
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
12772
|
+
};
|
|
12773
|
+
};
|
|
12774
|
+
};
|
|
12775
|
+
};
|
|
12776
|
+
get_total_parking_metrics_v1_parking_metrics_get: {
|
|
12777
|
+
parameters: {
|
|
12778
|
+
query?: {
|
|
12779
|
+
start_time?: Date | null;
|
|
12780
|
+
end_time?: Date | null;
|
|
12781
|
+
};
|
|
12782
|
+
header?: never;
|
|
12783
|
+
path?: never;
|
|
12784
|
+
cookie?: never;
|
|
12785
|
+
};
|
|
12786
|
+
requestBody?: never;
|
|
12787
|
+
responses: {
|
|
12788
|
+
/** @description Successful Response */
|
|
12789
|
+
200: {
|
|
12790
|
+
headers: {
|
|
12791
|
+
[name: string]: unknown;
|
|
12792
|
+
};
|
|
12793
|
+
content: {
|
|
12794
|
+
"application/json": components["schemas"]["ParkingTotalMetricsResponse"];
|
|
12754
12795
|
};
|
|
12755
12796
|
};
|
|
12756
12797
|
/** @description Unauthorized */
|
|
@@ -12798,7 +12839,10 @@ export interface operations {
|
|
|
12798
12839
|
};
|
|
12799
12840
|
get_parking_metrics_v1_parking__parking_id__metrics_get: {
|
|
12800
12841
|
parameters: {
|
|
12801
|
-
query?:
|
|
12842
|
+
query?: {
|
|
12843
|
+
start_time?: Date | null;
|
|
12844
|
+
end_time?: Date | null;
|
|
12845
|
+
};
|
|
12802
12846
|
header?: never;
|
|
12803
12847
|
path: {
|
|
12804
12848
|
parking_id: TypeId<"parking">;
|