workos 1.5.1__py3-none-any.whl → 5.38.0__py3-none-any.whl

workos/audit_trail.py

@@ -1,172 +0,0 @@
-import workos
-from workos.exceptions import ConfigurationException
-from workos.resources.event import WorkOSEvent
-from workos.utils.request import RequestHelper, REQUEST_METHOD_GET, REQUEST_METHOD_POST
-from workos.utils.validation import AUDIT_TRAIL_MODULE, validate_settings
-
-EVENTS_PATH = "events"
-METADATA_LIMIT = 50
-DEFAULT_EVENT_LIMIT = 10
-
-
-class AuditTrail(object):
-    """Offers methods through the WorkOS Audit Trail service."""
-
-    @validate_settings(AUDIT_TRAIL_MODULE)
-    def __init__(self):
-        pass
-
-    @property
-    def request_helper(self):
-        if not getattr(self, "_request_helper", None):
-            self._request_helper = RequestHelper()
-        return self._request_helper
-
-    def create_event(self, event, idempotency_key=None):
-        """Create an Audit Trail event.
-
-        Args:
-            event (dict) - An event object
-                event[action] (str) - Specific activity performed by the actor.
-                event[action_type] (str) - Corresponding CRUD category of the
-                    event. Can be one of C, R, U, or D.
-                event[actor_name] (str) - Display name of the entity performing the action
-                event[actor_id] (str) - Unique identifier of the entity performing the action
-                event[group] (str) - A single organization containing related .
-                    members. This will normally be the customer of a vendor's application
-                event[location] (str) - Identifier for where the event
-                    originated. This will be an IP address (IPv4 or IPv6),
-                    hostname, or device ID.
-                event[occurred_at] (str) - ISO-8601 datetime at which the event
-                    happened, with millisecond precision.
-                event[metadata] (str) - Arbitrary key-value data containing
-                    information associated with the event. Note: There is a limit of 50
-                    keys. Key names can be up to 40 characters long, and values can be up
-                    to 500 characters long.
-                event[target_id] (str) - Unique identifier of the object or
-                    resource being acted upon.
-                event[target_name] (str) - Display name of the object or
-                    resource that is being acted upon.
-            idempotency_key (str) - An idempotency key
-
-        Returns:
-            boolean: Returns True
-        """
-        if len(event.get("metadata", {})) > METADATA_LIMIT:
-            raise ValueError(
-                "Number of metadata keys exceeds {}.".format(METADATA_LIMIT)
-            )
-
-        headers = {
-            "idempotency-key": idempotency_key,
-        }
-
-        response = self.request_helper.request(
-            EVENTS_PATH,
-            method=REQUEST_METHOD_POST,
-            params=event,
-            headers=headers,
-            token=workos.api_key,
-        )
-
-        return response["success"]
-
-    def get_events(
-        self,
-        before=None,
-        after=None,
-        limit=DEFAULT_EVENT_LIMIT,
-        group=None,
-        action=None,
-        action_type=None,
-        actor_name=None,
-        actor_id=None,
-        target_name=None,
-        target_id=None,
-        occurred_at=None,
-        occurred_at_gt=None,
-        occurred_at_gte=None,
-        occurred_at_lt=None,
-        occurred_at_lte=None,
-        search=None,
-    ):
-        """Filter for Audit Trail Events.
-
-        Kwargs:
-            before (str) - Event ID to look before
-            after (str) - Event ID to look after
-            limit (int) - Number of Events to return
-            group (str|list) - Group or groups to filter for
-            action (str|list) - Action or actions to filter for
-            action_type (str|list) - Action type or types to filter for
-            actor_name (str|list) - Actor name or name to filter for
-            actor_id (str|list) - Actor ID or IDs to filter for
-            target_name (str|list) - Target name or names to filter for
-            target_id (str|list) - Target ID or IDs to filter for
-            occurred_at (str) - ISO-8601 datetime of when an event occurred
-            occurred_at_gt (str) - ISO-8601 datetime of when an event occurred after
-            occurred_at_gte (str) - ISO-8601 datetime of when an event occurred at or after
-            occurred_at_lt (str) - ISO-8601 datetime of when an event occurred before
-            occurred_at_lte (str) - ISO-8601 datetime of when an event occured at or before
-            search (str) - Keyword search
-
-        Returns:
-            tuple
-                list - List of WorkOSEvent objects
-                string - Event ID to use as before cursor
-                string - Event ID to use as after cursor
-        """
-        params = {
-            "before": before,
-            "after": after,
-            "limit": limit,
-        }
-
-        if group is not None:
-            params["group[]"] = group
-
-        if action is not None:
-            params["action[]"] = action
-
-        if action_type is not None:
-            params["action_type[]"] = action_type
-
-        if actor_name is not None:
-            params["actor_name[]"] = actor_name
-
-        if actor_id is not None:
-            params["actor_id[]"] = actor_id
-
-        if target_name is not None:
-            params["target_name[]"] = target_name
-
-        if target_id is not None:
-            params["target_id[]"] = target_id
-
-        if occurred_at is not None:
-            params["occurred_at"] = occurred_at
-        else:
-            if occurred_at_gte is not None:
-                params["occurred_at_gte"] = occurred_at_gte
-            elif occurred_at_gt is not None:
-                params["occurred_at_gt"] = occurred_at_gt
-
-            if occurred_at_lte is not None:
-                params["occurred_at_lte"] = occurred_at_lte
-            elif occurred_at_lt is not None:
-                params["occurred_at_lt"] = occurred_at_lt
-
-        if search is not None:
-            params["search"] = search
-
-        response = self.request_helper.request(
-            EVENTS_PATH, method=REQUEST_METHOD_GET, params=params, token=workos.api_key,
-        )
-
-        events = [
-            WorkOSEvent.construct_from_response(data) for data in response["data"]
-        ]
-        before = response["listMetadata"]["before"]
-        after = response["listMetadata"]["after"]
-
-        return (events, before, after)

