agilicus 1.276.0__py3-none-any.whl → 1.278.0__py3-none-any.whl

agilicus/agilicus_api/test/test_x509_root_certificate_status.py

@@ -3,7 +3,7 @@
 
     Agilicus is API-first. Modern software is controlled by other software, is open, is available for you to use the way you want, securely, simply.  The OpenAPI Specification in YAML format is available on [www](https://www.agilicus.com/www/api/agilicus-openapi.yaml) for importing to other tools.  A rendered, online viewable and usable version of this specification is available at [api](https://www.agilicus.com/api). You may try the API inline directly in the web page. To do so, first obtain an Authentication Token (the simplest way is to install the Python SDK, and then run `agilicus-cli --issuer https://MYISSUER get-token`). You will need an org-id for most calls (and can obtain from `agilicus-cli --issuer https://MYISSUER list-orgs`). The `MYISSUER` will typically be `auth.MYDOMAIN`, and you will see it as you sign-in to the administrative UI.  This API releases on Bearer-Token authentication. To obtain a valid bearer token you will need to Authenticate to an Issuer with OpenID Connect (a superset of OAUTH2).  Your \"issuer\" will look like https://auth.MYDOMAIN. For example, when you signed-up, if you said \"use my own domain name\" and assigned a CNAME of cloud.example.com, then your issuer would be https://auth.cloud.example.com.  If you selected \"use an Agilicus supplied domain name\", your issuer would look like https://auth.myorg.agilicus.cloud.  For test purposes you can use our [Python SDK](https://pypi.org/project/agilicus/) and run `agilicus-cli --issuer https://auth.MYDOMAIN get-token`.  This API may be used in any language runtime that supports OpenAPI 3.0, or, you may use our [Python SDK](https://pypi.org/project/agilicus/), our [Typescript SDK](https://www.npmjs.com/package/@agilicus/angular), or our [Golang SDK](https://git.agilicus.com/pub/sdk-go).  100% of the activities in our system our API-driven, from our web-admin, through our progressive web applications, to all internals: there is nothing that is not accessible.  For more information, see [developer resources](https://www.agilicus.com/developer).   # noqa: E501
 
-    The version of the OpenAPI document: 2025.02.07
+    The version of the OpenAPI document: 2025.02.12
     Contact: dev@agilicus.com
     Generated by: https://openapi-generator.tech
 """

agilicus/agilicus_api/test/test_xss_settings.py

@@ -3,7 +3,7 @@
 
     Agilicus is API-first. Modern software is controlled by other software, is open, is available for you to use the way you want, securely, simply.  The OpenAPI Specification in YAML format is available on [www](https://www.agilicus.com/www/api/agilicus-openapi.yaml) for importing to other tools.  A rendered, online viewable and usable version of this specification is available at [api](https://www.agilicus.com/api). You may try the API inline directly in the web page. To do so, first obtain an Authentication Token (the simplest way is to install the Python SDK, and then run `agilicus-cli --issuer https://MYISSUER get-token`). You will need an org-id for most calls (and can obtain from `agilicus-cli --issuer https://MYISSUER list-orgs`). The `MYISSUER` will typically be `auth.MYDOMAIN`, and you will see it as you sign-in to the administrative UI.  This API releases on Bearer-Token authentication. To obtain a valid bearer token you will need to Authenticate to an Issuer with OpenID Connect (a superset of OAUTH2).  Your \"issuer\" will look like https://auth.MYDOMAIN. For example, when you signed-up, if you said \"use my own domain name\" and assigned a CNAME of cloud.example.com, then your issuer would be https://auth.cloud.example.com.  If you selected \"use an Agilicus supplied domain name\", your issuer would look like https://auth.myorg.agilicus.cloud.  For test purposes you can use our [Python SDK](https://pypi.org/project/agilicus/) and run `agilicus-cli --issuer https://auth.MYDOMAIN get-token`.  This API may be used in any language runtime that supports OpenAPI 3.0, or, you may use our [Python SDK](https://pypi.org/project/agilicus/), our [Typescript SDK](https://www.npmjs.com/package/@agilicus/angular), or our [Golang SDK](https://git.agilicus.com/pub/sdk-go).  100% of the activities in our system our API-driven, from our web-admin, through our progressive web applications, to all internals: there is nothing that is not accessible.  For more information, see [developer resources](https://www.agilicus.com/developer).   # noqa: E501
 
-    The version of the OpenAPI document: 2025.02.07
+    The version of the OpenAPI document: 2025.02.12
     Contact: dev@agilicus.com
     Generated by: https://openapi-generator.tech
 """

agilicus/agilicus_api_README.md

@@ -3,8 +3,8 @@ Agilicus is API-first. Modern software is controlled by other software, is open,
 
 The `agilicus_api` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2025.02.07
-- Package version: 1.276.0
+- API version: 2025.02.12
+- Package version: 1.278.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.agilicus.com/api](https://www.agilicus.com/api)
 
@@ -1545,6 +1545,7 @@ Class | Method | HTTP request | Description
  - [StorageRegion](agilicus_api/docs/StorageRegion.md)
  - [SupportUser](agilicus_api/docs/SupportUser.md)
  - [SupportUserSpec](agilicus_api/docs/SupportUserSpec.md)
+ - [SupportUserStatus](agilicus_api/docs/SupportUserStatus.md)
  - [TOTPEnrollment](agilicus_api/docs/TOTPEnrollment.md)
  - [TOTPEnrollmentAnswer](agilicus_api/docs/TOTPEnrollmentAnswer.md)
  - [TOTPEnrollmentSpec](agilicus_api/docs/TOTPEnrollmentSpec.md)

agilicus/command_helpers/__init__.py

@@ -0,0 +1,5 @@
+from .command_wrapper import Command
+
+__all__ = [
+    "Command",
+]

agilicus/command_helpers/command_wrapper.py

@@ -0,0 +1,45 @@
+import click
+
+
+class Command:
+    """Command wrapper wraps a CLI command definition the same way you would if you
+    were to directly link it to the shell. Once you have accumulated all your
+    commands, run `add_to_cli` to link them together.
+
+    Example:
+    ```
+    cmd = Command()
+
+    @cmd.command(name="doit)
+    @click.pass_context
+    def doit(ctx):
+        print("hello world")
+
+    @cmd.command(name="other)
+    @click.pass_context
+    def other(ctx):
+        print("something els")
+
+    def add_to_cli(cli):
+        cmd.add_to_cli(cli)
+
+    # Now in another module, where the shell is available, invoke add_to_cli against
+    # it.
+    ```
+    """
+
+    def __init__(self):
+        self.commands = []
+
+    def command(self, name: str, **kwargs):
+        def decorator(function):
+            command_factory = click.command(name=name, **kwargs)
+            command = command_factory(function)
+            self.commands.append(command)
+            return command
+
+        return decorator
+
+    def add_to_cli(self, cli):
+        for cmd in self.commands:
+            cli.add_command(cmd)

agilicus/input_helpers.py

@@ -242,3 +242,25 @@ def add_remove_uniq_list(input_list, to_add_list, to_remove_list):
     for item in to_remove_list or []:
         item_set.remove(item)
     return list(item_set)
+
+
+class EnumType(click.Choice):
+    """
+    A wrapper around a python enum, inspired by
+    https://github.com/pallets/click/issues/605
+    """
+
+    def __init__(self, enum):
+        self.__enum = enum
+        super().__init__([self._to_ui(name) for name in enum.__members__])
+
+    @classmethod
+    def _to_ui(cls, enum_name: str):
+        return enum_name.replace("_", "-")
+
+    @classmethod
+    def _from_ui(cls, enum_name: str):
+        return enum_name.replace("-", "_")
+
+    def convert(self, value, param, ctx):
+        return self.__enum[self._from_ui(super().convert(value, param, ctx))]

agilicus/main.py

@@ -38,7 +38,6 @@ from . import (
     input_helpers,
     issuers,
     logs,
-    messages,
     metrics,
     orgs,
     permissions,
@@ -63,6 +62,8 @@ from . import (
     feature_tags,
 )
 
+from .messages import messages, messages_main
+
 from .input_helpers import (
     SubObjectInt,
     SubObjectString,
@@ -4239,8 +4240,10 @@ def send_message(ctx, **kwargs):
 
 
 @cli.command(name="bulk-delete-messages")
-@click.option("--tag", type=str, required=True, help="the tag name of a message")
+@click.option("--tag", type=str, default=None, help="the tag name of a message")
 @click.option("--org-id", default=None)
+@click.option("--delete-expired", type=bool, is_flag=True, default=None)
+@click.option("--limit", type=int, default=None)
 @click.pass_context
 def bulk_delete_messages(ctx, **kwargs):
     result = messages.bulk_delete_messages(ctx, **kwargs)
@@ -8429,6 +8432,7 @@ def main():
     features_main.add_commands(cli)
     files_main.add_commands(cli)
     policy_config_main.add_commands(cli)
+    messages_main.add_commands(cli)
 
     cli(auto_envvar_prefix="AGILICUS")
 

agilicus/messages/__init__.py

@@ -0,0 +1,8 @@
+from .messages import Broadcast, BroadcastType, MessageTarget, send_broadcast
+
+__all__ = [
+    "Broadcast",
+    "BroadcastType",
+    "MessageTarget",
+    "send_broadcast",
+]

agilicus/{messages.py → messages/messages.py}

@@ -1,3 +1,13 @@
+import datetime
+
+import agilicus
+import shortuuid
+
+from dataclasses import dataclass
+from enum import Enum
+from typing import Optional
+
+
 from agilicus_api import (
     Message,
     MessageAction,
@@ -11,10 +21,10 @@ from agilicus_api import (
     MessagesBulkDeleteRequest,
 )
 
-from . import context
-from . import input_helpers
-from .output.json import convert_to_json
-from .output.table import (
+from .. import context
+from .. import input_helpers
+from ..output.json import convert_to_json
+from ..output.table import (
     format_table,
     metadata_column,
     spec_column,
@@ -22,6 +32,136 @@ from .output.table import (
 )
 
 
+def send_broadcast_from_cli(
+    ctx,
+    user_org_id,
+    expiry,
+    title,
+    text,
+    icon_url,
+    link,
+    target,
+    message_type,
+    campaign_id,
+    push_probability,
+):
+    if not is_tz_aware(expiry):
+        expiry = expiry.astimezone(datetime.timezone.utc)
+    token = context.get_token(ctx)
+    apiclient = context.get_apiclient(ctx, token)
+    if not campaign_id:
+        campaign_id = shortuuid.uuid()
+    msg = Broadcast(
+        title=title,
+        text=text,
+        message_type=message_type,
+        icon_url=icon_url,
+        link=link,
+        push_probability=push_probability,
+    )
+
+    return send_broadcast(
+        apiclient.messages_api,
+        user_org_id_list=user_org_id,
+        msg=msg,
+        expiry=expiry,
+        target=target,
+        campaign_id=campaign_id,
+    )
+
+
+class BroadcastType(Enum):
+    message_of_the_day = "motd"
+    survey = "survey"
+
+
+class MessageTarget(Enum):
+    admin_portal = "agilicus-admin-portal"
+    profile = "agilicus-profile"
+
+
+@dataclass
+class Broadcast:
+    title: str
+    text: str
+    message_type: BroadcastType
+    icon_url: Optional[str] = None
+    link: Optional[str] = None
+    push_probability: Optional[float] = None
+
+
+def send_broadcast(
+    api: agilicus.MessagesApi,
+    user_org_id_list: list[tuple[str, str] | tuple[str, str, bool]],
+    msg: Broadcast,
+    expiry: datetime.datetime,
+    target: MessageTarget,
+    campaign_id: str,
+):
+    """
+    `send_broadcast` sends a message to a list of users (in a given org), which will
+    expire (be removed from their inbox automatically). This can be used to
+    broadcast important announcements, solicit feedback, notify of new features,
+    etc.
+
+    Each user is identified in the `user_org_id_list`, the first item being the user
+    id, and the second their org id. If you want to send to a group of users, use the
+    group's user id as the first parameter in the list, and set the third, optional,
+    parameter to `True`.
+    """
+    if not is_tz_aware(expiry):
+        raise ValueError(f"expiry ({expiry}) must be timezone aware")
+
+    message = agilicus.Message(
+        text=msg.text,
+        title=msg.title,
+        message_type=agilicus.MessageType(msg.message_type.value),
+        message_class=agilicus.MessageClass(target.value),
+    )
+
+    if msg.icon_url is not None:
+        message.icon_url = msg.icon_url
+    if msg.link is not None:
+        message.uri = msg.link
+    if msg.push_probability is not None:
+        message.push_probability = msg.push_probability
+
+    message.expiry_date = expiry
+    message.tag = agilicus.MessageTag(tag_name=agilicus.MessageTagName(campaign_id))
+
+    send_item = agilicus.MessageSendItem(
+        message=message,
+        ephemeral=False,
+        addresses=[
+            _user_org_tuple_to_address(user_org) for user_org in user_org_id_list
+        ],
+        endpoint_types=[agilicus.MessageEndpointType("inbox")],
+    )
+    req = agilicus.MessageSendRequest(
+        messages=[send_item],
+    )
+    return api.create_routed_message(req)
+
+
+def _user_org_tuple_to_address(user_org: tuple[str, str] | tuple[str, str, bool]):
+    addr = agilicus.MessageAddress(
+        user_id=user_org[0],
+        org_id=user_org[1],
+        direct=True,
+    )
+
+    if len(user_org) > 2:
+        # The third parameter here stands for "send to group", which is the inverse of
+        # the direct field of the MessageAddress.
+        addr.direct = not user_org[2]
+
+    return addr
+
+
+def is_tz_aware(dt: datetime.datetime):
+    return dt.tzinfo is not None and dt.tzinfo.utcoffset(dt) is not None
+
+
 def list_message_endpoints(ctx, user_id, **kwargs):
     apiclient = context.get_apiclient_from_ctx(ctx)
     if user_id:
@@ -44,7 +184,11 @@ def format_message_endpoints(ctx, details):
 
 def delete_message_endpoint(ctx, message_endpoint_id, **kwargs):
     apiclient = context.get_apiclient_from_ctx(ctx)
-    resp = apiclient.messages_api.delete_message_endpoint(message_endpoint_id)
+    user_id = input_helpers.get_user_id_from_input_or_ctx(ctx, **kwargs)
+    params = {}
+    if user_id:
+        params["user_id"] = user_id
+    resp = apiclient.messages_api.delete_message_endpoint(message_endpoint_id, **params)
     return resp
 
 
@@ -110,7 +254,7 @@ def send_message(
     return apiclient.messages_api.create_routed_message(req)
 
 
-def make_message_tag(tag, org_id):
+def make_message_tag(tag, org_id=None):
     if tag is None:
         return None
     result = MessageTag(MessageTagName(tag))
@@ -139,8 +283,12 @@ def update_inbox_item(ctx, user_id, inbox_item_id, has_been_read=None, **kwargs)
     )
 
 
-def bulk_delete_messages(ctx, tag, org_id, **kwargs):
-    req = MessagesBulkDeleteRequest(make_message_tag(tag, org_id))
+def bulk_delete_messages(ctx, tag, **kwargs):
+    kwargs = input_helpers.strip_none(kwargs)
+    msg_tag = make_message_tag(tag)
+    if msg_tag:
+        kwargs["message_tag"] = msg_tag
+    req = MessagesBulkDeleteRequest(**kwargs)
     apiclient = context.get_apiclient_from_ctx(ctx)
     resp = apiclient.messages_api.bulk_delete_messages(req)
     return resp

agilicus/messages/messages_main.py

@@ -0,0 +1,46 @@
+import click
+
+from ..input_helpers import EnumType
+from ..output.table import output_entry
+
+from agilicus.command_helpers import Command
+from . import messages
+
+cmd = Command()
+
+
+@cmd.command(name="send-broadcast")
+@click.option(
+    "--user-org-id",
+    multiple=True,
+    type=(str, str),
+    required=True,
+    help="a user and org id",
+)
+@click.option("--expiry", type=click.DateTime(), required=True)
+@click.option("--text", type=str, required=True)
+@click.option("--title", type=str, required=True)
+@click.option("--icon-url", type=str)
+@click.option("--link", type=str)
+@click.option("--campaign_id", type=str)
+@click.option("--target", type=EnumType(messages.MessageTarget), required=True)
+@click.option("--message-type", type=EnumType(messages.BroadcastType), required=True)
+@click.option("--push-probability", type=float, default=None)
+@click.pass_context
+def cli_command_send_broadcast(ctx, **kwargs):
+    """
+    Sends a broadcast message to some number of users, identified by
+    space-delimeted user and org-id pairs (e.g. `--user-org-id user1 org1
+    --user-org-id user2 org2`). This message persists in the users' inboxes
+    until it expires. A campaign ID can be used to uniquely tie together sets
+    of messages sent over a period of time. The message-type helps to identify
+    to client software how to interpret and display the message. Target chooses
+    which client software will display the message.
+    """
+    output_entry(
+        ctx, messages.send_broadcast_from_cli(ctx, **kwargs).sent_messages[0].to_dict()
+    )
+
+
+def add_commands(cli):
+    cmd.add_to_cli(cli)

{agilicus-1.276.0.dist-info → agilicus-1.278.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: agilicus
-Version: 1.276.0
+Version: 1.278.0
 Summary: Agilicus SDK
 Home-page: https://www.agilicus.com/
 License: MIT
@@ -35,6 +35,7 @@ Requires-Dist: prometheus_client (==0.21.1) ; extra == "billing"
 Requires-Dist: python_dateutil (>2.5.3)
 Requires-Dist: pyyaml (==6.0.2)
 Requires-Dist: requests (>=2.23.0,<3.0.0)
+Requires-Dist: shortuuid (>=1.0.13,<2.0.0)
 Requires-Dist: six (>=1.14.0,<2.0.0)
 Requires-Dist: stripe (>=2.60.0,<3.0.0) ; extra == "billing"
 Requires-Dist: xdg (>=5.1.1,<6.0.0)