lusid-notifications-sdk


Namelusid-notifications-sdk JSON
Version 2.1.57 PyPI version JSON
download
home_pagehttps://github.com/finbourne/notifications-sdk-python
SummaryFINBOURNE Notifications API
upload_time2024-11-25 21:38:52
maintainerNone
docs_urlNone
authorFINBOURNE Technology
requires_python<4.0,>=3.8
licenseMIT
keywords openapi openapi-generator finbourne notifications api lusid-notifications-sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints

All URIs are relative to *https://fbn-prd.lusid.com/notification*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control
*DeliveriesApi* | [**list_deliveries**](docs/DeliveriesApi.md#list_deliveries) | **GET** /api/deliveries | [EXPERIMENTAL] ListDeliveries: List Deliveries
*EventTypesApi* | [**get_event_type**](docs/EventTypesApi.md#get_event_type) | **GET** /api/eventtypes/{eventType} | [EXPERIMENTAL] GetEventType: Gets the specified event type schema.
*EventTypesApi* | [**list_event_types**](docs/EventTypesApi.md#list_event_types) | **GET** /api/eventtypes | [EXPERIMENTAL] ListEventTypes: Lists all of the available event types.
*ManualEventApi* | [**trigger_manual_event**](docs/ManualEventApi.md#trigger_manual_event) | **POST** /api/manualevent | [EXPERIMENTAL] TriggerManualEvent: Trigger a manual event.
*NotificationsApi* | [**create_notification**](docs/NotificationsApi.md#create_notification) | **POST** /api/subscriptions/{scope}/{code}/notifications | [EXPERIMENTAL] CreateNotification: Add a Notification to a Subscription.
*NotificationsApi* | [**delete_notification**](docs/NotificationsApi.md#delete_notification) | **DELETE** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] DeleteNotification: Delete a notification for a given subscription.
*NotificationsApi* | [**get_notification**](docs/NotificationsApi.md#get_notification) | **GET** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] GetNotification: Get a notification on a subscription.
*NotificationsApi* | [**list_notifications**](docs/NotificationsApi.md#list_notifications) | **GET** /api/subscriptions/{scope}/{code}/notifications | [EXPERIMENTAL] ListNotifications: List all notifications on a subscription.
*NotificationsApi* | [**update_notification**](docs/NotificationsApi.md#update_notification) | **PUT** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] UpdateNotification: Update a Notification for a Subscription
*SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /api/subscriptions | [EXPERIMENTAL] CreateSubscription: Create a new subscription.
*SubscriptionsApi* | [**delete_subscription**](docs/SubscriptionsApi.md#delete_subscription) | **DELETE** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] DeleteSubscription: Delete a subscription.
*SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] GetSubscription: Get a subscription.
*SubscriptionsApi* | [**list_subscriptions**](docs/SubscriptionsApi.md#list_subscriptions) | **GET** /api/subscriptions | [EXPERIMENTAL] ListSubscriptions: List subscriptions.
*SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] UpdateSubscription: Update an existing subscription.


<a id="documentation-for-models"></a>
## Documentation for Models

 - [AccessControlledAction](docs/AccessControlledAction.md)
 - [AccessControlledResource](docs/AccessControlledResource.md)
 - [ActionId](docs/ActionId.md)
 - [AmazonSqsNotificationType](docs/AmazonSqsNotificationType.md)
 - [AmazonSqsNotificationTypeResponse](docs/AmazonSqsNotificationTypeResponse.md)
 - [AmazonSqsPrincipalAuthNotificationType](docs/AmazonSqsPrincipalAuthNotificationType.md)
 - [AmazonSqsPrincipalAuthNotificationTypeResponse](docs/AmazonSqsPrincipalAuthNotificationTypeResponse.md)
 - [Attempt](docs/Attempt.md)
 - [AttemptStatus](docs/AttemptStatus.md)
 - [AzureServiceBusNotificationType](docs/AzureServiceBusNotificationType.md)
 - [AzureServiceBusTypeResponse](docs/AzureServiceBusTypeResponse.md)
 - [CreateNotificationRequest](docs/CreateNotificationRequest.md)
 - [CreateSubscription](docs/CreateSubscription.md)
 - [Delivery](docs/Delivery.md)
 - [EmailNotificationType](docs/EmailNotificationType.md)
 - [EmailNotificationTypeResponse](docs/EmailNotificationTypeResponse.md)
 - [EventFieldDefinition](docs/EventFieldDefinition.md)
 - [EventTypeSchema](docs/EventTypeSchema.md)
 - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
 - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
 - [Link](docs/Link.md)
 - [LusidProblemDetails](docs/LusidProblemDetails.md)
 - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
 - [ManualEvent](docs/ManualEvent.md)
 - [ManualEventBody](docs/ManualEventBody.md)
 - [ManualEventHeader](docs/ManualEventHeader.md)
 - [ManualEventRequest](docs/ManualEventRequest.md)
 - [MatchingPattern](docs/MatchingPattern.md)
 - [Notification](docs/Notification.md)
 - [NotificationStatus](docs/NotificationStatus.md)
 - [NotificationType](docs/NotificationType.md)
 - [NotificationTypeResponse](docs/NotificationTypeResponse.md)
 - [ResourceId](docs/ResourceId.md)
 - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
 - [ResourceListOfDelivery](docs/ResourceListOfDelivery.md)
 - [ResourceListOfEventTypeSchema](docs/ResourceListOfEventTypeSchema.md)
 - [ResourceListOfNotification](docs/ResourceListOfNotification.md)
 - [ResourceListOfSubscription](docs/ResourceListOfSubscription.md)
 - [SmsNotificationType](docs/SmsNotificationType.md)
 - [SmsNotificationTypeResponse](docs/SmsNotificationTypeResponse.md)
 - [Subscription](docs/Subscription.md)
 - [UpdateNotificationRequest](docs/UpdateNotificationRequest.md)
 - [UpdateSubscription](docs/UpdateSubscription.md)
 - [WebhookNotificationType](docs/WebhookNotificationType.md)
 - [WebhookNotificationTypeResponse](docs/WebhookNotificationTypeResponse.md)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/finbourne/notifications-sdk-python",
    "name": "lusid-notifications-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, FINBOURNE Notifications API, lusid-notifications-sdk",
    "author": "FINBOURNE Technology",
    "author_email": "info@finbourne.com",
    "download_url": "https://files.pythonhosted.org/packages/c1/6c/1e1175b3d6216724744b186bb9cca5c7e118555014f27084acb8a4e566db/lusid_notifications_sdk-2.1.57.tar.gz",
    "platform": null,
    "description": "<a id=\"documentation-for-api-endpoints\"></a>\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fbn-prd.lusid.com/notification*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control\n*DeliveriesApi* | [**list_deliveries**](docs/DeliveriesApi.md#list_deliveries) | **GET** /api/deliveries | [EXPERIMENTAL] ListDeliveries: List Deliveries\n*EventTypesApi* | [**get_event_type**](docs/EventTypesApi.md#get_event_type) | **GET** /api/eventtypes/{eventType} | [EXPERIMENTAL] GetEventType: Gets the specified event type schema.\n*EventTypesApi* | [**list_event_types**](docs/EventTypesApi.md#list_event_types) | **GET** /api/eventtypes | [EXPERIMENTAL] ListEventTypes: Lists all of the available event types.\n*ManualEventApi* | [**trigger_manual_event**](docs/ManualEventApi.md#trigger_manual_event) | **POST** /api/manualevent | [EXPERIMENTAL] TriggerManualEvent: Trigger a manual event.\n*NotificationsApi* | [**create_notification**](docs/NotificationsApi.md#create_notification) | **POST** /api/subscriptions/{scope}/{code}/notifications | [EXPERIMENTAL] CreateNotification: Add a Notification to a Subscription.\n*NotificationsApi* | [**delete_notification**](docs/NotificationsApi.md#delete_notification) | **DELETE** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] DeleteNotification: Delete a notification for a given subscription.\n*NotificationsApi* | [**get_notification**](docs/NotificationsApi.md#get_notification) | **GET** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] GetNotification: Get a notification on a subscription.\n*NotificationsApi* | [**list_notifications**](docs/NotificationsApi.md#list_notifications) | **GET** /api/subscriptions/{scope}/{code}/notifications | [EXPERIMENTAL] ListNotifications: List all notifications on a subscription.\n*NotificationsApi* | [**update_notification**](docs/NotificationsApi.md#update_notification) | **PUT** /api/subscriptions/{scope}/{code}/notifications/{id} | [EXPERIMENTAL] UpdateNotification: Update a Notification for a Subscription\n*SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /api/subscriptions | [EXPERIMENTAL] CreateSubscription: Create a new subscription.\n*SubscriptionsApi* | [**delete_subscription**](docs/SubscriptionsApi.md#delete_subscription) | **DELETE** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] DeleteSubscription: Delete a subscription.\n*SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] GetSubscription: Get a subscription.\n*SubscriptionsApi* | [**list_subscriptions**](docs/SubscriptionsApi.md#list_subscriptions) | **GET** /api/subscriptions | [EXPERIMENTAL] ListSubscriptions: List subscriptions.\n*SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /api/subscriptions/{scope}/{code} | [EXPERIMENTAL] UpdateSubscription: Update an existing subscription.\n\n\n<a id=\"documentation-for-models\"></a>\n## Documentation for Models\n\n - [AccessControlledAction](docs/AccessControlledAction.md)\n - [AccessControlledResource](docs/AccessControlledResource.md)\n - [ActionId](docs/ActionId.md)\n - [AmazonSqsNotificationType](docs/AmazonSqsNotificationType.md)\n - [AmazonSqsNotificationTypeResponse](docs/AmazonSqsNotificationTypeResponse.md)\n - [AmazonSqsPrincipalAuthNotificationType](docs/AmazonSqsPrincipalAuthNotificationType.md)\n - [AmazonSqsPrincipalAuthNotificationTypeResponse](docs/AmazonSqsPrincipalAuthNotificationTypeResponse.md)\n - [Attempt](docs/Attempt.md)\n - [AttemptStatus](docs/AttemptStatus.md)\n - [AzureServiceBusNotificationType](docs/AzureServiceBusNotificationType.md)\n - [AzureServiceBusTypeResponse](docs/AzureServiceBusTypeResponse.md)\n - [CreateNotificationRequest](docs/CreateNotificationRequest.md)\n - [CreateSubscription](docs/CreateSubscription.md)\n - [Delivery](docs/Delivery.md)\n - [EmailNotificationType](docs/EmailNotificationType.md)\n - [EmailNotificationTypeResponse](docs/EmailNotificationTypeResponse.md)\n - [EventFieldDefinition](docs/EventFieldDefinition.md)\n - [EventTypeSchema](docs/EventTypeSchema.md)\n - [IdSelectorDefinition](docs/IdSelectorDefinition.md)\n - [IdentifierPartSchema](docs/IdentifierPartSchema.md)\n - [Link](docs/Link.md)\n - [LusidProblemDetails](docs/LusidProblemDetails.md)\n - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)\n - [ManualEvent](docs/ManualEvent.md)\n - [ManualEventBody](docs/ManualEventBody.md)\n - [ManualEventHeader](docs/ManualEventHeader.md)\n - [ManualEventRequest](docs/ManualEventRequest.md)\n - [MatchingPattern](docs/MatchingPattern.md)\n - [Notification](docs/Notification.md)\n - [NotificationStatus](docs/NotificationStatus.md)\n - [NotificationType](docs/NotificationType.md)\n - [NotificationTypeResponse](docs/NotificationTypeResponse.md)\n - [ResourceId](docs/ResourceId.md)\n - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)\n - [ResourceListOfDelivery](docs/ResourceListOfDelivery.md)\n - [ResourceListOfEventTypeSchema](docs/ResourceListOfEventTypeSchema.md)\n - [ResourceListOfNotification](docs/ResourceListOfNotification.md)\n - [ResourceListOfSubscription](docs/ResourceListOfSubscription.md)\n - [SmsNotificationType](docs/SmsNotificationType.md)\n - [SmsNotificationTypeResponse](docs/SmsNotificationTypeResponse.md)\n - [Subscription](docs/Subscription.md)\n - [UpdateNotificationRequest](docs/UpdateNotificationRequest.md)\n - [UpdateSubscription](docs/UpdateSubscription.md)\n - [WebhookNotificationType](docs/WebhookNotificationType.md)\n - [WebhookNotificationTypeResponse](docs/WebhookNotificationTypeResponse.md)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "FINBOURNE Notifications API",
    "version": "2.1.57",
    "project_urls": {
        "Homepage": "https://github.com/finbourne/notifications-sdk-python",
        "Repository": "https://github.com/finbourne/notifications-sdk-python"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " finbourne notifications api",
        " lusid-notifications-sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7950866811e578f0a38cdcb3c701d6b60a2a36ef1036bee11f29301368d38a9f",
                "md5": "7bfdd6b3cf73fc67f228d45a94d10809",
                "sha256": "09bd07778a292a024acffbadad459eb10fce5a5312084dc1acfa89b9a036da79"
            },
            "downloads": -1,
            "filename": "lusid_notifications_sdk-2.1.57-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7bfdd6b3cf73fc67f228d45a94d10809",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 131102,
            "upload_time": "2024-11-25T21:38:50",
            "upload_time_iso_8601": "2024-11-25T21:38:50.399148Z",
            "url": "https://files.pythonhosted.org/packages/79/50/866811e578f0a38cdcb3c701d6b60a2a36ef1036bee11f29301368d38a9f/lusid_notifications_sdk-2.1.57-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c16c1e1175b3d6216724744b186bb9cca5c7e118555014f27084acb8a4e566db",
                "md5": "e81d16bb63edad2f40d112563f7f3394",
                "sha256": "aa6613f7f0c1d135016f1367c226818b350ffef09204d55fb440d98eb89b7ae3"
            },
            "downloads": -1,
            "filename": "lusid_notifications_sdk-2.1.57.tar.gz",
            "has_sig": false,
            "md5_digest": "e81d16bb63edad2f40d112563f7f3394",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 64086,
            "upload_time": "2024-11-25T21:38:52",
            "upload_time_iso_8601": "2024-11-25T21:38:52.616833Z",
            "url": "https://files.pythonhosted.org/packages/c1/6c/1e1175b3d6216724744b186bb9cca5c7e118555014f27084acb8a4e566db/lusid_notifications_sdk-2.1.57.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-25 21:38:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "finbourne",
    "github_project": "notifications-sdk-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lusid-notifications-sdk"
}
        
Elapsed time: 0.49721s