workos/resources/base.py

@@ -1,36 +0,0 @@
-class WorkOSBaseResource(object):
-    """Representation of a WorkOS Resource as returned through the API.
-
-    Attributes:
-        OBJECT_FIELDS (list): List of fields a Resource is comprised of.
-    """
-
-    OBJECT_FIELDS = []
-
-    @classmethod
-    def construct_from_response(cls, response):
-        """Returns an instance of WorkOSBaseResource.
-
-        Args:
-            response (dict): Resource data from a WorkOS API response
-
-        Returns:
-            WorkOSBaseResource: Instance of a WorkOSBaseResource with OBJECT_FIELDS fields set
-        """
-        obj = cls()
-        for field in cls.OBJECT_FIELDS:
-            setattr(obj, field, response[field])
-
-        return obj
-
-    def to_dict(self):
-        """Returns a dict representation of the WorkOSBaseResource.
-
-        Returns:
-            dict: A dict representation of the WorkOSBaseResource
-        """
-        obj_dict = {}
-        for field in self.OBJECT_FIELDS:
-            obj_dict[field] = getattr(self, field, None)
-
-        return obj_dict

workos/resources/event.py

@@ -1,42 +0,0 @@
-from workos.resources.base import WorkOSBaseResource
-from workos.resources.event_action import WorkOSEventAction
-
-
-class WorkOSEvent(WorkOSBaseResource):
-    """Representation of an Event as returned by WorkOS through the Audit Trail feature.
-
-    Attributes:
-        OBJECT_FIELDS (list): List of fields a WorkOSEvent is comprised of.
-    """
-
-    OBJECT_FIELDS = [
-        "id",
-        "group",
-        "location",
-        "latitude",
-        "longitude",
-        "type",
-        "actor_name",
-        "actor_id",
-        "target_name",
-        "target_id",
-        "metadata",
-        "occurred_at",
-    ]
-
-    @classmethod
-    def construct_from_response(cls, response):
-        event = super(WorkOSEvent, cls).construct_from_response(response)
-
-        event_action = WorkOSEventAction.construct_from_response(response["action"])
-        event.action = event_action
-
-        return event
-
-    def to_dict(self):
-        event_dict = super(WorkOSEvent, self).to_dict()
-
-        event_action_dict = self.action.to_dict()
-        event_dict["action"] = event_action_dict
-
-        return event_dict

workos/resources/event_action.py

