-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathharvests_api.py
More file actions
3441 lines (3013 loc) · 167 KB
/
harvests_api.py
File metadata and controls
3441 lines (3013 loc) · 167 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# coding: utf-8
"""
T3 API
## WHAT IS THIS? This API is part of the [Track & Trace Tools](https://trackandtrace.tools) platform. The API allows you to programmatically access all your Metrc data that is available on metrc.com It is not related to the Metrc 3rd party API, does not use Metrc API keys, and is not affiliated with Metrc. If you're looking for where to get started, check out the [T3 Wiki API Getting Started guide](https://github.com/classvsoftware/t3-wiki/wiki/T3-API-:-Getting-Started). The T3 API is subject to the [Track & Trace Tools Terms of Use](https://www.trackandtrace.tools/terms-of-use). ## FREE API ACCESS (LIMITED) The T3 API features a limited number of free endpoints available to anyone with a Metrc login. These can be found in the [Free](#/Free) section. ## FULL API ACCESS There are two ways to get premium access to the T3 API: - **Subscribe to [T3+](https://trackandtrace.tools/plus)** *OR* - **Use a provided T3 API key (consulting clients only. [Reach out](mailto:[email protected]) for more information.)** ## AUTHENTICATION The T3 API uses JSON Web Tokens (JWT) for request authentication. To obtain a JWT, use one of the following: - **metrc.com login credentials:** - **hostname**: (The website you use to login to metrc: `ca.metrc.com`, `or.metrc.com`, etc.) - **username**: Your Metrc username - **password**: Your Metrc password - **otp**: A one-time password used for 2-factor authentication (Only applies to Michigan users) *OR* - **T3 API key** Refer to the **Authentication** endpoints below for more information. ## SECRET KEYS Some endpoints support the use of secret key authentication. This allows you to use simple URLs to access your Metrc data. ### Usage Pass the `secretKey` returned from the request in the query string: `?secretKey=<yourSecretKeyGoesHere>` ### Generating Secret Keys Refer to the [/v2/auth/secretkey](#/Authentication/post_v2_auth_secretkey) endpoint for information on generating secret keys. [Secret Key Generation Tool](/v2/pages/secret-key) [Sync Link Creation Tool](/v2/pages/sync-link) ## SECURITY The T3 API interacts with Metrc in a similar manner to the [Track & Trace Tools](https://chromewebstore.google.com/detail/track-trace-tools/dfljickgkbfaoiifheibjpejloipegcb) Chrome extension. The API login process is designed with a strong emphasis on security. Your Metrc login details are never stored, and the API backend employs robust encryption methods to protect your temporary Metrc session. ### Key Security Measures: - **Single-Use Login Credentials:** - The T3 API uses your login credentials only once to authenticate with Metrc. - After the Metrc login process is complete, your login credentials are immediately deleted from the system. - You are required to enter your login credentials each time you access the T3 API, ensuring that your credentials are never stored. - **Secure Temporary Session Storage:** - The T3 API securely encrypts your logged-in Metrc session data. This data is only used when you make requests through the T3 API. - The encrypted session data is automatically deleted after 24 hours, ensuring that your session information is not retained longer than necessary. For any questions or concerns, please contact [[email protected]](mailto:[email protected]). ## PRIVACY The T3 API privacy model follows the same principles as the [Track & Trace Tools](https://chromewebstore.google.com/detail/track-trace-tools/dfljickgkbfaoiifheibjpejloipegcb) Chrome extension. The T3 API functions solely as a connector between you and Metrc, ensuring your privacy is protected. - **No Data Collection:** - The T3 API does not record, save, harvest, inspect, or analyze any of your data. - All data interactions are ephemeral and occur in real-time, without permanent storage. - **Secure and Private Access:** - Your data is never shared with third parties. Unauthorized access to your login information or data is strictly prohibited. - T3 employs industry-standard encryption protocols to safeguard all communications between the T3 API and Metrc. - **User-Controlled Sessions:** - Your Metrc login credentials and session are used exclusively by you. The T3 API will never initiate Metrc traffic without your explicit authorization. - **Compliance and Best Practices:** - T3's privacy practices are aligned with applicable data protection regulations, including GDPR and CCPA, ensuring that your data rights are respected. The T3 API is subject to the [Track & Trace Tools Privacy Policy](https://trackandtrace.tools/privacy-policy). For any privacy-related inquiries, please contact [[email protected]](mailto:[email protected]). ## PERMISSIONS Each Metrc account has different permissions based on several factors: - Permissions granted by your Metrc admin - Class of license (manufacturing, cultivation, etc) - US state the license operates in Use the Permissions endpoints to determine which actions are available to you. ## LICENSES View a list of all licenses available to the current user: `GET https://api.trackandtrace.tools/v2/licenses` Only one license can be queried per request. Specify the target license with the required `licenseNumber` query parameter: `GET https://api.trackandtrace.tools/v2/items?licenseNumber=LIC-00001` ## RATE LIMITING The API has a global default request rate limit of 600 requests/minute/user. Some routes have lower rate limits. ## COLLECTIONS All data is queried as collections. There are no individual object endpoints. For example, you cannot find an individual object using an endpoint like `/plants/{plantId}`, individual objects must be queried by filtering the collection endpoint `/plants` for the exact `plantId`. Collections are paginated, and can be filtered and sorted by individual object fields. The JSON response object includes the following properties: - `data`: An array of objects, or any empty array - `page`: The requested page index - `pageSize`: The requested page size - `total`: The total number of items in this collection. Use this to determine how many pages are required to return the entire collection. ### COLLECTION PAGINATION Metrc data collections are queried as pages. Use the `page` and `pageSize` query parameters to indicate which page should be returned. By default, `page=1` and `pageSize=100`. Example: Return page 3 with a page size of 500: `GET https://api.trackandtrace.tools/v2/items?licenseNumber=LIC-00001&page=3&pageSize=500` ### COLLECTION SORTING Metrc data collections can be sorted. Use the `sort` query parameter to indicate how the collection should be sorted. Example: Sort items by `name` descending: `GET https://api.trackandtrace.tools/v2/items?licenseNumber=LIC-00001&sort=name:desc` ### COLLECTION FILTERING Metrc data collections can be filtered. Use one or more `filter` query parameters to indicate how filters should be applied. Example: Filter items that contain \"flower\" in the `name` field: `GET https://api.trackandtrace.tools/v2/items?licenseNumber=LIC-00001&filter:name__contains=flower` Multiple filters can be applied, and you can specify the logical operator (defaulting to \"and\"): Example: Filter items that contain \"flower\" in the `name` field OR \"kush\" in the `name` field: `GET https://api.trackandtrace.tools/v2/items?licenseNumber=LIC-00001&filter=name__contains:flower&filter=name__contains:kush&filterLogic=or` #### FILTERING STRINGS String fields support the following filter operators: - `contains` - `doesnotcontain` - `eq` - `neq` - `startswith` - `endswith` Example `?filter=name__contains:flower` **Note: all string filters are case-insensitive** #### FILTERING DATETIMES Datetime fields support the following filter operators: - `lt` - `lte` - `eq` - `neq` - `gt` - `gte` Example: `?filter=harvestedDate__gte:2024-07-17T20:26:07.117Z` **Note: all datetime filters use ISO8601 datetimes** #### FILTERING BOOLEANS Boolean fields support the following filter operators: - `eq` Example: `?filter=finished__eq:true` ### LOADING FULL COLLECTIONS `pageSize` is limited to 500 in most cases, so you may need to load multiple pages if a license has a large number of packages. Refer to [this example](https://github.com/classvsoftware/t3-api/blob/master/load_all_active_packages.py) for how to load a full collection in a python script. ## USING THE API The API can be used in any way you like, but writing simple scripts to accomplish common tasks is an excellent way to take advantage of it. The full OpenAPI spec, which can be imported into Postman, can be found here: [/v2/spec/openapi.json](/v2/spec/openapi.json) [**Lots** of example scripts that show how the use the T3 API can be found here](https://github.com/classvsoftware/t3-api) ## CONTACT - **Responsible Organization:** Class V LLC - **Responsible Developer:** Matt Frisbie - **Email:** [[email protected]](mailto:[email protected]) - **URL:** [https://trackandtrace.tools](https://trackandtrace.tools) - **Terms of Use:** [https://www.trackandtrace.tools/terms-of-use](https://www.trackandtrace.tools/terms-of-use)
The version of the OpenAPI document: v2
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
from typing import List, Optional, Union
from typing_extensions import Annotated
from t3api.models.v2_harvests_active_get200_response import V2HarvestsActiveGet200Response
from t3api.models.v2_harvests_active_report_get200_response import V2HarvestsActiveReportGet200Response
from t3api.models.v2_harvests_plants_get200_response import V2HarvestsPlantsGet200Response
from t3api.models.v2_items_history_get200_response import V2ItemsHistoryGet200Response
from t3api.models.v2_packages_source_harvests_get200_response import V2PackagesSourceHarvestsGet200Response
from t3api.api_client import ApiClient, RequestSerialized
from t3api.api_response import ApiResponse
from t3api.rest import RESTResponseType
class HarvestsApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def v2_harvests_active_get(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> V2HarvestsActiveGet200Response:
"""List of active harvests
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param page: The index of the page to be returned.
:type page: int
:param page_size: The number of objects per page to be returned.
:type page_size: int
:param strict_pagination: Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.
:type strict_pagination: bool
:param sort: Defines the collection sort order.
:type sort: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param filter: One or more collection filters.
:type filter: List[str]
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_get_serialize(
license_number=license_number,
page=page,
page_size=page_size,
strict_pagination=strict_pagination,
sort=sort,
filter_logic=filter_logic,
filter=filter,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def v2_harvests_active_get_with_http_info(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[V2HarvestsActiveGet200Response]:
"""List of active harvests
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param page: The index of the page to be returned.
:type page: int
:param page_size: The number of objects per page to be returned.
:type page_size: int
:param strict_pagination: Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.
:type strict_pagination: bool
:param sort: Defines the collection sort order.
:type sort: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param filter: One or more collection filters.
:type filter: List[str]
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_get_serialize(
license_number=license_number,
page=page,
page_size=page_size,
strict_pagination=strict_pagination,
sort=sort,
filter_logic=filter_logic,
filter=filter,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def v2_harvests_active_get_without_preload_content(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""List of active harvests
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param page: The index of the page to be returned.
:type page: int
:param page_size: The number of objects per page to be returned.
:type page_size: int
:param strict_pagination: Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.
:type strict_pagination: bool
:param sort: Defines the collection sort order.
:type sort: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param filter: One or more collection filters.
:type filter: List[str]
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_get_serialize(
license_number=license_number,
page=page,
page_size=page_size,
strict_pagination=strict_pagination,
sort=sort,
filter_logic=filter_logic,
filter=filter,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _v2_harvests_active_get_serialize(
self,
license_number,
page,
page_size,
strict_pagination,
sort,
filter_logic,
filter,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
'filter': 'multi',
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if license_number is not None:
_query_params.append(('licenseNumber', license_number))
if page is not None:
_query_params.append(('page', page))
if page_size is not None:
_query_params.append(('pageSize', page_size))
if strict_pagination is not None:
_query_params.append(('strictPagination', strict_pagination))
if sort is not None:
_query_params.append(('sort', sort))
if filter_logic is not None:
_query_params.append(('filterLogic', filter_logic))
if filter is not None:
_query_params.append(('filter', filter))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'BearerAuth'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/v2/harvests/active',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def v2_harvests_active_report_get(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
secret_key: Annotated[Optional[StrictStr], Field(description="Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key). ")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
content_type: Annotated[Optional[StrictStr], Field(description="Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header* ")] = None,
prepend_csv_metadata: Annotated[Optional[StrictStr], Field(description="Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned. ")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
fieldnames: Annotated[Optional[StrictStr], Field(description="Defines which plant fields should appear in the report data.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> V2HarvestsActiveReportGet200Response:
"""Generate a report of all active harvests
**Note: this endpoint supports secret key authentication.**
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param secret_key: Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).
:type secret_key: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param content_type: Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*
:type content_type: str
:param prepend_csv_metadata: Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.
:type prepend_csv_metadata: str
:param sort: Defines the collection sort order.
:type sort: str
:param filter: One or more collection filters.
:type filter: List[str]
:param fieldnames: Defines which plant fields should appear in the report data.
:type fieldnames: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_report_get_serialize(
license_number=license_number,
secret_key=secret_key,
filter_logic=filter_logic,
content_type=content_type,
prepend_csv_metadata=prepend_csv_metadata,
sort=sort,
filter=filter,
fieldnames=fieldnames,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveReportGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def v2_harvests_active_report_get_with_http_info(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
secret_key: Annotated[Optional[StrictStr], Field(description="Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key). ")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
content_type: Annotated[Optional[StrictStr], Field(description="Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header* ")] = None,
prepend_csv_metadata: Annotated[Optional[StrictStr], Field(description="Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned. ")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
fieldnames: Annotated[Optional[StrictStr], Field(description="Defines which plant fields should appear in the report data.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[V2HarvestsActiveReportGet200Response]:
"""Generate a report of all active harvests
**Note: this endpoint supports secret key authentication.**
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param secret_key: Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).
:type secret_key: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param content_type: Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*
:type content_type: str
:param prepend_csv_metadata: Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.
:type prepend_csv_metadata: str
:param sort: Defines the collection sort order.
:type sort: str
:param filter: One or more collection filters.
:type filter: List[str]
:param fieldnames: Defines which plant fields should appear in the report data.
:type fieldnames: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_report_get_serialize(
license_number=license_number,
secret_key=secret_key,
filter_logic=filter_logic,
content_type=content_type,
prepend_csv_metadata=prepend_csv_metadata,
sort=sort,
filter=filter,
fieldnames=fieldnames,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveReportGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def v2_harvests_active_report_get_without_preload_content(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
secret_key: Annotated[Optional[StrictStr], Field(description="Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key). ")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
content_type: Annotated[Optional[StrictStr], Field(description="Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header* ")] = None,
prepend_csv_metadata: Annotated[Optional[StrictStr], Field(description="Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned. ")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
fieldnames: Annotated[Optional[StrictStr], Field(description="Defines which plant fields should appear in the report data.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Generate a report of all active harvests
**Note: this endpoint supports secret key authentication.**
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param secret_key: Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).
:type secret_key: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param content_type: Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*
:type content_type: str
:param prepend_csv_metadata: Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.
:type prepend_csv_metadata: str
:param sort: Defines the collection sort order.
:type sort: str
:param filter: One or more collection filters.
:type filter: List[str]
:param fieldnames: Defines which plant fields should appear in the report data.
:type fieldnames: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_active_report_get_serialize(
license_number=license_number,
secret_key=secret_key,
filter_logic=filter_logic,
content_type=content_type,
prepend_csv_metadata=prepend_csv_metadata,
sort=sort,
filter=filter,
fieldnames=fieldnames,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2HarvestsActiveReportGet200Response",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _v2_harvests_active_report_get_serialize(
self,
license_number,
secret_key,
filter_logic,
content_type,
prepend_csv_metadata,
sort,
filter,
fieldnames,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
'filter': 'multi',
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if license_number is not None:
_query_params.append(('licenseNumber', license_number))
if secret_key is not None:
_query_params.append(('secretKey', secret_key))
if filter_logic is not None:
_query_params.append(('filterLogic', filter_logic))
if content_type is not None:
_query_params.append(('contentType', content_type))
if prepend_csv_metadata is not None:
_query_params.append(('prependCsvMetadata', prepend_csv_metadata))
if sort is not None:
_query_params.append(('sort', sort))
if filter is not None:
_query_params.append(('filter', filter))
if fieldnames is not None:
_query_params.append(('fieldnames', fieldnames))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json',
'text/csv'
]
)
# authentication setting
_auth_settings: List[str] = [
'BearerAuth'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/v2/harvests/active/report',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def v2_harvests_history_get(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
plant_id: Annotated[Union[StrictFloat, StrictInt], Field(description="ID of the target harvest")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> V2ItemsHistoryGet200Response:
"""List of history objects for a single harvest.
NOTE: only supports INACTIVE harvests
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param plant_id: ID of the target harvest (required)
:type plant_id: float
:param page: The index of the page to be returned.
:type page: int
:param page_size: The number of objects per page to be returned.
:type page_size: int
:param strict_pagination: Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.
:type strict_pagination: bool
:param sort: Defines the collection sort order.
:type sort: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param filter: One or more collection filters.
:type filter: List[str]
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_history_get_serialize(
license_number=license_number,
plant_id=plant_id,
page=page,
page_size=page_size,
strict_pagination=strict_pagination,
sort=sort,
filter_logic=filter_logic,
filter=filter,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2ItemsHistoryGet200Response",
'401': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def v2_harvests_history_get_with_http_info(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
plant_id: Annotated[Union[StrictFloat, StrictInt], Field(description="ID of the target harvest")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[V2ItemsHistoryGet200Response]:
"""List of history objects for a single harvest.
NOTE: only supports INACTIVE harvests
:param license_number: The unique identifier for the license associated with this request. (required)
:type license_number: str
:param plant_id: ID of the target harvest (required)
:type plant_id: float
:param page: The index of the page to be returned.
:type page: int
:param page_size: The number of objects per page to be returned.
:type page_size: int
:param strict_pagination: Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.
:type strict_pagination: bool
:param sort: Defines the collection sort order.
:type sort: str
:param filter_logic: Describes how the filters, if any, should be applied
:type filter_logic: str
:param filter: One or more collection filters.
:type filter: List[str]
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._v2_harvests_history_get_serialize(
license_number=license_number,
plant_id=plant_id,
page=page,
page_size=page_size,
strict_pagination=strict_pagination,
sort=sort,
filter_logic=filter_logic,
filter=filter,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "V2ItemsHistoryGet200Response",
'401': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def v2_harvests_history_get_without_preload_content(
self,
license_number: Annotated[StrictStr, Field(description="The unique identifier for the license associated with this request.")],
plant_id: Annotated[Union[StrictFloat, StrictInt], Field(description="ID of the target harvest")],
page: Annotated[Optional[StrictInt], Field(description="The index of the page to be returned.")] = None,
page_size: Annotated[Optional[StrictInt], Field(description="The number of objects per page to be returned.")] = None,
strict_pagination: Annotated[Optional[StrictBool], Field(description="Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page.")] = None,
sort: Annotated[Optional[StrictStr], Field(description="Defines the collection sort order.")] = None,
filter_logic: Annotated[Optional[StrictStr], Field(description="Describes how the filters, if any, should be applied")] = None,
filter: Annotated[Optional[List[StrictStr]], Field(description="One or more collection filters.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],