edgeimpulse-api 1.96.3__tar.gz → 1.96.4__tar.gz

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edgeimpulse-api
-Version: 1.96.3
+Version: 1.96.4
 Summary: Python bindings for the Edge Impulse API.
 Home-page: https://edgeimpulse.com
 License: BSD-3-Clause-Clear

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.96.3" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+__version__ = "1.96.4" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 
 # import apis into sdk package
 from edgeimpulse_api.api.classify_api import ClassifyApi
@@ -415,6 +415,8 @@ from edgeimpulse_api.models.get_csv_wizard_uploaded_file_info import GetCsvWizar
 from edgeimpulse_api.models.get_csv_wizard_uploaded_file_info_all_of import GetCsvWizardUploadedFileInfoAllOf
 from edgeimpulse_api.models.get_current_api_key_info_response import GetCurrentApiKeyInfoResponse
 from edgeimpulse_api.models.get_current_api_key_info_response_all_of import GetCurrentApiKeyInfoResponseAllOf
+from edgeimpulse_api.models.get_current_organization_api_key_info_response import GetCurrentOrganizationApiKeyInfoResponse
+from edgeimpulse_api.models.get_current_organization_api_key_info_response_all_of import GetCurrentOrganizationApiKeyInfoResponseAllOf
 from edgeimpulse_api.models.get_data_explorer_features_response import GetDataExplorerFeaturesResponse
 from edgeimpulse_api.models.get_data_explorer_features_response_all_of import GetDataExplorerFeaturesResponseAllOf
 from edgeimpulse_api.models.get_data_explorer_features_response_all_of_data import GetDataExplorerFeaturesResponseAllOfData

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/api/organizations_api.py

@@ -51,6 +51,7 @@ from edgeimpulse_api.models.enterprise_limits_increase_request import Enterprise
 from edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request import EnterpriseUpgradeOrTrialExtensionRequest
 from edgeimpulse_api.models.entity_created_response import EntityCreatedResponse
 from edgeimpulse_api.models.generic_api_response import GenericApiResponse
+from edgeimpulse_api.models.get_current_organization_api_key_info_response import GetCurrentOrganizationApiKeyInfoResponse
 from edgeimpulse_api.models.get_organization_data_export_response import GetOrganizationDataExportResponse
 from edgeimpulse_api.models.get_organization_data_exports_response import GetOrganizationDataExportsResponse
 from edgeimpulse_api.models.get_whitelabel_response import GetWhitelabelResponse