@@ -1,11 +0,0 @@
-from workos.resources.base import WorkOSBaseResource
-
-
-class WorkOSEventAction(WorkOSBaseResource):
-    """Representation of an Event Action as returned by WorkOS through the Audit Trail feature.
-
-    Attributes:
-        OBJECT_FIELDS (list): List of fields a WorkOSEventAction is comprised of.
-    """
-
-    OBJECT_FIELDS = ["id", "name", "environment_id"]

workos/resources/sso.py

@@ -1,53 +0,0 @@
-from workos.resources.base import WorkOSBaseResource
-
-
-class WorkOSProfile(WorkOSBaseResource):
-    """Representation of a User Profile as returned by WorkOS through the SSO feature.
-
-    Attributes:
-        OBJECT_FIELDS (list): List of fields a WorkOSProfile is comprised of.
-    """
-
-    OBJECT_FIELDS = [
-        "id",
-        "email",
-        "first_name",
-        "last_name",
-        "organization_id",
-        "connection_id",
-        "connection_type",
-        "idp_id",
-        "raw_attributes",
-    ]
-
-
-class WorkOSProfileAndToken(WorkOSBaseResource):
-    """Representation of a User Profile and Access Token as returned by WorkOS through the SSO feature.
-
-    Attributes:
-        OBJECT_FIELDS (list): List of fields a WorkOSProfileAndToken is comprised of.
-    """
-
-    OBJECT_FIELDS = [
-        "access_token",
-    ]
-
-    @classmethod
-    def construct_from_response(cls, response):
-        profile_and_token = super(WorkOSProfileAndToken, cls).construct_from_response(
-            response
-        )
-
-        profile_and_token.profile = WorkOSProfile.construct_from_response(
-            response["profile"]
-        )
-
-        return profile_and_token
-
-    def to_dict(self):
-        profile_and_token_dict = super(WorkOSProfileAndToken, self).to_dict()
-
-        profile_dict = self.profile.to_dict()
-        profile_and_token_dict["profile"] = profile_dict
-
-        return profile_and_token_dict

workos/utils/connection_types.py

@@ -1,17 +0,0 @@
-from enum import Enum
-
-
-class ConnectionType(Enum):
-    ADFSSAML = "ADFSSAML"
-    AzureSAML = "AzureSAML"
-    GenericOIDC = "GenericOIDC"
-    GenericSAML = "GenericSAML"
-    GoogleOAuth = "GoogleOAuth"
-    GoogleSAML = "GoogleSAML"
-    MagicLink = "MagicLink"
-    MicrosoftOAuth = "MicrosoftOAuth"
-    OktaSAML = "OktaSAML"
-    OneLoginSAML = "OneLoginSAML"
-    PingFederateSAML = "PingFederateSAML"
-    PingOneSAML = "PingOneSAML"
-    VMwareSAML = "VMwareSAML"

workos/utils/request.py

@@ -1,95 +0,0 @@
-import requests
-
-import workos
-from workos.exceptions import (
-    AuthorizationException,
-    AuthenticationException,
-    BadRequestException,
-    ServerException,
-)
-
-BASE_HEADERS = {
-    "User-Agent": "WorkOS Python/{}".format(workos.__version__),
-}
-
-RESPONSE_TYPE_CODE = "code"
-
-REQUEST_METHOD_DELETE = "delete"
-REQUEST_METHOD_GET = "get"
-REQUEST_METHOD_POST = "post"
-REQUEST_METHOD_PUT = "put"
-
-
-class RequestHelper(object):
-    def __init__(self):
-        self.set_base_api_url(workos.base_api_url)
-
-    def set_base_api_url(self, base_api_url):
-        """Creates an accessible template for constructing the URL for an API request.
-
-        Args:
-            base_api_url (str): Base URL for api requests (Should end with a /)
-        """
-        self.base_api_url = "{}{{}}".format(base_api_url)
-
-    def generate_api_url(self, path):
-        return self.base_api_url.format(path)
-
-    def request(
-        self, path, method=REQUEST_METHOD_GET, params=None, headers=None, token=None,
-    ):
-        """Executes a request against the WorkOS API.
-
-        Args:
-            path (str): Path for the api request that'd be appended to the base API URL
-
-        Kwargs:
-            method (str): One of the supported methods as defined by the REQUEST_METHOD_X constants
-            params (dict): Query params to be added to the request
-            token (str): Bearer token
-
-        Returns:
-            dict: Response from WorkOS
-        """
-        if headers is None:
-            headers = {}
-
-        if token:
-            headers["Authorization"] = "Bearer {}".format(token)
-
-        headers.update(BASE_HEADERS)
-        url = self.generate_api_url(path)
-
-        request_fn = getattr(requests, method)
-        if method == REQUEST_METHOD_GET:
-            response = request_fn(url, headers=headers, params=params)
-        else:
-            response = request_fn(url, headers=headers, json=params)
-
-        response_json = None
-        content_type = (
-            response.headers.get("content-type")
-            if response.headers is not None
-            else None
-        )
-        if content_type is not None and "application/json" in content_type:
-            try:
-                response_json = response.json()
-            except ValueError:
-                raise ServerException(response)
-
-        status_code = response.status_code
-        if status_code >= 400 and status_code < 500:
-            if status_code == 401:
-                raise AuthenticationException(response)
-            elif status_code == 403:
-                raise AuthorizationException(response)
-            error = response_json.get("error")
-            error_description = response_json.get("error_description")
-            raise BadRequestException(
-                response, error=error, error_description=error_description
-            )
-        elif status_code >= 500 and status_code < 600:
-            raise ServerException(response)
-
-        return response_json

