-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_packages_api.py
More file actions
220 lines (153 loc) · 14.8 KB
/
test_packages_api.py
File metadata and controls
220 lines (153 loc) · 14.8 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
# 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 unittest
from t3api.api.packages_api import PackagesApi
class TestPackagesApi(unittest.TestCase):
"""PackagesApi unit test stubs"""
def setUp(self) -> None:
self.api = PackagesApi()
def tearDown(self) -> None:
pass
def test_v2_files_labels_content_data_packages_active_post(self) -> None:
"""Test case for v2_files_labels_content_data_packages_active_post
For a given list of active packages, returns the needed ContentDataList to render the labels.
"""
pass
def test_v2_files_labels_content_data_packages_intransit_post(self) -> None:
"""Test case for v2_files_labels_content_data_packages_intransit_post
For a given list of in transit packages, returns the needed ContentDataList to render the labels.
"""
pass
def test_v2_harvests_packages_get(self) -> None:
"""Test case for v2_harvests_packages_get
List of harvest package objects for a single harvest.
"""
pass
def test_v2_packages_active_get(self) -> None:
"""Test case for v2_packages_active_get
List of active packages
"""
pass
def test_v2_packages_active_report_get(self) -> None:
"""Test case for v2_packages_active_report_get
Generate a report of all active packages
"""
pass
def test_v2_packages_active_super_get(self) -> None:
"""Test case for v2_packages_active_super_get
List of active superpackages. Additional metadata can be added using the `include` param.
"""
pass
def test_v2_packages_create_inputs_get(self) -> None:
"""Test case for v2_packages_create_inputs_get
Input data used for creating new packages
"""
pass
def test_v2_packages_create_post(self) -> None:
"""Test case for v2_packages_create_post
Create one or more packages from existing active packages
"""
pass
def test_v2_packages_create_source_items_get(self) -> None:
"""Test case for v2_packages_create_source_items_get
List of items eligible to be used in creating new packages
"""
pass
def test_v2_packages_create_source_packages_get(self) -> None:
"""Test case for v2_packages_create_source_packages_get
List of packages eligible to be used in creating new packages
"""
pass
def test_v2_packages_history_get(self) -> None:
"""Test case for v2_packages_history_get
List of package history objects for a single package
"""
pass
def test_v2_packages_inactive_get(self) -> None:
"""Test case for v2_packages_inactive_get
List of inactive packages
"""
pass
def test_v2_packages_intransit_get(self) -> None:
"""Test case for v2_packages_intransit_get
List of in transit packages
"""
pass
def test_v2_packages_intransit_report_get(self) -> None:
"""Test case for v2_packages_intransit_report_get
Generate a report of all in-transit packages
"""
pass
def test_v2_packages_intransit_super_get(self) -> None:
"""Test case for v2_packages_intransit_super_get
List of intransit superpackages. Additional metadata can be added using the `include` param.
"""
pass
def test_v2_packages_labresult_batches_get(self) -> None:
"""Test case for v2_packages_labresult_batches_get
List of package lab result batch objects for a single package
"""
pass
def test_v2_packages_labresults_document_get(self) -> None:
"""Test case for v2_packages_labresults_document_get
Get the COA PDF for a lab result.
"""
pass
def test_v2_packages_labresults_get(self) -> None:
"""Test case for v2_packages_labresults_get
List of package lab result objects for a single package
"""
pass
def test_v2_packages_notes_post(self) -> None:
"""Test case for v2_packages_notes_post
Add notes to packages
"""
pass
def test_v2_packages_onhold_get(self) -> None:
"""Test case for v2_packages_onhold_get
List of on hold packages
"""
pass
def test_v2_packages_source_harvests_get(self) -> None:
"""Test case for v2_packages_source_harvests_get
List of package source harvest objects for a single package
"""
pass
def test_v2_packages_transferred_get(self) -> None:
"""Test case for v2_packages_transferred_get
List of transferred packages
"""
pass
def test_v2_packages_transferred_report_get(self) -> None:
"""Test case for v2_packages_transferred_report_get
Generate a report of all transferred packages
"""
pass
def test_v2_packages_unfinish_post(self) -> None:
"""Test case for v2_packages_unfinish_post
Unfinish packages
"""
pass
def test_v2_transfers_create_destinations_get(self) -> None:
"""Test case for v2_transfers_create_destinations_get
List of destination facilities eligible to be used in creating new transfers
"""
pass
def test_v2_transfers_create_packages_get(self) -> None:
"""Test case for v2_transfers_create_packages_get
List of packages eligible to be used in creating new transfers
"""
pass
def test_v2_transfers_create_transporters_get(self) -> None:
"""Test case for v2_transfers_create_transporters_get
List of transporter facilities eligible to be used in creating new transfers
"""
pass
if __name__ == '__main__':
unittest.main()