synmax-api-python-client 4.16.0__py3-none-any.whl → 4.17.0__py3-none-any.whl
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.
- synmax/hyperion/v4/hyperion_client.pyi +3 -0
- synmax/hyperion/v4/openapi.yaml +131 -67
- synmax/leviaton/v1/leviaton_client.pyi +3 -0
- synmax/leviaton/v1/openapi.yaml +65 -1
- synmax/openapi/client.py +9 -10
- synmax/openapi/utils.py +165 -4
- synmax/vulcan/v1/openapi.yaml +984 -0
- synmax/vulcan/v1/vulcan_client.pyi +19 -0
- synmax/vulcan/v2/openapi.yaml +66 -2
- synmax/vulcan/v2/vulcan_client.pyi +3 -0
- {synmax_api_python_client-4.16.0.dist-info → synmax_api_python_client-4.17.0.dist-info}/METADATA +1 -1
- {synmax_api_python_client-4.16.0.dist-info → synmax_api_python_client-4.17.0.dist-info}/RECORD +15 -19
- synmax/hyperion/v4/start_hyperion_client.py +0 -27
- synmax/leviaton/start_leviaton_client.py +0 -105
- synmax/leviaton/start_leviaton_client2.py +0 -81
- synmax/vulcan/start_vulcan_python_client.py +0 -14
- synmax/vulcan/v2/start_vulcan_client.py +0 -28
- synmax/vulcan/v2/start_vulcan_client2.py +0 -43
- {synmax_api_python_client-4.16.0.dist-info → synmax_api_python_client-4.17.0.dist-info}/LICENSE +0 -0
- {synmax_api_python_client-4.16.0.dist-info → synmax_api_python_client-4.17.0.dist-info}/WHEEL +0 -0
- {synmax_api_python_client-4.16.0.dist-info → synmax_api_python_client-4.17.0.dist-info}/top_level.txt +0 -0
|
@@ -74,6 +74,9 @@ class HyperionApiClient:
|
|
|
74
74
|
def beta_query_datalinks(self,query: str,session_id: str = ...) -> Result:
|
|
75
75
|
"""Execute SQL queries against SynMax datalinks"""
|
|
76
76
|
...
|
|
77
|
+
def query_datalinks(self,query: str,session_id: str = ...) -> Result:
|
|
78
|
+
"""Execute SQL queries against SynMax datalinks"""
|
|
79
|
+
...
|
|
77
80
|
def beta_complete_report_date(self,sub_region_natgas: Union[list[str], str] = ...) -> Result:
|
|
78
81
|
"""Get most recent date for which pipeline scrapes, gas and oil datasets are considered complete, by subregion."""
|
|
79
82
|
...
|
synmax/hyperion/v4/openapi.yaml
CHANGED
|
@@ -83,15 +83,15 @@ paths:
|
|
|
83
83
|
allOf:
|
|
84
84
|
- $ref: '#/components/schemas/date'
|
|
85
85
|
description: The date range minimum the well crew started fracking in YYYY-MM-DD format
|
|
86
|
-
date_completion_start_max:
|
|
86
|
+
date_completion_start_max:
|
|
87
87
|
allOf:
|
|
88
|
-
- $ref: '#/components/schemas/date'
|
|
88
|
+
- $ref: '#/components/schemas/date'
|
|
89
89
|
description: The date range maximum the well crew started fracking in YYYY-MM-DD format
|
|
90
|
-
date_completion_end_min:
|
|
90
|
+
date_completion_end_min:
|
|
91
91
|
allOf:
|
|
92
92
|
- $ref: '#/components/schemas/date'
|
|
93
93
|
description: The date range minimum the well crew completed fracking in YYYY-MM-DD format
|
|
94
|
-
date_completion_end_max:
|
|
94
|
+
date_completion_end_max:
|
|
95
95
|
allOf:
|
|
96
96
|
- $ref: '#/components/schemas/date'
|
|
97
97
|
description: The date range maximum the well crew completed fracking in YYYY-MM-DD format
|
|
@@ -135,7 +135,7 @@ paths:
|
|
|
135
135
|
allOf:
|
|
136
136
|
- $ref: '#/components/schemas/date'
|
|
137
137
|
description: The date range minimum the well crew completed fracking in YYYY-MM-DD format
|
|
138
|
-
date_frac_max:
|
|
138
|
+
date_frac_max:
|
|
139
139
|
allOf:
|
|
140
140
|
- $ref: '#/components/schemas/date'
|
|
141
141
|
description: The date range maximum the well crew completed fracking in YYYY-MM-DD format
|
|
@@ -173,11 +173,11 @@ paths:
|
|
|
173
173
|
date_prod_min:
|
|
174
174
|
allOf:
|
|
175
175
|
- $ref: '#/components/schemas/date'
|
|
176
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
177
|
-
date_prod_max:
|
|
176
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
177
|
+
date_prod_max:
|
|
178
178
|
allOf:
|
|
179
179
|
- $ref: '#/components/schemas/date'
|
|
180
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
180
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
181
181
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
182
182
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
183
183
|
responses:
|
|
@@ -206,7 +206,7 @@ paths:
|
|
|
206
206
|
allOf:
|
|
207
207
|
- $ref: '#/components/schemas/date'
|
|
208
208
|
description: The start date in a range for historical dry gas factors in YYYY-MM-DD format
|
|
209
|
-
date_factor_max:
|
|
209
|
+
date_factor_max:
|
|
210
210
|
allOf:
|
|
211
211
|
- $ref: '#/components/schemas/date'
|
|
212
212
|
description: The end date in a range for historical dry gas factors in YYYY-MM-DD format
|
|
@@ -250,11 +250,11 @@ paths:
|
|
|
250
250
|
date_observed_min:
|
|
251
251
|
allOf:
|
|
252
252
|
- $ref: '#/components/schemas/date'
|
|
253
|
-
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
254
|
-
date_observed_max:
|
|
253
|
+
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
254
|
+
date_observed_max:
|
|
255
255
|
allOf:
|
|
256
256
|
- $ref: '#/components/schemas/date'
|
|
257
|
-
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
257
|
+
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
258
258
|
operator: { $ref: '#/components/schemas/operator_array' }
|
|
259
259
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
260
260
|
state_code: { $ref: '#/components/schemas/state_code_array' }
|
|
@@ -339,11 +339,11 @@ paths:
|
|
|
339
339
|
date_prod_min:
|
|
340
340
|
allOf:
|
|
341
341
|
- $ref: '#/components/schemas/date'
|
|
342
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
343
|
-
date_prod_max:
|
|
342
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
343
|
+
date_prod_max:
|
|
344
344
|
allOf:
|
|
345
345
|
- $ref: '#/components/schemas/date'
|
|
346
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
346
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
347
347
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
348
348
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
349
349
|
responses:
|
|
@@ -390,11 +390,11 @@ paths:
|
|
|
390
390
|
date_prod_min:
|
|
391
391
|
allOf:
|
|
392
392
|
- $ref: '#/components/schemas/date'
|
|
393
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
394
|
-
date_prod_max:
|
|
393
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
394
|
+
date_prod_max:
|
|
395
395
|
allOf:
|
|
396
396
|
- $ref: '#/components/schemas/date'
|
|
397
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
397
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
398
398
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
399
399
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
400
400
|
responses:
|
|
@@ -430,11 +430,11 @@ paths:
|
|
|
430
430
|
date_prod_min:
|
|
431
431
|
allOf:
|
|
432
432
|
- $ref: '#/components/schemas/date'
|
|
433
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
434
|
-
date_prod_max:
|
|
433
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
434
|
+
date_prod_max:
|
|
435
435
|
allOf:
|
|
436
436
|
- $ref: '#/components/schemas/date'
|
|
437
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
437
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
438
438
|
operator: { $ref: '#/components/schemas/operator_array' }
|
|
439
439
|
production_month: { $ref: '#/components/schemas/integer_array' }
|
|
440
440
|
production_month_min: { type: integer, description: "The minimum number of months this well has been producing" }
|
|
@@ -488,11 +488,11 @@ paths:
|
|
|
488
488
|
date_observed_min:
|
|
489
489
|
allOf:
|
|
490
490
|
- $ref: '#/components/schemas/date'
|
|
491
|
-
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
492
|
-
date_observed_max:
|
|
491
|
+
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
492
|
+
date_observed_max:
|
|
493
493
|
allOf:
|
|
494
494
|
- $ref: '#/components/schemas/date'
|
|
495
|
-
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
495
|
+
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
496
496
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
497
497
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
498
498
|
county: { $ref: '#/components/schemas/county_array' }
|
|
@@ -530,11 +530,11 @@ paths:
|
|
|
530
530
|
date_observed_min:
|
|
531
531
|
allOf:
|
|
532
532
|
- $ref: '#/components/schemas/date'
|
|
533
|
-
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
534
|
-
date_observed_max:
|
|
533
|
+
description: The date range minimum of the satellite image in YYYY-MM-DD format
|
|
534
|
+
date_observed_max:
|
|
535
535
|
allOf:
|
|
536
536
|
- $ref: '#/components/schemas/date'
|
|
537
|
-
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
537
|
+
description: The date range maximum of the satellite image in YYYY-MM-DD format
|
|
538
538
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
539
539
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
540
540
|
county: { $ref: '#/components/schemas/county_array' }
|
|
@@ -580,11 +580,11 @@ paths:
|
|
|
580
580
|
date_prod_min:
|
|
581
581
|
allOf:
|
|
582
582
|
- $ref: '#/components/schemas/date'
|
|
583
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
584
|
-
date_prod_max:
|
|
583
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
584
|
+
date_prod_max:
|
|
585
585
|
allOf:
|
|
586
586
|
- $ref: '#/components/schemas/date'
|
|
587
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
587
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
588
588
|
operator: { $ref: '#/components/schemas/operator_array' }
|
|
589
589
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
590
590
|
state_code: { $ref: '#/components/schemas/state_code_array' }
|
|
@@ -634,11 +634,11 @@ paths:
|
|
|
634
634
|
date_prod_min:
|
|
635
635
|
allOf:
|
|
636
636
|
- $ref: '#/components/schemas/date'
|
|
637
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
638
|
-
date_prod_max:
|
|
637
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
638
|
+
date_prod_max:
|
|
639
639
|
allOf:
|
|
640
640
|
- $ref: '#/components/schemas/date'
|
|
641
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
641
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
642
642
|
first_production_month_min: { $ref: '#/components/schemas/date' }
|
|
643
643
|
first_production_month_max: { $ref: '#/components/schemas/date' }
|
|
644
644
|
modeled:
|
|
@@ -695,14 +695,14 @@ paths:
|
|
|
695
695
|
allOf:
|
|
696
696
|
- $ref: '#/components/schemas/date'
|
|
697
697
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
698
|
-
date_prod_min:
|
|
698
|
+
date_prod_min:
|
|
699
699
|
allOf:
|
|
700
700
|
- $ref: '#/components/schemas/date'
|
|
701
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
702
|
-
date_prod_max:
|
|
701
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
702
|
+
date_prod_max:
|
|
703
703
|
allOf:
|
|
704
704
|
- $ref: '#/components/schemas/date'
|
|
705
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
705
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
706
706
|
operator: { $ref: '#/components/schemas/operator_array' }
|
|
707
707
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
708
708
|
state_code: { $ref: '#/components/schemas/state_code_array' }
|
|
@@ -747,14 +747,14 @@ paths:
|
|
|
747
747
|
allOf:
|
|
748
748
|
- $ref: '#/components/schemas/date'
|
|
749
749
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
750
|
-
date_prod_min:
|
|
750
|
+
date_prod_min:
|
|
751
751
|
allOf:
|
|
752
752
|
- $ref: '#/components/schemas/date'
|
|
753
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
754
|
-
date_prod_max:
|
|
753
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
754
|
+
date_prod_max:
|
|
755
755
|
allOf:
|
|
756
756
|
- $ref: '#/components/schemas/date'
|
|
757
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
757
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
758
758
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
759
759
|
responses:
|
|
760
760
|
'200':
|
|
@@ -825,7 +825,7 @@ paths:
|
|
|
825
825
|
allOf:
|
|
826
826
|
- $ref: '#/components/schemas/date'
|
|
827
827
|
description: The date range minimum of the spud date from the well drilling permit in YYYY-MM-DD format
|
|
828
|
-
date_spud_max:
|
|
828
|
+
date_spud_max:
|
|
829
829
|
allOf:
|
|
830
830
|
- $ref: '#/components/schemas/date'
|
|
831
831
|
description: The date range maximum of the spud date from the well drilling permit in YYYY-MM-DD format
|
|
@@ -899,7 +899,7 @@ paths:
|
|
|
899
899
|
allOf:
|
|
900
900
|
- $ref: '#/components/schemas/date'
|
|
901
901
|
description: The date range minimum the well crew completed fracking in YYYY-MM-DD format
|
|
902
|
-
date_frac_max:
|
|
902
|
+
date_frac_max:
|
|
903
903
|
allOf:
|
|
904
904
|
- $ref: '#/components/schemas/date'
|
|
905
905
|
description: The date range maximum the well crew completed fracking in YYYY-MM-DD format
|
|
@@ -948,7 +948,7 @@ paths:
|
|
|
948
948
|
allOf:
|
|
949
949
|
- $ref: '#/components/schemas/date'
|
|
950
950
|
description: The date range minimum the well crew completed fracking in YYYY-MM-DD format
|
|
951
|
-
date_frac_max:
|
|
951
|
+
date_frac_max:
|
|
952
952
|
allOf:
|
|
953
953
|
- $ref: '#/components/schemas/date'
|
|
954
954
|
description: The date range maximum the well crew completed fracking in YYYY-MM-DD format
|
|
@@ -1002,7 +1002,7 @@ paths:
|
|
|
1002
1002
|
allOf:
|
|
1003
1003
|
- $ref: '#/components/schemas/date'
|
|
1004
1004
|
description: The date range minimum of the spud date from the well drilling permit in YYYY-MM-DD format
|
|
1005
|
-
date_spud_max:
|
|
1005
|
+
date_spud_max:
|
|
1006
1006
|
allOf:
|
|
1007
1007
|
- $ref: '#/components/schemas/date'
|
|
1008
1008
|
description: The date range maximum of the spud date from the well drilling permit in YYYY-MM-DD format
|
|
@@ -1064,7 +1064,7 @@ paths:
|
|
|
1064
1064
|
properties:
|
|
1065
1065
|
wellpad_id: { $ref: '#/components/schemas/wellpad_id_string_array' }
|
|
1066
1066
|
well_id: { $ref: '#/components/schemas/well_id_array' }
|
|
1067
|
-
is_canadian_batch:
|
|
1067
|
+
is_canadian_batch:
|
|
1068
1068
|
type: boolean
|
|
1069
1069
|
description: "Whether the well is part of a Canadian batch. If not specified, the well is not part of a Canadian batch."
|
|
1070
1070
|
responses:
|
|
@@ -1099,7 +1099,7 @@ paths:
|
|
|
1099
1099
|
allOf:
|
|
1100
1100
|
- $ref: '#/components/schemas/date'
|
|
1101
1101
|
description: The date range minimum of the wellpad status in YYYY-MM-DD format
|
|
1102
|
-
date_status_max:
|
|
1102
|
+
date_status_max:
|
|
1103
1103
|
allOf:
|
|
1104
1104
|
- $ref: '#/components/schemas/date'
|
|
1105
1105
|
description: The date range maximum of the wellpad status in YYYY-MM-DD format
|
|
@@ -1122,7 +1122,71 @@ paths:
|
|
|
1122
1122
|
x-method-name: beta_query_datalinks
|
|
1123
1123
|
security: [ApiKeyAuth: [hyperion]]
|
|
1124
1124
|
summary: Execute SQL queries against SynMax datalinks
|
|
1125
|
-
description: Execute T-SQL queries directly against SynMax's 5 datalinks (19 tables). Returns query results as structured data.
|
|
1125
|
+
description: Execute T-SQL queries directly against SynMax's 5 datalinks (19 tables). Returns query results as structured data.
|
|
1126
|
+
requestBody:
|
|
1127
|
+
required: true
|
|
1128
|
+
content:
|
|
1129
|
+
application/json:
|
|
1130
|
+
schema:
|
|
1131
|
+
type: object
|
|
1132
|
+
required: [query]
|
|
1133
|
+
additionalProperties: false
|
|
1134
|
+
properties:
|
|
1135
|
+
query:
|
|
1136
|
+
type: string
|
|
1137
|
+
description: SQL query to execute. Tables must use {linkid}_{table} format. Use ANSI SQL (LIMIT not TOP).
|
|
1138
|
+
example: "SELECT * FROM hdl.pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
|
|
1139
|
+
session_id:
|
|
1140
|
+
type: string
|
|
1141
|
+
description: Optional session ID for logging/tracking. Auto-generated if not provided.
|
|
1142
|
+
example: "my_session_123"
|
|
1143
|
+
responses:
|
|
1144
|
+
'200':
|
|
1145
|
+
description: Query executed successfully. Returns JSON array or NDJSON based on Accept header.
|
|
1146
|
+
content:
|
|
1147
|
+
application/json:
|
|
1148
|
+
schema:
|
|
1149
|
+
type: object
|
|
1150
|
+
description: JSON array of objects, each representing one row from the query result.
|
|
1151
|
+
x-dynamic-response: true
|
|
1152
|
+
application/x-ndjson:
|
|
1153
|
+
schema:
|
|
1154
|
+
type: object
|
|
1155
|
+
description: Each line is a JSON object representing one row from the query result.
|
|
1156
|
+
x-dynamic-response: true
|
|
1157
|
+
'400':
|
|
1158
|
+
description: Invalid query or missing required fields
|
|
1159
|
+
content:
|
|
1160
|
+
application/json:
|
|
1161
|
+
schema:
|
|
1162
|
+
type: object
|
|
1163
|
+
properties:
|
|
1164
|
+
error:
|
|
1165
|
+
type: string
|
|
1166
|
+
'403':
|
|
1167
|
+
description: Permission denied - user lacks access to requested datalink/tables
|
|
1168
|
+
content:
|
|
1169
|
+
application/json:
|
|
1170
|
+
schema:
|
|
1171
|
+
type: object
|
|
1172
|
+
properties:
|
|
1173
|
+
error:
|
|
1174
|
+
type: string
|
|
1175
|
+
'502':
|
|
1176
|
+
description: DLS service unavailable
|
|
1177
|
+
content:
|
|
1178
|
+
application/json:
|
|
1179
|
+
schema:
|
|
1180
|
+
type: object
|
|
1181
|
+
properties:
|
|
1182
|
+
error:
|
|
1183
|
+
type: string
|
|
1184
|
+
/query_datalinks:
|
|
1185
|
+
post:
|
|
1186
|
+
x-method-name: query_datalinks
|
|
1187
|
+
security: [ApiKeyAuth: [hyperion]]
|
|
1188
|
+
summary: Execute SQL queries against SynMax datalinks
|
|
1189
|
+
description: Execute T-SQL queries directly against SynMax's 5 datalinks (19 tables). Returns query results as structured data.
|
|
1126
1190
|
requestBody:
|
|
1127
1191
|
required: true
|
|
1128
1192
|
content:
|
|
@@ -1135,7 +1199,7 @@ paths:
|
|
|
1135
1199
|
query:
|
|
1136
1200
|
type: string
|
|
1137
1201
|
description: SQL query to execute. Tables must use {linkid}_{table} format. Use ANSI SQL (LIMIT not TOP).
|
|
1138
|
-
example: "SELECT * FROM
|
|
1202
|
+
example: "SELECT * FROM hdl.pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
|
|
1139
1203
|
session_id:
|
|
1140
1204
|
type: string
|
|
1141
1205
|
description: Optional session ID for logging/tracking. Auto-generated if not provided.
|
|
@@ -1421,11 +1485,11 @@ paths:
|
|
|
1421
1485
|
date_prod_min:
|
|
1422
1486
|
allOf:
|
|
1423
1487
|
- $ref: '#/components/schemas/date'
|
|
1424
|
-
description: The date range minimum of production in YYYY-MM-DD format
|
|
1425
|
-
date_prod_max:
|
|
1488
|
+
description: The date range minimum of production in YYYY-MM-DD format
|
|
1489
|
+
date_prod_max:
|
|
1426
1490
|
allOf:
|
|
1427
1491
|
- $ref: '#/components/schemas/date'
|
|
1428
|
-
description: The date range maximum of production in YYYY-MM-DD format
|
|
1492
|
+
description: The date range maximum of production in YYYY-MM-DD format
|
|
1429
1493
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
1430
1494
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
1431
1495
|
responses:
|
|
@@ -1547,19 +1611,19 @@ components:
|
|
|
1547
1611
|
allOf:
|
|
1548
1612
|
- $ref: '#/components/schemas/date'
|
|
1549
1613
|
description: The date a well first started producing in YYYY-MM-DD format
|
|
1550
|
-
date_last_recompletion:
|
|
1614
|
+
date_last_recompletion:
|
|
1551
1615
|
allOf:
|
|
1552
1616
|
- $ref: '#/components/schemas/date'
|
|
1553
1617
|
description: The date a well was last recompleted in YYYY-MM-DD format
|
|
1554
|
-
date_permit:
|
|
1618
|
+
date_permit:
|
|
1555
1619
|
allOf:
|
|
1556
1620
|
- $ref: '#/components/schemas/date'
|
|
1557
1621
|
description: The date the well drilling permit was filed in YYYY-MM-DD format
|
|
1558
|
-
date_spud:
|
|
1622
|
+
date_spud:
|
|
1559
1623
|
allOf:
|
|
1560
1624
|
- $ref: '#/components/schemas/date'
|
|
1561
1625
|
description: Spud date from well drilling permit in YYYY-MM-DD format
|
|
1562
|
-
date_status:
|
|
1626
|
+
date_status:
|
|
1563
1627
|
allOf:
|
|
1564
1628
|
- $ref: '#/components/schemas/date'
|
|
1565
1629
|
description: The date the wellpad status was applied in YYYY-MM-DD format
|
|
@@ -1696,7 +1760,7 @@ components:
|
|
|
1696
1760
|
allOf:
|
|
1697
1761
|
- $ref: '#/components/schemas/date'
|
|
1698
1762
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
1699
|
-
date_prod:
|
|
1763
|
+
date_prod:
|
|
1700
1764
|
allOf:
|
|
1701
1765
|
- $ref: '#/components/schemas/date'
|
|
1702
1766
|
description: The date of production in YYYY-MM-DD format
|
|
@@ -1712,7 +1776,7 @@ components:
|
|
|
1712
1776
|
allOf:
|
|
1713
1777
|
- $ref: '#/components/schemas/date'
|
|
1714
1778
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
1715
|
-
date_prod:
|
|
1779
|
+
date_prod:
|
|
1716
1780
|
allOf:
|
|
1717
1781
|
- $ref: '#/components/schemas/date'
|
|
1718
1782
|
description: The date of production in YYYY-MM-DD format
|
|
@@ -1741,7 +1805,7 @@ components:
|
|
|
1741
1805
|
allOf:
|
|
1742
1806
|
- $ref: '#/components/schemas/date'
|
|
1743
1807
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
1744
|
-
date_prod:
|
|
1808
|
+
date_prod:
|
|
1745
1809
|
allOf:
|
|
1746
1810
|
- $ref: '#/components/schemas/date'
|
|
1747
1811
|
description: The date of production in YYYY-MM-DD format
|
|
@@ -1769,7 +1833,7 @@ components:
|
|
|
1769
1833
|
allOf:
|
|
1770
1834
|
- $ref: '#/components/schemas/date'
|
|
1771
1835
|
description: The date the short term forecast was simulated on in YYYY-MM-DD format
|
|
1772
|
-
date_prod:
|
|
1836
|
+
date_prod:
|
|
1773
1837
|
allOf:
|
|
1774
1838
|
- $ref: '#/components/schemas/date'
|
|
1775
1839
|
description: The date of production in YYYY-MM-DD format
|
|
@@ -1789,7 +1853,7 @@ components:
|
|
|
1789
1853
|
allOf:
|
|
1790
1854
|
- $ref: '#/components/schemas/date'
|
|
1791
1855
|
description: The date observed via satellite that the well crew completed fracking in YYYY-MM-DD format
|
|
1792
|
-
date_til:
|
|
1856
|
+
date_til:
|
|
1793
1857
|
allOf:
|
|
1794
1858
|
- $ref: '#/components/schemas/date'
|
|
1795
1859
|
description: Expected TIL date in YYYY-MM-DD format
|
|
@@ -1805,7 +1869,7 @@ components:
|
|
|
1805
1869
|
allOf:
|
|
1806
1870
|
- $ref: '#/components/schemas/date'
|
|
1807
1871
|
description: The date observed via satellite that the well crew completed fracking in YYYY-MM-DD format
|
|
1808
|
-
date_til:
|
|
1872
|
+
date_til:
|
|
1809
1873
|
allOf:
|
|
1810
1874
|
- $ref: '#/components/schemas/date'
|
|
1811
1875
|
description: Expected TIL date in YYYY-MM-DD format
|
|
@@ -1990,15 +2054,15 @@ components:
|
|
|
1990
2054
|
allOf:
|
|
1991
2055
|
- $ref: '#/components/schemas/date'
|
|
1992
2056
|
description: The date observed via satellite that the well crew completed fracking in YYYY-MM-DD format
|
|
1993
|
-
date_first_production:
|
|
2057
|
+
date_first_production:
|
|
1994
2058
|
allOf:
|
|
1995
2059
|
- $ref: '#/components/schemas/date'
|
|
1996
2060
|
description: The date a well first started producing in YYYY-MM-DD format
|
|
1997
|
-
date_permit:
|
|
2061
|
+
date_permit:
|
|
1998
2062
|
allOf:
|
|
1999
2063
|
- $ref: '#/components/schemas/date'
|
|
2000
2064
|
description: The date the well drilling permit was filed in YYYY-MM-DD format
|
|
2001
|
-
date_spud:
|
|
2065
|
+
date_spud:
|
|
2002
2066
|
allOf:
|
|
2003
2067
|
- $ref: '#/components/schemas/date'
|
|
2004
2068
|
description: Spud date from well drilling permit in YYYY-MM-DD format
|
|
@@ -2040,9 +2104,9 @@ components:
|
|
|
2040
2104
|
allOf:
|
|
2041
2105
|
- $ref: '#/components/schemas/date'
|
|
2042
2106
|
description: The date the well crew started fracking in YYYY-MM-DD format
|
|
2043
|
-
date_completion_end:
|
|
2107
|
+
date_completion_end:
|
|
2044
2108
|
allOf:
|
|
2045
|
-
- $ref: '#/components/schemas/date'
|
|
2109
|
+
- $ref: '#/components/schemas/date'
|
|
2046
2110
|
description: The date observed via satellite that the well crew completed fracking in YYYY-MM-DD format
|
|
2047
2111
|
operator: { $ref: '#/components/schemas/operator' }
|
|
2048
2112
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
@@ -88,5 +88,8 @@ For future time periods, forecasted volumes are calculated. Forecasted volumes a
|
|
|
88
88
|
"""Returns the distinct timestamps and the IDs of all previous forecast runs"""
|
|
89
89
|
...
|
|
90
90
|
def beta_query_datalinks(self,query: str,session_id: str = ...) -> Result:
|
|
91
|
+
"""Execute SQL queries against SynMax datalinks"""
|
|
92
|
+
...
|
|
93
|
+
def query_datalinks(self,query: str,session_id: str = ...) -> Result:
|
|
91
94
|
"""Execute SQL queries against SynMax datalinks"""
|
|
92
95
|
...
|
synmax/leviaton/v1/openapi.yaml
CHANGED
|
@@ -1177,7 +1177,71 @@ paths:
|
|
|
1177
1177
|
query:
|
|
1178
1178
|
type: string
|
|
1179
1179
|
description: SQL query to execute. Tables must use {linkid}_{table} format. Use ANSI SQL (LIMIT not TOP).
|
|
1180
|
-
example: "SELECT * FROM
|
|
1180
|
+
example: "SELECT * FROM hdl.pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
|
|
1181
|
+
session_id:
|
|
1182
|
+
type: string
|
|
1183
|
+
description: Optional session ID for logging/tracking. Auto-generated if not provided.
|
|
1184
|
+
example: "my_session_123"
|
|
1185
|
+
responses:
|
|
1186
|
+
'200':
|
|
1187
|
+
description: Query executed successfully. Returns JSON array or NDJSON based on Accept header.
|
|
1188
|
+
content:
|
|
1189
|
+
application/json:
|
|
1190
|
+
schema:
|
|
1191
|
+
type: object
|
|
1192
|
+
description: JSON array of objects, each representing one row from the query result.
|
|
1193
|
+
x-dynamic-response: true
|
|
1194
|
+
application/x-ndjson:
|
|
1195
|
+
schema:
|
|
1196
|
+
type: object
|
|
1197
|
+
description: Each line is a JSON object representing one row from the query result.
|
|
1198
|
+
x-dynamic-response: true
|
|
1199
|
+
'400':
|
|
1200
|
+
description: Invalid query or missing required fields
|
|
1201
|
+
content:
|
|
1202
|
+
application/json:
|
|
1203
|
+
schema:
|
|
1204
|
+
type: object
|
|
1205
|
+
properties:
|
|
1206
|
+
error:
|
|
1207
|
+
type: string
|
|
1208
|
+
'403':
|
|
1209
|
+
description: Permission denied - user lacks access to requested datalink/tables
|
|
1210
|
+
content:
|
|
1211
|
+
application/json:
|
|
1212
|
+
schema:
|
|
1213
|
+
type: object
|
|
1214
|
+
properties:
|
|
1215
|
+
error:
|
|
1216
|
+
type: string
|
|
1217
|
+
'502':
|
|
1218
|
+
description: DLS service unavailable
|
|
1219
|
+
content:
|
|
1220
|
+
application/json:
|
|
1221
|
+
schema:
|
|
1222
|
+
type: object
|
|
1223
|
+
properties:
|
|
1224
|
+
error:
|
|
1225
|
+
type: string
|
|
1226
|
+
/query_datalinks:
|
|
1227
|
+
post:
|
|
1228
|
+
x-method-name: query_datalinks
|
|
1229
|
+
security: [ApiKeyAuth: [hyperion]]
|
|
1230
|
+
summary: Execute SQL queries against SynMax datalinks
|
|
1231
|
+
description: Execute T-SQL queries directly against SynMax's 5 datalinks (19 tables). Returns query results as structured data.
|
|
1232
|
+
requestBody:
|
|
1233
|
+
required: true
|
|
1234
|
+
content:
|
|
1235
|
+
application/json:
|
|
1236
|
+
schema:
|
|
1237
|
+
type: object
|
|
1238
|
+
required: [query]
|
|
1239
|
+
additionalProperties: false
|
|
1240
|
+
properties:
|
|
1241
|
+
query:
|
|
1242
|
+
type: string
|
|
1243
|
+
description: SQL query to execute. Tables must use {linkid}_{table} format. Use ANSI SQL (LIMIT not TOP).
|
|
1244
|
+
example: "SELECT * FROM hdl.pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
|
|
1181
1245
|
session_id:
|
|
1182
1246
|
type: string
|
|
1183
1247
|
description: Optional session ID for logging/tracking. Auto-generated if not provided.
|
synmax/openapi/client.py
CHANGED
|
@@ -10,7 +10,7 @@ import importlib
|
|
|
10
10
|
from itertools import islice
|
|
11
11
|
import pandas as pd
|
|
12
12
|
|
|
13
|
-
from synmax.openapi.utils import change_signature, get_annotation, get_body_model, get_param_model
|
|
13
|
+
from synmax.openapi.utils import change_signature, get_annotation, get_body_model, get_param_model, PARAM_MODEL_SUFFIX, BODY_MODEL_SUFFIX
|
|
14
14
|
|
|
15
15
|
class OpenAPIClient:
|
|
16
16
|
def __init__(self,
|
|
@@ -100,16 +100,15 @@ class OpenAPIClient:
|
|
|
100
100
|
|
|
101
101
|
def _create_request_function(self, method: str, full_url: str, param_model: Optional[Type[BaseModel]], body_model: Optional[Type[BaseModel]]):
|
|
102
102
|
def request_func(self, **kwargs) -> Result:
|
|
103
|
+
param_dict = None
|
|
104
|
+
if param_model:
|
|
105
|
+
data = param_model(**kwargs).model_dump(mode='json')
|
|
106
|
+
param_dict = {k: v for k, v in data.dict().items() if v is not None}
|
|
107
|
+
body_dict = None
|
|
108
|
+
if body_model:
|
|
109
|
+
data = body_model(**kwargs).model_dump(mode='json')
|
|
110
|
+
body_dict = {k: v for k, v in data.items() if v is not None}
|
|
103
111
|
def generator() -> Iterator[Dict[str, Any]]:
|
|
104
|
-
param_dict = None
|
|
105
|
-
if param_model:
|
|
106
|
-
data = param_model(**kwargs).model_dump(mode='json')
|
|
107
|
-
param_dict = {k: v for k, v in data.dict().items() if v is not None}
|
|
108
|
-
body_dict = None
|
|
109
|
-
if body_model:
|
|
110
|
-
data = body_model(**kwargs).model_dump(mode='json')
|
|
111
|
-
|
|
112
|
-
body_dict = {k: v for k, v in data.items() if v is not None}
|
|
113
112
|
self._logger.info(f"Making request to {full_url}")
|
|
114
113
|
retry_count = 0
|
|
115
114
|
can_retry = True
|