/
corporations.py
101 lines (72 loc) · 5.69 KB
/
corporations.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
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fcorporations.ipynb)
"""
from typing import Any, Dict, List, Union
from vortexasdk.api import ID
from vortexasdk.endpoints.corporations_result import CorporationsResult
from vortexasdk.endpoints.endpoints import CORPORATIONS_REFERENCE
from vortexasdk.operations import Reference, Search
from vortexasdk.utils import convert_values_to_list
class Corporations(Reference, Search):
"""Corporations Endpoint."""
def __init__(self):
Reference.__init__(self, CORPORATIONS_REFERENCE)
Search.__init__(self, CORPORATIONS_REFERENCE)
def load_all(self) -> CorporationsResult:
"""Load all corporations."""
return self.search()
def search(
self,
term: Union[str, List[str]] = None,
exact_term_match: bool = False,
) -> CorporationsResult:
"""
Find all Corporations matching given search terms.
# Arguments
term: The corporation name(s) we're filtering on
exact_term_match: Search on only exact term matches, or allow similar matches.
e.g. When searching for "COS" with `exact_term_match=False`, then the SDK will yield corporations named
['COSCO', 'COSMO OIL'] etc. When `exact_term_match=True`,
the SDK won't yield any results, because no corporations have the exact name "COS".
# Returns
List of corporation matching `term`
# Examples
Let's load all corporations
```python
>>> from vortexasdk import Corporations
>>> df = Corporations().search().to_df()
```
returns
| | id | name | corporate_entity_type |
|---:|:-----------------------------------------------------------------|:-----------|:------------------------|
| 0 | 04f418ee78c1e17744ad653e7815e8e28891ed9ba25a8427030e4478e5c00974 | 3J | ['effective_controller'] |
| 1 | b6384cf17f1639a64bbff04cfd32257bf732a3a13e4b0532802a9ae84a36be34 | 5XJAPANESE | ['effective_controller'] |
Let's find all corporations with 'do' in the name.
```python
>>> [x.name for x in Corporations().search(term="do").to_list()]
[...]
```
# Further Documentation
[VortexaAPI Corporation Reference](https://docs.vortexa.com/reference/POST/reference/charterers)
"""
api_params: Dict[str, Any] = convert_values_to_list({"term": term})
response = super().search_with_client(
exact_term_match=exact_term_match, **api_params
)
return CorporationsResult(
records=response["data"], reference=response["reference"]
)
def reference(self, id: ID) -> Dict:
"""
Perform a corporation lookup.
# Arguments
id: Corporation ID to lookup
# Returns
Corporation record matching the ID
# Further Documentation:
[VortexaAPI Corporation Reference](https://docs.vortexa.com/reference/GET/reference/charterers/%7Bid%7D)
# Examples
>>> Corporations().reference(id='12345abcdef') # doctest: +SKIP
"""
return super().reference(id)