agilicus 1.270.0__py3-none-any.whl → 1.270.2__py3-none-any.whl

agilicus/agilicus_api/api/connectors_api.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: 2024.10.29
+    The version of the OpenAPI document: 2024.11.04
     Contact: dev@agilicus.com
     Generated by: https://openapi-generator.tech
 """
@@ -38,6 +38,7 @@ from agilicus_api.model.cert_signing_req import CertSigningReq
 from agilicus_api.model.configure_connector_stats_publishing_request import ConfigureConnectorStatsPublishingRequest
 from agilicus_api.model.connector import Connector
 from agilicus_api.model.connector_secure_transfer import ConnectorSecureTransfer
+from agilicus_api.model.connector_service import ConnectorService
 from agilicus_api.model.encrypted_data import EncryptedData
 from agilicus_api.model.error_message import ErrorMessage
 from agilicus_api.model.ipsec_connector import IpsecConnector
@@ -47,6 +48,7 @@ from agilicus_api.model.list_agent_connector_response import ListAgentConnectorR
 from agilicus_api.model.list_cert_signing_req_response import ListCertSigningReqResponse
 from agilicus_api.model.list_connector_response import ListConnectorResponse
 from agilicus_api.model.list_connector_secure_transfer_response import ListConnectorSecureTransferResponse
+from agilicus_api.model.list_connector_service_response import ListConnectorServiceResponse
 from agilicus_api.model.list_connector_stats_response import ListConnectorStatsResponse
 from agilicus_api.model.list_guid_metadata_response import ListGuidMetadataResponse
 from agilicus_api.model.list_ipsec_connector_response import ListIpsecConnectorResponse
@@ -1225,6 +1227,137 @@ class ConnectorsApi(object):
                 callable=__create_queue
             )
 
+        def __create_service(
+            self,
+            connector_id,
+            connector_service,
+            **kwargs
+        ):
+            """Creates an ConnectorServices  # noqa: E501
+
+            Create an ConnectorService of an Connector   # noqa: E501
+            This method makes a synchronous HTTP request by default. To make an
+            asynchronous HTTP request, please pass async_req=True
+
+            >>> thread = api.create_service(connector_id, connector_service, async_req=True)
+            >>> result = thread.get()
+
+            Args:
+                connector_id (str): connector id path
+                connector_service (ConnectorService):
+
+            Keyword Args:
+                _return_http_data_only (bool): response data without head status
+                    code and headers. Default is True.
+                _preload_content (bool): if False, the urllib3.HTTPResponse object
+                    will be returned without reading/decoding response data.
+                    Default is True.
+                _request_timeout (float/tuple): timeout setting for this request. If one
+                    number provided, it will be total request timeout. It can also
+                    be a pair (tuple) of (connection, read) timeouts.
+                    Default is None.
+                _check_input_type (bool): specifies if type checking
+                    should be done one the data sent to the server.
+                    Default is True.
+                _check_return_type (bool): specifies if type checking
+                    should be done one the data received from the server.
+                    Default is True.
+                _host_index (int/None): specifies the index of the server
+                    that we want to use.
+                    Default is read from the configuration.
+                async_req (bool): execute request asynchronously
+
+            Returns:
+                ConnectorService
+                    If the method is called asynchronously, returns the request
+                    thread.
+            """
+            kwargs['async_req'] = kwargs.get(
+                'async_req', False
+            )
+            kwargs['_return_http_data_only'] = kwargs.get(
+                '_return_http_data_only', True
+            )
+            kwargs['_preload_content'] = kwargs.get(
+                '_preload_content', True
+            )
+            kwargs['_request_timeout'] = kwargs.get(
+                '_request_timeout', None
+            )
+            kwargs['_check_input_type'] = kwargs.get(
+                '_check_input_type', True
+            )
+            kwargs['_check_return_type'] = kwargs.get(
+                '_check_return_type', True
+            )
+            kwargs['_host_index'] = kwargs.get('_host_index')
+            kwargs['connector_id'] = \
+                connector_id
+            kwargs['connector_service'] = \
+                connector_service
+            return self.call_with_http_info(**kwargs)
+
+        if self.create_service is None:
+            self.create_service = _Endpoint(
+                settings={
+                    'response_type': (ConnectorService,),
+                    'auth': [
+                        'token-valid'
+                    ],
+                    'endpoint_path': '/v1/connectors/{connector_id}/services',
+                    'operation_id': 'create_service',
+                    'http_method': 'POST',
+                    'servers': None,
+                },
+                params_map={
+                    'all': [
+                        'connector_id',
+                        'connector_service',
+                    ],
+                    'required': [
+                        'connector_id',
+                        'connector_service',
+                    ],
+                    'nullable': [
+                    ],
+                    'enum': [
+                    ],
+                    'validation': [
+                    ]
+                },
+                root_map={
+                    'validations': {
+                    },
+                    'allowed_values': {
+                    },
+                    'openapi_types': {
+                        'connector_id':
+                            (str,),
+                        'connector_service':
+                            (ConnectorService,),
+                    },
+                    'attribute_map': {
+                        'connector_id': 'connector_id',
+                    },
+                    'location_map': {
+                        'connector_id': 'path',
+                        'connector_service': 'body',
+                    },
+                    'collection_format_map': {
+                    }
+                },
+                headers_map={
+                    'accept': [
+                        'application/json'
+                    ],
+                    'content_type': [
+                        'application/json'
+                    ]
+                },
+                api_client=api_client,
+                callable=__create_service
+            )
+
         def __create_transfer(
             self,
             connector_id,
@@ -2122,6 +2255,140 @@ class ConnectorsApi(object):
                 callable=__delete_proxy
             )
 
+        def __delete_service(
+            self,
+            connector_id,
+            connector_service,
+            **kwargs
+        ):
+            """Delete a connector service  # noqa: E501
+
+            Delete a connector service  # noqa: E501
+            This method makes a synchronous HTTP request by default. To make an
+            asynchronous HTTP request, please pass async_req=True
+
+            >>> thread = api.delete_service(connector_id, connector_service, async_req=True)
+            >>> result = thread.get()
+
+            Args:
+                connector_id (str): connector id path
+                connector_service (str): connector service path
+
+            Keyword Args:
+                org_id (str): Organisation Unique identifier. [optional]
+                _return_http_data_only (bool): response data without head status
+                    code and headers. Default is True.
+                _preload_content (bool): if False, the urllib3.HTTPResponse object
+                    will be returned without reading/decoding response data.
+                    Default is True.
+                _request_timeout (float/tuple): timeout setting for this request. If one
+                    number provided, it will be total request timeout. It can also
+                    be a pair (tuple) of (connection, read) timeouts.
+                    Default is None.
+                _check_input_type (bool): specifies if type checking
+                    should be done one the data sent to the server.
+                    Default is True.
+                _check_return_type (bool): specifies if type checking
+                    should be done one the data received from the server.
+                    Default is True.
+                _host_index (int/None): specifies the index of the server
+                    that we want to use.
+                    Default is read from the configuration.
+                async_req (bool): execute request asynchronously
+
+            Returns:
+                None
+                    If the method is called asynchronously, returns the request
+                    thread.
+            """
+            kwargs['async_req'] = kwargs.get(
+                'async_req', False
+            )
+            kwargs['_return_http_data_only'] = kwargs.get(
+                '_return_http_data_only', True
+            )
+            kwargs['_preload_content'] = kwargs.get(
+                '_preload_content', True
+            )
+            kwargs['_request_timeout'] = kwargs.get(
+                '_request_timeout', None
+            )
+            kwargs['_check_input_type'] = kwargs.get(
+                '_check_input_type', True
+            )
+            kwargs['_check_return_type'] = kwargs.get(
+                '_check_return_type', True
+            )
+            kwargs['_host_index'] = kwargs.get('_host_index')
+            kwargs['connector_id'] = \
+                connector_id
+            kwargs['connector_service'] = \
+                connector_service
+            return self.call_with_http_info(**kwargs)
+
+        if self.delete_service is None:
+            self.delete_service = _Endpoint(
+                settings={
+                    'response_type': None,
+                    'auth': [
+                        'token-valid'
+                    ],
+                    'endpoint_path': '/v1/connectors/{connector_id}/services/{connector_service}',
+                    'operation_id': 'delete_service',
+                    'http_method': 'DELETE',
+                    'servers': None,
+                },
+                params_map={
+                    'all': [
+                        'connector_id',
+                        'connector_service',
+                        'org_id',
+                    ],
+                    'required': [
+                        'connector_id',
+                        'connector_service',
+                    ],
+                    'nullable': [
+                    ],
+                    'enum': [
+                    ],
+                    'validation': [
+                    ]
+                },
+                root_map={
+                    'validations': {
+                    },
+                    'allowed_values': {
+                    },
+                    'openapi_types': {
+                        'connector_id':
+                            (str,),
+                        'connector_service':
+                            (str,),
+                        'org_id':
+                            (str,),
+                    },
+                    'attribute_map': {
+                        'connector_id': 'connector_id',
+                        'connector_service': 'connector_service',
+                        'org_id': 'org_id',
+                    },
+                    'location_map': {
+                        'connector_id': 'path',
+                        'connector_service': 'path',
+                        'org_id': 'query',
+                    },
+                    'collection_format_map': {
+                    }
+                },
+                headers_map={
+                    'accept': [],
+                    'content_type': [],
+                },
+                api_client=api_client,
+                callable=__delete_service
+            )
+
         def __delete_transfer(
             self,
             connector_id,
@@ -4253,6 +4520,142 @@ class ConnectorsApi(object):
                 callable=__get_queues
             )
 
+        def __get_service(
+            self,
+            connector_id,
+            connector_service,
+            **kwargs
+        ):
+            """Get ConnectorService  # noqa: E501
+
+            Get ConnectorService  # noqa: E501
+            This method makes a synchronous HTTP request by default. To make an
+            asynchronous HTTP request, please pass async_req=True
+
+            >>> thread = api.get_service(connector_id, connector_service, async_req=True)
+            >>> result = thread.get()
+
+            Args:
+                connector_id (str): connector id path
+                connector_service (str): connector service path
+
+            Keyword Args:
+                org_id (str): Organisation Unique identifier. [optional]
+                _return_http_data_only (bool): response data without head status
+                    code and headers. Default is True.
+                _preload_content (bool): if False, the urllib3.HTTPResponse object
+                    will be returned without reading/decoding response data.
+                    Default is True.
+                _request_timeout (float/tuple): timeout setting for this request. If one
+                    number provided, it will be total request timeout. It can also
+                    be a pair (tuple) of (connection, read) timeouts.
+                    Default is None.
+                _check_input_type (bool): specifies if type checking
+                    should be done one the data sent to the server.
+                    Default is True.
+                _check_return_type (bool): specifies if type checking
+                    should be done one the data received from the server.
+                    Default is True.
+                _host_index (int/None): specifies the index of the server
+                    that we want to use.
+                    Default is read from the configuration.
+                async_req (bool): execute request asynchronously
+
+            Returns:
+                ConnectorService
+                    If the method is called asynchronously, returns the request
+                    thread.
+            """
+            kwargs['async_req'] = kwargs.get(
+                'async_req', False
+            )
+            kwargs['_return_http_data_only'] = kwargs.get(
+                '_return_http_data_only', True
+            )
+            kwargs['_preload_content'] = kwargs.get(
+                '_preload_content', True
+            )
+            kwargs['_request_timeout'] = kwargs.get(
+                '_request_timeout', None
+            )
+            kwargs['_check_input_type'] = kwargs.get(
+                '_check_input_type', True
+            )
+            kwargs['_check_return_type'] = kwargs.get(
+                '_check_return_type', True
+            )
+            kwargs['_host_index'] = kwargs.get('_host_index')
+            kwargs['connector_id'] = \
+                connector_id
+            kwargs['connector_service'] = \
+                connector_service
+            return self.call_with_http_info(**kwargs)
+
+        if self.get_service is None:
+            self.get_service = _Endpoint(
+                settings={
+                    'response_type': (ConnectorService,),
+                    'auth': [
+                        'token-valid'
+                    ],
+                    'endpoint_path': '/v1/connectors/{connector_id}/services/{connector_service}',
+                    'operation_id': 'get_service',
+                    'http_method': 'GET',
+                    'servers': None,
+                },
+                params_map={
+                    'all': [
+                        'connector_id',
+                        'connector_service',
+                        'org_id',
+                    ],
+                    'required': [
+                        'connector_id',
+                        'connector_service',
+                    ],
+                    'nullable': [
+                    ],
+                    'enum': [
+                    ],
+                    'validation': [
+                    ]
+                },
+                root_map={
+                    'validations': {
+                    },
+                    'allowed_values': {
+                    },
+                    'openapi_types': {
+                        'connector_id':
+                            (str,),
+                        'connector_service':
+                            (str,),
+                        'org_id':
+                            (str,),
+                    },
+                    'attribute_map': {
+                        'connector_id': 'connector_id',
+                        'connector_service': 'connector_service',
+                        'org_id': 'org_id',
+                    },
+                    'location_map': {
+                        'connector_id': 'path',
+                        'connector_service': 'path',
+                        'org_id': 'query',
+                    },
+                    'collection_format_map': {
+                    }
+                },
+                headers_map={
+                    'accept': [
+                        'application/json'
+                    ],
+                    'content_type': [],
+                },
+                api_client=api_client,
+                callable=__get_service
+            )
+
         def __get_stats_config(
             self,
             connector_id,
@@ -5723,6 +6126,144 @@ class ConnectorsApi(object):
                 callable=__list_proxies
             )
 
+        def __list_services(
+            self,
+            connector_id,
+            **kwargs
+        ):
+            """Get all ConnectorServices for a connector_id  # noqa: E501
+
+            Get all ConnectorServices for a connector_id  # noqa: E501
+            This method makes a synchronous HTTP request by default. To make an
+            asynchronous HTTP request, please pass async_req=True
+
+            >>> thread = api.list_services(connector_id, async_req=True)
+            >>> result = thread.get()
+
+            Args:
+                connector_id (str): connector id path
+
+            Keyword Args:
+                org_id (str): Organisation Unique identifier. [optional]
+                limit (int): limit the number of rows in the response. [optional] if omitted the server will use the default value of 500
+                _return_http_data_only (bool): response data without head status
+                    code and headers. Default is True.
+                _preload_content (bool): if False, the urllib3.HTTPResponse object
+                    will be returned without reading/decoding response data.
+                    Default is True.
+                _request_timeout (float/tuple): timeout setting for this request. If one
+                    number provided, it will be total request timeout. It can also
+                    be a pair (tuple) of (connection, read) timeouts.
+                    Default is None.
+                _check_input_type (bool): specifies if type checking
+                    should be done one the data sent to the server.
+                    Default is True.
+                _check_return_type (bool): specifies if type checking
+                    should be done one the data received from the server.
+                    Default is True.
+                _host_index (int/None): specifies the index of the server
+                    that we want to use.
+                    Default is read from the configuration.
+                async_req (bool): execute request asynchronously
+
+            Returns:
+                ListConnectorServiceResponse
+                    If the method is called asynchronously, returns the request
+                    thread.
+            """
+            kwargs['async_req'] = kwargs.get(
+                'async_req', False
+            )
+            kwargs['_return_http_data_only'] = kwargs.get(
+                '_return_http_data_only', True
+            )
+            kwargs['_preload_content'] = kwargs.get(
+                '_preload_content', True
+            )
+            kwargs['_request_timeout'] = kwargs.get(
+                '_request_timeout', None
+            )
+            kwargs['_check_input_type'] = kwargs.get(
+                '_check_input_type', True
+            )
+            kwargs['_check_return_type'] = kwargs.get(
+                '_check_return_type', True
+            )
+            kwargs['_host_index'] = kwargs.get('_host_index')
+            kwargs['connector_id'] = \
+                connector_id
+            return self.call_with_http_info(**kwargs)
+
+        if self.list_services is None:
+            self.list_services = _Endpoint(
+                settings={
+                    'response_type': (ListConnectorServiceResponse,),
+                    'auth': [
+                        'token-valid'
+                    ],
+                    'endpoint_path': '/v1/connectors/{connector_id}/services',
+                    'operation_id': 'list_services',
+                    'http_method': 'GET',
+                    'servers': None,
+                },
+                params_map={
+                    'all': [
+                        'connector_id',
+                        'org_id',
+                        'limit',
+                    ],
+                    'required': [
+                        'connector_id',
+                    ],
+                    'nullable': [
+                    ],
+                    'enum': [
+                    ],
+                    'validation': [
+                        'limit',
+                    ]
+                },
+                root_map={
+                    'validations': {
+                        ('limit',): {
+
+                            'inclusive_maximum': 500,
+                            'inclusive_minimum': 1,
+                        },
+                    },
+                    'allowed_values': {
+                    },
+                    'openapi_types': {
+                        'connector_id':
+                            (str,),
+                        'org_id':
+                            (str,),
+                        'limit':
+                            (int,),
+                    },
+                    'attribute_map': {
+                        'connector_id': 'connector_id',
+                        'org_id': 'org_id',
+                        'limit': 'limit',
+                    },
+                    'location_map': {
+                        'connector_id': 'path',
+                        'org_id': 'query',
+                        'limit': 'query',
+                    },
+                    'collection_format_map': {
+                    }
+                },
+                headers_map={
+                    'accept': [
+                        'application/json'
+                    ],
+                    'content_type': [],
+                },
+                api_client=api_client,
+                callable=__list_services
+            )
+
         def __list_transfers(
             self,
             connector_id,
@@ -6956,6 +7497,7 @@ class ConnectorsApi(object):
     create_instance = None 
     create_ipsec_connector = None 
     create_queue = None 
+    create_service = None 
     create_transfer = None 
     delete_agent_connector = None 
     delete_connector = None 
@@ -6963,6 +7505,7 @@ class ConnectorsApi(object):
     delete_instance = None 
     delete_ipsec_connector = None 
     delete_proxy = None 
+    delete_service = None 
     delete_transfer = None 
     get_agent_connector = None 
     get_agent_connector_dynamic_stats = None 
@@ -6979,6 +7522,7 @@ class ConnectorsApi(object):
     get_ipsec_connector_info = None 
     get_proxy = None 
     get_queues = None 
+    get_service = None 
     get_stats_config = None 
     get_transfer = None 
     list_agent_connector = None 
@@ -6989,6 +7533,7 @@ class ConnectorsApi(object):
     list_instances = None 
     list_ipsec_connector = None 
     list_proxies = None 
+    list_services = None 
     list_transfers = None 
     replace_agent_connector = None 
     replace_agent_connector_local_auth_info = None