omnata-plugin-runtime 0.8.2a203__tar.gz → 0.8.3a207__tar.gz

{omnata_plugin_runtime-0.8.2a203 → omnata_plugin_runtime-0.8.3a207}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.8.2a203
+Version: 0.8.3a207
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.8.2a203 → omnata_plugin_runtime-0.8.3a207}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.8.2-a203"
+version = "0.8.3-a207"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.8.2a203 → omnata_plugin_runtime-0.8.3a207}/src/omnata_plugin_runtime/configuration.py

@@ -704,6 +704,7 @@ class OutboundSyncConfigurationParameters(SyncConfigurationParameters):
     """
 
     connection_method: str
+    target_type: Optional[str] = Field(default=None, description="The label of the OutboundTargetType selected by the user")
     connection_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
     connection_secrets: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)
     sync_parameters: Optional[Dict[str, StoredConfigurationValue]] = Field(default=None)

{omnata_plugin_runtime-0.8.2a203 → omnata_plugin_runtime-0.8.3a207}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -111,11 +111,56 @@ class PluginManifest(SubscriptableBaseModel):
     developer_name: str
     docs_url: str
     supports_inbound: bool
-    supported_outbound_strategies: List[OutboundSyncStrategy]
+    supported_outbound_strategies: List[OutboundSyncStrategy] = Field(
+        title="A list of sync strategies that the plugin can support. If outbound_target_types are specified, theses strategies are allocated there. Otherwise, they apply globally"
+    )
     supported_connectivity_options: List[ConnectivityOption] = Field(
         default_factory=lambda: [ConnectivityOption.DIRECT]
     )
+    outbound_target_types: Optional[List[OutboundTargetType]] = Field(
+        default=None,
+        title="An optional list of target types that the plugin can support."
+    )
 
+class OutboundTargetType(BaseModel):
+    """
+    Some products have APIs that can be grouped together in ways that support different strategies and may or may not support toggling.
+    The label should answer the question: "What would you like to sync to?"
+    Examples:
+    - A CRM system may have "Standard objects", "Custom objects" or "Events"
+    - A messaging platform may have "Channels", "Users" or "Messages"
+    - A marketing platform may have "Customer lists", "Campaigns" or "Automations"
+    - An Ad platform may have "Campaigns", "Ad groups" or "Ads"
+    The target type cannot be changed after the sync is created.
+    """
+    label: str
+    supported_strategies: List[str] = Field(
+        title="The names of the sync strategies supported by this target. Each one must match the name of a sync strategy declared in supported_outbound_strategies."
+    )
+    target_parameter: Optional[OutboundTargetParameter] = Field(
+        default=None,
+        title="""The sync configuration parameter that designates the target object, if applicable. For example, 'object_name' or 'channel_name'. 
+This will be used for two purposes:
+1. To show a more readable indication of what this sync is doing in the UI, e.g. Standard object: Account
+2. Designates this field as serving as a br toggle for testing in production.""")
+
+class OutboundTargetParameter(BaseModel):
+    """
+    Accomodates testing outbound syncs in production by nominating a form field who's value stays in the branch.
+    The reason this information is set statically here instead of as a flag on the FormField, is so that the sync engine 
+    can have this information readily available without calling the plugin.
+    """
+    field_name: str = Field(title="""The name of the form field that toggles the location, e.g. 'channel','customer_list'.
+This must match a field which will be returned by the outbound_configuration_form for this target type.""")
+    is_branching_toggle: bool = Field(title="""Whether or not this field is a target toggle for branching.
+If true, the value of this field will be used to determine the location of the sync in production.
+For example, a messaging plugin could have a "channel" field to route messages to an alternate location.
+Or, a marketing platform could have an alternate customer list name which is connected to test campaigns that don't actually send.
+
+This should only be used in situations where all other sync parameters and field mappings can remain consistent between branches.""")
+    label: str = Field(title="""Used in the UI when describing the location., e.g. 'Channel','Customer List'. 
+It should completely describe the behaviour when used in a sentence like this: 
+'Changes will be tested against a different <label> when running in a branch.'""")
 
 class SnowflakeFunctionParameter(BaseModel):
     """