/
products.py
108 lines (78 loc) · 6.8 KB
/
products.py
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
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fproducts.ipynb)
"""
from typing import Any, Dict, List, Union
from vortexasdk.api.shared_types import ID
from vortexasdk.endpoints.endpoints import PRODUCTS_REFERENCE
from vortexasdk.endpoints.products_result import ProductResult
from vortexasdk.operations import Reference, Search
from vortexasdk.utils import convert_to_list
class Products(Reference, Search):
"""Products endpoint."""
def __init__(self):
"""Instantiate endpoint using reference endpoint."""
Reference.__init__(self, PRODUCTS_REFERENCE)
Search.__init__(self, PRODUCTS_REFERENCE)
def load_all(self) -> ProductResult:
"""Load all products."""
return self.search()
def search(
self,
term: Union[str, List[str]] = None,
ids: Union[str, List[str]] = None,
product_parent: Union[str, List[str]] = None,
exact_term_match: bool = False,
filter_layer: str = None,
) -> ProductResult:
"""
Find all products matching given search terms.
# Arguments
term: The name(s) (or partial name(s)) of a product we'd like to search
ids: ID or IDs of products we'd like to search
product_parent: ID, or list of IDs of the immediate product parent. E.g. `product_parent ='12345'` will return all children of product `12345`.
exact_term_match: By default, the SDK returns all products which name _includes_ the search term. For example, searching for "Gasoil" will return
results including "Gasoil", "Gasoil 0.4pc", "Gasoil 500ppm" etc. Setting `exact_search_match` to true ensure that only exact term matches are
returned, ie just "Gasoil" in this case.
filter_layer: Must be one of product types ['group', 'group_product', 'category', 'grade'].
# Returns
List of products matching the search arguments.
# Examples
Let's look for products with in one of `['diesel', 'fuel oil', 'grane']` their name, or related names.
```python
>>> from vortexasdk import Products
>>> df = Products().search(term=['diesel', 'fuel oil', 'grane']).to_df('all')
```
Returns
| | id | name | layer.0 | leaf | parent.0.name | parent.0.layer.0 | parent.0.id | meta.api_min | meta.api_max | ref_type | meta.sulphur_min | meta.sulphur_max |
|---:|:-------------------|:--------------|:----------|:-------|:----------------|:-------------------|:------------------|---------------:|---------------:|:-----------|-------------------:|-------------------:|
| 0 | 1c107b4317bc2c8... | Fuel Oil | category | False | Dirty products | product | 5de0b00094e0fd... | 12.8878 | 12.8878 | product | nan | nan |
| 1 | fddedd17e02507f... | Grane | grade | True | Medium-Sour | subproduct_group | a7e26956fbb917... | 29.2955 | 29.2955 | product | 0.62 | 0.62 |
| 2 | deda35eb9ca56b5... | Diesel/Gasoil | category | False | Clean products | product | b68cbb7746f8b9... | 35.9556 | 35.9556 | product | nan | nan |
# Further Documentation
[VortexaAPI Product Reference](https://docs.vortexa.com/reference/POST/reference/products)
"""
api_params: Dict[str, Any] = {
"term": convert_to_list(term),
"ids": convert_to_list(ids),
"product_parent": convert_to_list(product_parent),
"allowTopLevelProducts": True,
"filter_layer": convert_to_list(filter_layer),
}
response = super().search_with_client(
exact_term_match=exact_term_match, **api_params
)
return ProductResult(
records=response["data"], reference=response["reference"]
)
def reference(self, id: ID) -> Dict:
"""
Perform a product lookup.
# Arguments
id: Product ID to lookup
# Returns
Product record matching the ID
# Further Documentation:
[VortexaAPI Product Reference](https://docs.vortexa.com/reference/POST/reference/products)
"""
return super().reference(id)