mixpeek 0.13.3__tar.gz → 0.15.0__tar.gz

{mixpeek-0.13.3 → mixpeek-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mixpeek
-Version: 0.13.3
+Version: 0.15.0
 Summary: Python Client SDK Generated by Speakeasy.
 Home-page: https://github.com/mixpeek/python-sdk.git
 Author: Speakeasy
@@ -38,6 +38,7 @@ Mixpeek API: This is the Mixpeek API, providing access to various endpoints for
   * [SDK Installation](https://github.com/mixpeek/python-sdk/blob/master/#sdk-installation)
   * [IDE Support](https://github.com/mixpeek/python-sdk/blob/master/#ide-support)
   * [SDK Example Usage](https://github.com/mixpeek/python-sdk/blob/master/#sdk-example-usage)
+  * [Authentication](https://github.com/mixpeek/python-sdk/blob/master/#authentication)
   * [Available Resources and Operations](https://github.com/mixpeek/python-sdk/blob/master/#available-resources-and-operations)
   * [Retries](https://github.com/mixpeek/python-sdk/blob/master/#retries)
   * [Error Handling](https://github.com/mixpeek/python-sdk/blob/master/#error-handling)
@@ -90,8 +91,11 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 ```python
 # Synchronous Example
 from mixpeek import Mixpeek
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
 
     res = mixpeek.organizations.get()
 
@@ -106,9 +110,12 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from mixpeek import Mixpeek
+import os
 
 async def main():
-    async with Mixpeek() as mixpeek:
+    async with Mixpeek(
+        token=os.getenv("MIXPEEK_TOKEN", ""),
+    ) as mixpeek:
 
         res = await mixpeek.organizations.get_async()
 
@@ -119,6 +126,34 @@ asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name    | Type | Scheme      | Environment Variable |
+| ------- | ---- | ----------- | -------------------- |
+| `token` | http | HTTP Bearer | `MIXPEEK_TOKEN`      |
+
+To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
+```python
+from mixpeek import Mixpeek
+import os
+
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
+
+    res = mixpeek.organizations.get()
+
+    # Handle response
+    print(res)
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -213,8 +248,11 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from mixpeek import Mixpeek
 from mixpeek.utils import BackoffStrategy, RetryConfig
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
 
     res = mixpeek.organizations.get(,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
@@ -228,9 +266,11 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from mixpeek import Mixpeek
 from mixpeek.utils import BackoffStrategy, RetryConfig
+import os
 
 with Mixpeek(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
+    token=os.getenv("MIXPEEK_TOKEN", ""),
 ) as mixpeek:
 
     res = mixpeek.organizations.get()
@@ -267,8 +307,11 @@ When custom error responses are specified for an operation, the SDK may also rai
 
 ```python
 from mixpeek import Mixpeek, models
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
     res = None
     try:
 
@@ -297,9 +340,11 @@ with Mixpeek() as mixpeek:
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from mixpeek import Mixpeek
+import os
 
 with Mixpeek(
     server_url="https://api.mixpeek.com/",
+    token=os.getenv("MIXPEEK_TOKEN", ""),
 ) as mixpeek:
 
     res = mixpeek.organizations.get()

{mixpeek-0.13.3 → mixpeek-0.15.0}/README-PYPI.md

@@ -15,6 +15,7 @@ Mixpeek API: This is the Mixpeek API, providing access to various endpoints for
   * [SDK Installation](https://github.com/mixpeek/python-sdk/blob/master/#sdk-installation)
   * [IDE Support](https://github.com/mixpeek/python-sdk/blob/master/#ide-support)
   * [SDK Example Usage](https://github.com/mixpeek/python-sdk/blob/master/#sdk-example-usage)
+  * [Authentication](https://github.com/mixpeek/python-sdk/blob/master/#authentication)
   * [Available Resources and Operations](https://github.com/mixpeek/python-sdk/blob/master/#available-resources-and-operations)
   * [Retries](https://github.com/mixpeek/python-sdk/blob/master/#retries)
   * [Error Handling](https://github.com/mixpeek/python-sdk/blob/master/#error-handling)
@@ -67,8 +68,11 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 ```python
 # Synchronous Example
 from mixpeek import Mixpeek
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
 
     res = mixpeek.organizations.get()
 
@@ -83,9 +87,12 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from mixpeek import Mixpeek
+import os
 
 async def main():
-    async with Mixpeek() as mixpeek:
+    async with Mixpeek(
+        token=os.getenv("MIXPEEK_TOKEN", ""),
+    ) as mixpeek:
 
         res = await mixpeek.organizations.get_async()
 
@@ -96,6 +103,34 @@ asyncio.run(main())
 ```
 <!-- End SDK Example Usage [usage] -->
 
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name    | Type | Scheme      | Environment Variable |
+| ------- | ---- | ----------- | -------------------- |
+| `token` | http | HTTP Bearer | `MIXPEEK_TOKEN`      |
+
+To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
+```python
+from mixpeek import Mixpeek
+import os
+
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
+
+    res = mixpeek.organizations.get()
+
+    # Handle response
+    print(res)
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -190,8 +225,11 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from mixpeek import Mixpeek
 from mixpeek.utils import BackoffStrategy, RetryConfig
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
 
     res = mixpeek.organizations.get(,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
@@ -205,9 +243,11 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from mixpeek import Mixpeek
 from mixpeek.utils import BackoffStrategy, RetryConfig
+import os
 
 with Mixpeek(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
+    token=os.getenv("MIXPEEK_TOKEN", ""),
 ) as mixpeek:
 
     res = mixpeek.organizations.get()
@@ -244,8 +284,11 @@ When custom error responses are specified for an operation, the SDK may also rai
 
 ```python
 from mixpeek import Mixpeek, models
+import os
 
-with Mixpeek() as mixpeek:
+with Mixpeek(
+    token=os.getenv("MIXPEEK_TOKEN", ""),
+) as mixpeek:
     res = None
     try:
 
@@ -274,9 +317,11 @@ with Mixpeek() as mixpeek:
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from mixpeek import Mixpeek
+import os
 
 with Mixpeek(
     server_url="https://api.mixpeek.com/",
+    token=os.getenv("MIXPEEK_TOKEN", ""),
 ) as mixpeek:
 
     res = mixpeek.organizations.get()

{mixpeek-0.13.3 → mixpeek-0.15.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mixpeek"
-version = "0.13.3"
+version = "0.15.0"
 description = "Python Client SDK Generated by Speakeasy."
 authors = ["Speakeasy",]
 readme = "README-PYPI.md"

{mixpeek-0.13.3 → mixpeek-0.15.0}/src/mixpeek/_version.py

@@ -3,7 +3,7 @@
 import importlib.metadata
 
 __title__: str = "mixpeek"
-__version__: str = "0.13.3"
+__version__: str = "0.15.0"
 
 try:
     if __package__ is not None:

{mixpeek-0.13.3 → mixpeek-0.15.0}/src/mixpeek/assets.py

@@ -4,6 +4,7 @@ from .basesdk import BaseSDK
 from mixpeek import models, utils
 from mixpeek._hooks import HookContext
 from mixpeek.types import OptionalNullable, UNSET
+from mixpeek.utils import get_security_from_env
 from typing import Any, List, Mapping, Optional, Union
 
 
@@ -57,6 +58,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -72,7 +74,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="get_asset_assets__asset_id__get",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -154,6 +158,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -169,7 +174,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="get_asset_assets__asset_id__get",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -242,10 +249,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=False,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -261,7 +269,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="delete_asset_assets__asset_id__delete",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -334,10 +344,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=False,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -353,7 +364,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="delete_asset_assets__asset_id__delete",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -441,10 +454,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.update_asset_request,
                 False,
@@ -467,7 +481,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="full_asset_update_assets__asset_id__put",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -555,10 +571,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.update_asset_request,
                 False,
@@ -581,7 +598,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="full_asset_update_assets__asset_id__put",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -669,10 +688,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.update_asset_request,
                 False,
@@ -695,7 +715,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="partial_asset_update_assets__asset_id__patch",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -783,10 +805,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=True,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.update_asset_request,
                 False,
@@ -809,7 +832,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="partial_asset_update_assets__asset_id__patch",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -891,6 +916,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -906,7 +932,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="get_asset_with_features_assets__asset_id__features_get",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -988,6 +1016,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             timeout_ms=timeout_ms,
         )
 
@@ -1003,7 +1032,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="get_asset_with_features_assets__asset_id__features_get",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -1115,6 +1146,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.list_assets_request,
                 False,
@@ -1137,7 +1169,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="list_assets_assets_post",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -1249,6 +1283,7 @@ class Assets(BaseSDK):
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.list_assets_request,
                 False,
@@ -1271,7 +1306,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="list_assets_assets_post",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -1373,10 +1410,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=False,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.search_assets_request,
                 False,
@@ -1399,7 +1437,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="search_assets_assets_search_post",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
@@ -1501,10 +1541,11 @@ class Assets(BaseSDK):
             request=request,
             request_body_required=True,
             request_has_path_params=False,
-            request_has_query_params=False,
+            request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.search_assets_request,
                 False,
@@ -1527,7 +1568,9 @@ class Assets(BaseSDK):
             hook_ctx=HookContext(
                 operation_id="search_assets_assets_search_post",
                 oauth2_scopes=[],
-                security_source=None,
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
             ),
             request=req,
             error_status_codes=["400", "401", "403", "404", "422", "4XX", "500", "5XX"],

{mixpeek-0.13.3 → mixpeek-0.15.0}/src/mixpeek/basesdk.py

@@ -161,7 +161,7 @@ class BaseSDK:
         if security is not None:
             if callable(security):
                 security = security()
-
+        security = utils.get_security_from_env(security, models.Security)
         if security is not None:
             security_headers, security_query_params = utils.get_security(security)
             headers = {**headers, **security_headers}