workos/utils/validation.py

@@ -1,45 +0,0 @@
-from functools import wraps
-
-import workos
-from workos.exceptions import ConfigurationException
-
-AUDIT_TRAIL_MODULE = "AuditTrail"
-DIRECTORY_SYNC_MODULE = "DirectorySync"
-ORGANIZATIONS_MODULE = "Organizations"
-PASSWORDLESS_MODULE = "Passwordless"
-PORTAL_MODULE = "Portal"
-SSO_MODULE = "SSO"
-WEBHOOKS_MODULE = "Webhooks"
-
-REQUIRED_SETTINGS_FOR_MODULE = {
-    AUDIT_TRAIL_MODULE: ["api_key",],
-    DIRECTORY_SYNC_MODULE: ["api_key",],
-    ORGANIZATIONS_MODULE: ["api_key",],
-    PASSWORDLESS_MODULE: ["api_key",],
-    PORTAL_MODULE: ["api_key",],
-    SSO_MODULE: ["api_key", "client_id",],
-    WEBHOOKS_MODULE: ["api_key"],
-}
-
-
-def validate_settings(module_name):
-    def decorator(fn):
-        @wraps(fn)
-        def wrapper(*args, **kwargs):
-            missing_settings = []
-
-            for setting in REQUIRED_SETTINGS_FOR_MODULE[module_name]:
-                if not getattr(workos, setting, None):
-                    missing_settings.append(setting)
-
-            if missing_settings:
-                raise ConfigurationException(
-                    "The following settings are missing for {}: {}".format(
-                        module_name, ", ".join(missing_settings)
-                    )
-                )
-            return fn(*args, **kwargs)
-
-        return wrapper
-
-    return decorator

workos-1.5.1.dist-info/METADATA

