Skip to content

libica.openapi.libens

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The libica.openapi.libens package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build date: 2024-07-26T11:42:27.715358+10:00[Australia/Melbourne]
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.15
  • six >= 1.10
  • certifi
  • python-dateutil

Getting Started

In your own code, to use this library to connect and interact with libica.openapi.libens, you can run the following:

from __future__ import print_function

import time
import libica.openapi.libens
from libica.openapi.libens.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with libica.openapi.libens.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libens.SubscriptionsApi(api_client)
    body = libica.openapi.libens.CreateSubscriptionRequest() # CreateSubscriptionRequest |  (optional)

    try:
        # Creates a subscription to an event type and defines how those events get delivered.
        api_response = api_instance.create_subscription(body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SubscriptionsApi->create_subscription: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://aps2.platform.illumina.com

Class Method HTTP request Description
SubscriptionsApi create_subscription POST /v1/subscriptions Creates a subscription to an event type and defines how those events get delivered.
SubscriptionsApi disable_subscription DELETE /v1/subscriptions/{subscriptionId} Given a subscription id, disables the specified subscription.
SubscriptionsApi get_subscription GET /v1/subscriptions/{subscriptionId} Given a subscription id, returns information about that subscription.
SubscriptionsApi list_subscriptions GET /v1/subscriptions Get a list of subscriptions.

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author