@@ -940,6 +941,139 @@ class OrganizationsApi(object):
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @validate_arguments
+    def get_current_organization_api_key_info(self, organization_id : Annotated[StrictInt, Field(..., description="Organization ID")], **kwargs) -> GetCurrentOrganizationApiKeyInfoResponse:  # noqa: E501
+        """Get info about current API key
+
+        Only available when authenticating with an organization API key. Returns the current role and organization ID that you're authenticated with.
+
+        :param organization_id: Organization ID (required)
+        :type organization_id: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: 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.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: GetCurrentOrganizationApiKeyInfoResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        return self._get_current_organization_api_key_info_with_http_info(organization_id, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def _get_current_organization_api_key_info_with_http_info(self, organization_id : Annotated[StrictInt, Field(..., description="Organization ID")], **kwargs):  # noqa: E501
+        """Get info about current API key
+
+        Only available when authenticating with an organization API key. Returns the current role and organization ID that you're authenticated with.
+
+        :param organization_id: Organization ID (required)
+        :type organization_id: int
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :type _return_http_data_only: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: 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.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(GetCurrentOrganizationApiKeyInfoResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'organization_id'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_current_organization_api_key_info" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['organization_id']:
+            _path_params['organizationId'] = _params['organization_id']
+
+        # process the query parameters
+        _query_params = []
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+
+        # process the form parameters
+        _form_params = []
+        _files = {}
+
+        # process the body parameter
+        _body_params = None
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['ApiKeyAuthentication', 'OAuth2', 'OAuth2', 'OAuth2', 'OAuth2', 'JWTAuthentication', 'JWTHttpHeaderAuthentication']  # noqa: E501
+
+        _response_types_map = {
+            '200': "GetCurrentOrganizationApiKeyInfoResponse",
+        }
+
+        return self.api_client.call_api(
+            '/api/organizations/{organizationId}/api-key-info', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @validate_arguments
     def get_organization_data_export(self, organization_id : Annotated[StrictInt, Field(..., description="Organization ID")], export_id : Annotated[StrictInt, Field(..., description="Export ID")], **kwargs) -> GetOrganizationDataExportResponse:  # noqa: E501
         """Get organization data export

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/models/__init__.py

@@ -374,6 +374,8 @@ from edgeimpulse_api.models.get_csv_wizard_uploaded_file_info import GetCsvWizar
 from edgeimpulse_api.models.get_csv_wizard_uploaded_file_info_all_of import GetCsvWizardUploadedFileInfoAllOf
 from edgeimpulse_api.models.get_current_api_key_info_response import GetCurrentApiKeyInfoResponse
 from edgeimpulse_api.models.get_current_api_key_info_response_all_of import GetCurrentApiKeyInfoResponseAllOf
+from edgeimpulse_api.models.get_current_organization_api_key_info_response import GetCurrentOrganizationApiKeyInfoResponse
+from edgeimpulse_api.models.get_current_organization_api_key_info_response_all_of import GetCurrentOrganizationApiKeyInfoResponseAllOf
 from edgeimpulse_api.models.get_data_explorer_features_response import GetDataExplorerFeaturesResponse
 from edgeimpulse_api.models.get_data_explorer_features_response_all_of import GetDataExplorerFeaturesResponseAllOf
 from edgeimpulse_api.models.get_data_explorer_features_response_all_of_data import GetDataExplorerFeaturesResponseAllOfData

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/models/add_organization_api_key_request.py

@@ -25,7 +25,8 @@ class AddOrganizationApiKeyRequest(BaseModel):
     api_key: Optional[StrictStr] = Field(None, alias="apiKey", description="Optional: API key. This needs to start with `ei_` and will need to be at least 32 characters long. If this field is not passed in, a new API key is generated for you.")
     role: StrictStr = ...
     ttl: Optional[StrictInt] = Field(None, description="Optional: time to live in seconds.")
-    __properties = ["name", "apiKey", "role", "ttl"]
+    organization_extension_id: Optional[StrictInt] = Field(None, alias="organizationExtensionId", description="Optional: organization extension ID when this API key is created for an organization extension.")
+    __properties = ["name", "apiKey", "role", "ttl", "organizationExtensionId"]
 
     @validator('role')
     def role_validate_enum(cls, v):
@@ -71,7 +72,8 @@ class AddOrganizationApiKeyRequest(BaseModel):
             "name": obj.get("name"),
             "api_key": obj.get("apiKey"),
             "role": obj.get("role"),
-            "ttl": obj.get("ttl")
+            "ttl": obj.get("ttl"),
+            "organization_extension_id": obj.get("organizationExtensionId")
         })
         return _obj
 

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/models/add_organization_api_key_request_all_of.py

@@ -23,7 +23,8 @@ from pydantic.v1 import BaseModel, Field, StrictInt, StrictStr, validator
 class AddOrganizationApiKeyRequestAllOf(BaseModel):
     role: StrictStr = ...
     ttl: Optional[StrictInt] = Field(None, description="Optional: time to live in seconds.")
-    __properties = ["role", "ttl"]
+    organization_extension_id: Optional[StrictInt] = Field(None, alias="organizationExtensionId", description="Optional: organization extension ID when this API key is created for an organization extension.")
+    __properties = ["role", "ttl", "organizationExtensionId"]
 
     @validator('role')
     def role_validate_enum(cls, v):
@@ -67,7 +68,8 @@ class AddOrganizationApiKeyRequestAllOf(BaseModel):
 
         _obj = AddOrganizationApiKeyRequestAllOf.construct(**{
             "role": obj.get("role"),
-            "ttl": obj.get("ttl")
+            "ttl": obj.get("ttl"),
+            "organization_extension_id": obj.get("organizationExtensionId")
         })
         return _obj
 

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/models/get_current_api_key_info_response.py

@@ -28,7 +28,8 @@ class GetCurrentApiKeyInfoResponse(BaseModel):
     project_id: StrictInt = Field(..., alias="projectId")
     role: ProjectApiKeyRole = ...
     expires: Optional[datetime] = Field(None, description="The expiration date of the API key. Only present when the key has a TTL set.")
-    __properties = ["success", "error", "apiKeyId", "projectId", "role", "expires"]
+    anonymous_user_id: Optional[StrictStr] = Field(None, alias="anonymousUserId", description="Only present when the API key was created for an extension. An anonymized, but stable ID for the user that granted the extension access. The ID is unique per extension (same across projects), and does not reveal any information about the user. Extensions can use this to keep sessions or per-user state. This matches the `anonymousUserId` query parameter that is passed to the extension.")
+    __properties = ["success", "error", "apiKeyId", "projectId", "role", "expires", "anonymousUserId"]
 
     class Config:
         allow_population_by_field_name = True
@@ -70,7 +71,8 @@ class GetCurrentApiKeyInfoResponse(BaseModel):
             "api_key_id": obj.get("apiKeyId"),
             "project_id": obj.get("projectId"),
             "role": obj.get("role"),
-            "expires": obj.get("expires")
+            "expires": obj.get("expires"),
+            "anonymous_user_id": obj.get("anonymousUserId")
         })
         return _obj
 

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/edgeimpulse_api/models/get_current_api_key_info_response_all_of.py

@@ -18,7 +18,7 @@ import json
 
 from datetime import datetime
 from typing import Optional
-from pydantic.v1 import BaseModel, Field, StrictInt
+from pydantic.v1 import BaseModel, Field, StrictInt, StrictStr
 from edgeimpulse_api.models.project_api_key_role import ProjectApiKeyRole
 
 class GetCurrentApiKeyInfoResponseAllOf(BaseModel):
@@ -26,7 +26,8 @@ class GetCurrentApiKeyInfoResponseAllOf(BaseModel):
     project_id: StrictInt = Field(..., alias="projectId")
     role: ProjectApiKeyRole = ...
     expires: Optional[datetime] = Field(None, description="The expiration date of the API key. Only present when the key has a TTL set.")
-    __properties = ["apiKeyId", "projectId", "role", "expires"]
+    anonymous_user_id: Optional[StrictStr] = Field(None, alias="anonymousUserId", description="Only present when the API key was created for an extension. An anonymized, but stable ID for the user that granted the extension access. The ID is unique per extension (same across projects), and does not reveal any information about the user. Extensions can use this to keep sessions or per-user state. This matches the `anonymousUserId` query parameter that is passed to the extension.")
+    __properties = ["apiKeyId", "projectId", "role", "expires", "anonymousUserId"]
 
     class Config:
         allow_population_by_field_name = True
@@ -66,7 +67,8 @@ class GetCurrentApiKeyInfoResponseAllOf(BaseModel):
             "api_key_id": obj.get("apiKeyId"),
             "project_id": obj.get("projectId"),
             "role": obj.get("role"),
-            "expires": obj.get("expires")
+            "expires": obj.get("expires"),
+            "anonymous_user_id": obj.get("anonymousUserId")
         })
         return _obj
 

edgeimpulse_api-1.96.4/edgeimpulse_api/models/get_current_organization_api_key_info_response.py

@@ -0,0 +1,83 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic.v1 import BaseModel, Field, StrictBool, StrictInt, StrictStr, validator
+
+class GetCurrentOrganizationApiKeyInfoResponse(BaseModel):
+    success: StrictBool = Field(..., description="Whether the operation succeeded")
+    error: Optional[StrictStr] = Field(None, description="Optional error description (set if 'success' was false)")
+    api_key_id: StrictInt = Field(..., alias="apiKeyId")
+    organization_id: StrictInt = Field(..., alias="organizationId")
+    role: StrictStr = ...
+    expires: Optional[datetime] = Field(None, description="The expiration date of the API key. Only present when the key has a TTL set.")
+    anonymous_user_id: Optional[StrictStr] = Field(None, alias="anonymousUserId", description="Only present when the API key was created for an organization extension. An anonymized, but stable ID for the user that granted the extension access. The ID is unique per extension, and does not reveal any information about the user. Extensions can use this to keep sessions or per-user state. This matches the `anonymousUserId` query parameter that is passed to the extension.")
+    __properties = ["success", "error", "apiKeyId", "organizationId", "role", "expires", "anonymousUserId"]
+
+    @validator('role')
+    def role_validate_enum(cls, v):
+        if v not in ('admin', 'member'):
+            raise ValueError("must validate the enum values ('admin', 'member')")
+        return v
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self,indent=None) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict(),indent=indent)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> GetCurrentOrganizationApiKeyInfoResponse:
+        """Create an instance of GetCurrentOrganizationApiKeyInfoResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> GetCurrentOrganizationApiKeyInfoResponse:
+        """Create an instance of GetCurrentOrganizationApiKeyInfoResponse from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return GetCurrentOrganizationApiKeyInfoResponse.construct(**obj)
+
+        _obj = GetCurrentOrganizationApiKeyInfoResponse.construct(**{
+            "success": obj.get("success"),
+            "error": obj.get("error"),
+            "api_key_id": obj.get("apiKeyId"),
+            "organization_id": obj.get("organizationId"),
+            "role": obj.get("role"),
+            "expires": obj.get("expires"),
+            "anonymous_user_id": obj.get("anonymousUserId")
+        })
+        return _obj
+

edgeimpulse_api-1.96.4/edgeimpulse_api/models/get_current_organization_api_key_info_response_all_of.py

@@ -0,0 +1,79 @@
+# coding: utf-8
+
+"""
+    Edge Impulse API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic.v1 import BaseModel, Field, StrictInt, StrictStr, validator
+
+class GetCurrentOrganizationApiKeyInfoResponseAllOf(BaseModel):
+    api_key_id: StrictInt = Field(..., alias="apiKeyId")
+    organization_id: StrictInt = Field(..., alias="organizationId")
+    role: StrictStr = ...
+    expires: Optional[datetime] = Field(None, description="The expiration date of the API key. Only present when the key has a TTL set.")
+    anonymous_user_id: Optional[StrictStr] = Field(None, alias="anonymousUserId", description="Only present when the API key was created for an organization extension. An anonymized, but stable ID for the user that granted the extension access. The ID is unique per extension, and does not reveal any information about the user. Extensions can use this to keep sessions or per-user state. This matches the `anonymousUserId` query parameter that is passed to the extension.")
+    __properties = ["apiKeyId", "organizationId", "role", "expires", "anonymousUserId"]
+
+    @validator('role')
+    def role_validate_enum(cls, v):
+        if v not in ('admin', 'member'):
+            raise ValueError("must validate the enum values ('admin', 'member')")
+        return v
+
+    class Config:
+        allow_population_by_field_name = True
+        validate_assignment = False
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self,indent=None) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict(),indent=indent)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> GetCurrentOrganizationApiKeyInfoResponseAllOf:
+        """Create an instance of GetCurrentOrganizationApiKeyInfoResponseAllOf from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> GetCurrentOrganizationApiKeyInfoResponseAllOf:
+        """Create an instance of GetCurrentOrganizationApiKeyInfoResponseAllOf from a dict"""
+        if obj is None:
+            return None
+
+        if type(obj) is not dict:
+            return GetCurrentOrganizationApiKeyInfoResponseAllOf.construct(**obj)
+
+        _obj = GetCurrentOrganizationApiKeyInfoResponseAllOf.construct(**{
+            "api_key_id": obj.get("apiKeyId"),
+            "organization_id": obj.get("organizationId"),
+            "role": obj.get("role"),
+            "expires": obj.get("expires"),
+            "anonymous_user_id": obj.get("anonymousUserId")
+        })
+        return _obj
+

{edgeimpulse_api-1.96.3 → edgeimpulse_api-1.96.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "edgeimpulse-api"
-version = "1.96.3" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+version = "1.96.4" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 description = "Python bindings for the Edge Impulse API."
 authors = ["EdgeImpulse Inc. <hello@edgeimpulse.com>"]
 license = "BSD-3-Clause-Clear"