@@ -1,77 +0,0 @@
-Metadata-Version: 2.1
-Name: workos
-Version: 1.5.1
-Summary: WorkOS Python Client
-Home-page: https://github.com/workos-inc/workos-python
-Author: WorkOS
-Author-email: team@workos.com
-License: MIT
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Description-Content-Type: text/markdown
-Requires-Dist: requests (>=2.22.0)
-Requires-Dist: enum34 ; python_version<'3.4'
-Provides-Extra: dev
-Requires-Dist: flake8 ; extra == 'dev'
-Requires-Dist: pytest (==4.6.9) ; extra == 'dev'
-Requires-Dist: pytest-cov (==2.8.1) ; extra == 'dev'
-Requires-Dist: six (==1.13.0) ; extra == 'dev'
-Requires-Dist: black (==19.10b0) ; extra == 'dev'
-Requires-Dist: twine (==3.1.1) ; extra == 'dev'
-
-# WorkOS Python Library
-
-![PyPI](https://img.shields.io/pypi/v/workos)
-[![Build Status](https://workos.semaphoreci.com/badges/workos-python/branches/master.svg?style=shields&key=9e4cb5bb-86a4-4938-9ec2-fc9f9fc512be)](https://workos.semaphoreci.com/projects/workos-python)
-
-The WorkOS library for Python provides convenient access to the WorkOS API from applications written in Python, [hosted on PyPi](https://pypi.org/project/workos/)
-
-## Documentation
-
-See the [API Reference](https://workos.com/docs/reference/client-libraries) for Python usage examples.
-
-## Installation
-
-To install from PyPi, run the following:
-
-```
-pip install workos
-```
-
-To install from source, clone the repo and run the following:
-
-```
-python setup.py install
-```
-
-## Configuration
-
-The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on using SSO:
-
-```python
-import workos
-
-workos.api_key = "sk_1234"
-workos.client_id = "client_1234"
-```
-
-## More Information
-
-- [Single Sign-On Guide](https://workos.com/docs/sso/guide)
-- [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
-- [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
-- [Magic Link Guide](https://workos.com/docs/magic-link/guide)
-
-

workos-1.5.1.dist-info/RECORD

@@ -1,25 +0,0 @@
-workos/__about__.py,sha256=kdj91jXlr4DPgTmhpcYtVjlx7BD3dLNZl0ORatUKuJk,405
-workos/__init__.py,sha256=EBYXvVZCRbkoUs8IMgjd5mwWIiVsrglUWueOYxd9IZY,207
-workos/audit_trail.py,sha256=rSVweO8PCLN4npLekBPgDYy55uiUKZ_Llz6935-Ootc,6411
-workos/client.py,sha256=FrOPeSvtM_gszanBD336i6QDRIqBidM3H3mEzvIkwFk,1554
-workos/directory_sync.py,sha256=FFwSQsw5lOv9Fbqnx5zryFN7lOr8a1ROGah8Il-GZy4,5178
-workos/exceptions.py,sha256=iSLDPtUat7xsaKmkGxlwB4W0SFEZZ_Yl-1JxmYDtTPY,1497
-workos/organizations.py,sha256=H7E-R3OFw8r9GRjsJUQpPanN7DKohxXGlRVUVg2FU2o,4419
-workos/passwordless.py,sha256=bRGZ0OJA3gv9Gge7Nas19jtoUYU92sopzUOFguOs230,2620
-workos/portal.py,sha256=iy1LsD9dHUEAv7pQ1XnWTnAfiymWN1T1Z1lTh_WiSks,1540
-workos/sso.py,sha256=z-xrKzp5saNaDmxwCpK0pcO57BTFJSUPO1DtKBQiYpE,6313
-workos/webhooks.py,sha256=eqzDwHw4tQF7pcb_8Po4VlmxENzviFRcL8tuS8uKhOM,3093
-workos/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-workos/resources/base.py,sha256=V5jaKeAKtjgyVLDJcd9XIs5mj4R06dcYIxbtx2xVGVw,1020
-workos/resources/event.py,sha256=8K-vJdSAt92r7hetmzwJtBVggnUaoiJO_d7pMPGpyJ8,1101
-workos/resources/event_action.py,sha256=oBALu0VjWISfxq6LlVVd8NGXE_lGrXAvxm5piqPwM-4,357
-workos/resources/sso.py,sha256=PQxsO8GoPxjfHRsT7w_naUnfaA0xFOj28WJ7A2IKWm8,1412
-workos/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-workos/utils/connection_types.py,sha256=gCCSunkI-g6zPw1k8miPAyiST8SmZXCIfmdd38NExXA,462
-workos/utils/request.py,sha256=i6m5-hYrjYeVHg5WcrYz0QJRXqEgTdKvSZTQWOWxDNw,2963
-workos/utils/validation.py,sha256=mN_qA7FmRJloiGuRRuz4h3JoeBoeLAkszZo2FDxA43c,1301
-workos-1.5.1.dist-info/LICENSE,sha256=RAEmkw4BYTzgAxZbzzw_DDUlpPgg02u-_9qtEfcAOOw,1063
-workos-1.5.1.dist-info/METADATA,sha256=fD669IKXn5NTE--OKsfi-ZhRw2KerJ4kbAV0OQ56_Ns,2611
-workos-1.5.1.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
-workos-1.5.1.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
-workos-1.5.1.dist-info/RECORD,,