Merge pull request #515 from VorTECHsa/rnd-10703

docs: update some docs for new shipping regions

vortexasdk/endpoints/cargo_timeseries.py

@@ -82,9 +82,10 @@ def search(
 
         # Arguments
             filter_activity: Cargo movement activity on which to base the time filter. The endpoint only includes cargo
-            movements matching that match this filter in the aggregations. Must be one of ['loading_state',
-             'loading_start', 'loading_end', 'identified_for_loading_state', 'unloading_state', 'unloading_start',
-              'unloading_end', 'storing_state', 'storing_start', 'storing_end', 'transiting_state', 'oil_on_water_state', 'waypoint_start`, `waypoint_end`].
+            movements matching that match this filter in the aggregations. Must be one of: `loading_state`,
+             `loading_start`, `loading_end`, `identified_for_loading_state`, `unloading_state`, `unloading_start`,
+             `unloading_end`, `storing_state`, `storing_start`, `storing_end`, `transiting_state`,
+             `oil_on_water_state`, `waypoint_start`, `waypoint_end`.
 
             filter_time_min: The UTC start date of the time filter.
 
@@ -168,10 +169,18 @@ def search(
             timeseries_frequency: Frequency denoting the granularity of the time series. Must be one of ['day', 'week',
              'doe_week', 'month', 'quarter', 'year']
 
-            timeseries_property: Property to split results by. Can be one of: `quantity`, `'vessel_class_group'`, `'vessel_class_coarse'`, `'vessel_class_granular'`, `vessel_flag`,
-             `origin_region`, `origin_shipping_region`, `origin_trading_region`, `origin_trading_sub_region`, `origin_country`, `origin_port`, `origin_terminal`,
-             `destination_region`, `destination_shipping_region`, `destination_trading_region`, `destination_trading_sub_region`, `destination_country`, `destination_port`, `destination_terminal`,
-             `product_group`, `product_group_product`, `product_category`, `product_grade`, `waypoint_selected`, `none` or not provided.
+            timeseries_property: Property to split results by. Can be one of: `quantity`, `waypoint_selected`,
+            `origin_country`, `origin_port`, `origin_region`, `origin_trading_region`, `origin_shipping_region`,
+            `origin_terminal`, `origin_trading_sub_region`, `origin_shipping_region_v2`, `origin_basin`,
+            `origin_wider_shipping_region`, `origin_country_zone`, `origin_alternative_region`,
+            `origin_state_or_province`, `destination_country`, `destination_port`, `destination_region`,
+            `destination_shipping_region`, `destination_terminal`, `destination_trading_region`,
+            `destination_trading_sub_region`, `destination_basin`, `destination_shipping_region_v2`,
+            `destination_wider_shipping_region`, `destination_country_zone`, `destination_alternative_region`,
+            `destination_state_or_province`, `product_category`, `product_grade`, `product_group`,
+            `product_group_product`, `vessel_class_group`, `vessel_class_coarse`, `vessel_class_granular`,
+            `vessel_flag`, `storage_location_country`, `storage_location_region`, `storage_location_shipping_region_v2`,
+            `storage_location_trading_sub_region`, or not provided.
 
             timeseries_unit: A numeric metric to be calculated for each time bucket. Must be one of ['b', 'bpd', 't',
              'tpd', 'c', 'cpd'], corresponding to barrels, barrels per day, metric tonnes, metric tonnes per day,

vortexasdk/endpoints/destination_breakdown.py

@@ -79,8 +79,11 @@ def search(
 
              breakdown_unit: Units to aggregate upon. Must be one of the following: `'b'`, `'t'`, `'cbm'`, `'bpd'`, `'tpd'`, `'mpd'`.
 
-             breakdown_geography: Geography hierarchy of the origin to aggregate upon. Must be one of the following: `'terminal'`, `'port'`,`'country'`, `'shipping_region'`,
-             `'region'`,`'trading_block'`,`'trading_region'`,`'trading_subregion'`,`'sts_zone'`,`'waypoint'`.
+             breakdown_geography: Geography layer of the origin to aggregate upon. Must be one of the following:
+             `berth`, `terminal`, `port`, `country`, `country_zone`, `shipping_region`, `shipping_region_v2`,
+             `wider_shipping_region`, `region`, `alternative_region`, `trading_block`, `trading_region`,
+             `trading_subregion`, `state_or_province`, `sts_zone`, `waypoint`, `storage`, `storage_terminal`, `basin`,
+             `root`, or not provided. Default is `berth`.
 
              breakdown_size: Number of top geographies to return. Default is 5.
 

vortexasdk/endpoints/geographies.py

@@ -40,7 +40,10 @@ def search(
                 ['China', 'South China', 'China Energy Services Ningbo'...] etc. When `exact_term_match=True`,
                 the SDK will only yield the geography named `China`.
 
-            filter_layer: Must be one of geographical type ['terminal', 'port', 'country', 'shipping_region', 'region', 'trading_block', 'trading_region', 'trading_subregion', 'sts_zone', 'waypoint', 'storage', 'root'].
+            filter_layer: Must be one of: `terminal`, `port`, `country`, `country_zone`, `shipping_region`,
+            `shipping_region_v2`, `wider_shipping_region`, `region`, `alternative_region`, `trading_block`,
+            `trading_region`, `trading_subregion`, `state_or_province`, `sts_zone`, `waypoint`, `storage`,
+            `storage_terminal`, `basin`, `root`, or not provided.
 
 
         # Returns

vortexasdk/endpoints/origin_breakdown.py

@@ -79,8 +79,11 @@ def search(
 
              breakdown_unit: Units to aggregate upon. Must be one of the following: `'b'`, `'t'`, `'cbm'`, `'bpd'`, `'tpd'`, `'mpd'`.
 
-             breakdown_geography: Geography hierarchy of the origin to aggregate upon. Must be one of the following: `'terminal'`, `'port'`,`'country'`, `'shipping_region'`,
-             `'region'`,`'trading_block'`,`'trading_region'`,`'trading_subregion'`,`'sts_zone'`,`'waypoint'`.
+             breakdown_geography: Geography layer of the origin to aggregate upon. Must be one of the following:
+             `berth`, `terminal`, `port`, `country`, `country_zone`, `shipping_region`, `shipping_region_v2`,
+             `wider_shipping_region`, `region`, `alternative_region`, `trading_block`, `trading_region`,
+             `trading_subregion`, `state_or_province`, `sts_zone`, `waypoint`, `storage`, `storage_terminal`, `basin`,
+             `root`, or not provided. Default is `berth`.
 
              breakdown_size: Number of top geographies to return. Default is 5.
 

vortexasdk/version.py

@@ -1 +1 @@
-__version__ = "0.75.0"
+__version__ = "0.75.1"