mixpeek 0.13.2__py3-none-any.whl → 0.14.0__py3-none-any.whl

{mixpeek-0.13.2.dist-info → mixpeek-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mixpeek
-Version: 0.13.2
+Version: 0.14.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,10 +91,13 @@ 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(
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
+) as mixpeek:
 
-    res = mixpeek.debug_openapi_debug_openapi_get()
+    res = mixpeek.organizations.get()
 
     # Handle response
     print(res)
@@ -106,11 +110,14 @@ 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(
+        bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
+    ) as mixpeek:
 
-        res = await mixpeek.debug_openapi_debug_openapi_get_async()
+        res = await mixpeek.organizations.get_async()
 
         # Handle response
         print(res)
@@ -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  |
+| ------------- | ---- | ----------- | --------------------- |
+| `bearer_auth` | http | HTTP Bearer | `MIXPEEK_BEARER_AUTH` |
+
+To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
+```python
+from mixpeek import Mixpeek
+import os
+
+with Mixpeek(
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
+) as mixpeek:
+
+    res = mixpeek.organizations.get()
+
+    # Handle response
+    print(res)
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -169,9 +204,6 @@ asyncio.run(main())
 
 * [list](https://github.com/mixpeek/python-sdk/blob/master/docs/sdks/interactions/README.md#list) - List Interactions
 
-### [Mixpeek SDK](https://github.com/mixpeek/python-sdk/blob/master/docs/sdks/mixpeek/README.md)
-
-* [debug_openapi_debug_openapi_get](https://github.com/mixpeek/python-sdk/blob/master/docs/sdks/mixpeek/README.md#debug_openapi_debug_openapi_get) - Debug Openapi
 
 ### [namespaces](https://github.com/mixpeek/python-sdk/blob/master/docs/sdks/namespaces/README.md)
 
@@ -216,10 +248,13 @@ 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(
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
+) as mixpeek:
 
-    res = mixpeek.debug_openapi_debug_openapi_get(,
+    res = mixpeek.organizations.get(,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -231,12 +266,14 @@ 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),
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
 ) as mixpeek:
 
-    res = mixpeek.debug_openapi_debug_openapi_get()
+    res = mixpeek.organizations.get()
 
     # Handle response
     print(res)
@@ -270,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(
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
+) as mixpeek:
     res = None
     try:
 
@@ -300,12 +340,14 @@ 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/",
+    bearer_auth=os.getenv("MIXPEEK_BEARER_AUTH", ""),
 ) as mixpeek:
 
-    res = mixpeek.debug_openapi_debug_openapi_get()
+    res = mixpeek.organizations.get()
 
     # Handle response
     print(res)

{mixpeek-0.13.2.dist-info → mixpeek-0.14.0.dist-info}/RECORD

@@ -4,17 +4,17 @@ mixpeek/_hooks/__init__.py,sha256=9_7W5jAYw8rcO8Kfc-Ty-lB82BHfksAJJpVFb_UeU1c,14
 mixpeek/_hooks/registration.py,sha256=1QZB41w6If7I9dXiOSQx6dhSc6BPWrnI5Q5bMOr4iVA,624
 mixpeek/_hooks/sdkhooks.py,sha256=NMqSNr_PmeJuQgXFEntPJElH9a6yfdyvwEQFH0TrunI,2557
 mixpeek/_hooks/types.py,sha256=Qh9pO5ndynMrWpMLPkJUsOmAJ1AJHntJAXb5Yxe_a4o,2568
-mixpeek/_version.py,sha256=4YQR_unUxW-QDYPW6Ffy2ujxAlJIIKFrV2oU_QUspP4,312
-mixpeek/assets.py,sha256=gsk0ooJ23drWDZpaQSxL0ywhqyuPbZDHlIZRcXQltrc,66564
-mixpeek/basesdk.py,sha256=fxyrXntRtoPrRE5iko9Rq1GrhBCk25LTAz-nU4rJSdo,11903
-mixpeek/collections.py,sha256=OX2dxpTxeFIwcFwPfis676cmi9rQtUX4qopQKdtqnfs,42737
-mixpeek/featureextractors.py,sha256=Ie1ojxBHXmpxaGS2-RS34sS1w_H-D6_f5-wO-CoWtU0,8322
-mixpeek/features.py,sha256=OM3qpDmcQXdx_7YeelJTaADqVNlpEp9q-xlmutgRcqs,52388
-mixpeek/health.py,sha256=xJkViQaznlRpeAFxgtczAHqJUaGOxVCNq4hEQTo14-0,6521
+mixpeek/_version.py,sha256=2uDSIFYmRDfo5SZ95N0fOJ5UpKgo-Tp7mPg6vnQGvM0,312
+mixpeek/assets.py,sha256=FxsU6meCiGYKWPwFWT_67UJO4XwSg1vgY2QMSyspNfA,68830
+mixpeek/basesdk.py,sha256=j_PZqE6WgIfx1cPCK5gAVn-rgPy9iLhUN5ELtefoEU0,11976
+mixpeek/collections.py,sha256=HXgrieJfXHmdG88t_no0A35Jt66X19hT0zUdGL49XiU,44367
+mixpeek/featureextractors.py,sha256=vhBNENPiR38RhBsqQqTyE-xpjw5RFaPGbowwRIFUcog,8686
+mixpeek/features.py,sha256=N-q-YJX9_lw3-jz-fb8_gVyRiyJaguITXv1xEs9Rdek,54022
+mixpeek/health.py,sha256=77BbCPfMkuuLSJdIG89lual5PhnT_LqXzFVQDKemEi0,6885
 mixpeek/httpclient.py,sha256=WDbLpMzo7qmWki_ryOJcCAYNI1T4uyWKV08rRuCdNII,2688
-mixpeek/ingest.py,sha256=KFCP0sT7wCOICE-UluGwbNDRRuh_aDKSJliJWTcj7Os,38598
-mixpeek/interactions.py,sha256=R9KYMosXgR-pvraY8uUNFU1GcI7VrOv6ojLFXZQ1V68,9099
-mixpeek/models/__init__.py,sha256=iyzCKB7JLP4pzCkwvGY7gr3PTFaNoXOc4NXjZOW8x3w,27628
+mixpeek/ingest.py,sha256=x0FlcLe7QNIoDaTjh1RJ-4FRzt8KqzzFFUrhPUK763U,39594
+mixpeek/interactions.py,sha256=LlOUg8PvNkWulit4G9CFe6Rz1H4I4jeHI0p8_qjEY-g,9465
+mixpeek/models/__init__.py,sha256=GZlLWl-zo4kSoV7H3pR6vXxBmNk_E_D1aJGrFuRTcrc,27780
 mixpeek/models/actionusage.py,sha256=WAnnBVTeQ9j0dtIrubfyyJQwbBamxManfS8fc2OFNyo,324
 mixpeek/models/apierror.py,sha256=9mTyJSyvUAOnSfW_1HWt9dGl8IDlpQ68DebwYsDNdug,528
 mixpeek/models/apikey.py,sha256=P99SWsu6wgc6HStE2MteANIGShUkM2dwQnbQvdg5AOc,654
@@ -47,8 +47,8 @@ mixpeek/models/delete_user_organizations_users_user_email_deleteop.py,sha256=pwx
 mixpeek/models/denseembedding.py,sha256=ECX8Nwo6tD8Qm1WxGPGOy4H8WYLQ6q6VKqbnanT3vlA,413
 mixpeek/models/embeddingrequest.py,sha256=9Bk67IV1nr-d_UkTXkkL2e2o8Kv-YOHR0O3clHPGVHk,2092
 mixpeek/models/embeddingresponse.py,sha256=1H6OWwIIO0ktqhmK0mIGdo3Bqv8saM7jFaFlljEZL1g,2223
-mixpeek/models/errormessage.py,sha256=BmuIq7QHoCI9VB9QC3t5c6ZxfzK0ORT2sB5F0un1O0c,285
-mixpeek/models/errorresponse.py,sha256=-lq07ro9LmnxAZjBLsMmkXvBhLQeCOWnI8jSwf26dck,554
+mixpeek/models/errordetail.py,sha256=j7QNqtNrAHjznF8F-eBuxwEedFhYIqP5YKOyX8dSlcg,1510
+mixpeek/models/errorresponse.py,sha256=YIbCFc44szh_OIUoQ3BByHWouYwa2Tqedm9NJcrNvyQ,582
 mixpeek/models/facedetectsettings.py,sha256=mU78KWd0x1Uy_8FqyWSWPPJcDbwFhxIcAc1RJeR8uL4,1710
 mixpeek/models/featureextractionembeddingrequest.py,sha256=fB2P7kPMKu1YSF9S8DgVlmdpcvxfcGsv4-Q8dlo64Jk,1764
 mixpeek/models/featureresponse.py,sha256=eWsnn1FSccueE9UZOSxVOH_4IimfuKbbsS1bKNPvJhs,2521
@@ -123,6 +123,7 @@ mixpeek/models/searchinteraction.py,sha256=2X7aVM6Uoknv6mU1rZlUV9oUmDD1rTkDTXCY7
 mixpeek/models/searchquery_output.py,sha256=c7Ar09TanSqoLfLl-PeLcSCXpwUW9G-dm_TS8xPrhPw,2617
 mixpeek/models/searchrequestfeatures_input.py,sha256=kQE7EPFU3yYXJ6kX2VB7Rz9_Y7eFzgkfooKeFxZvxmA,5769
 mixpeek/models/searchrequestfeatures_output.py,sha256=s044mekxr7OF68sco7OvRALMt-w6scwbGHIm12wtVXs,5724
+mixpeek/models/security.py,sha256=KndEoU3C-m7MnQHfXap3lvs4Qp_46e4O-0bzjYcJlx0,690
 mixpeek/models/sortoption.py,sha256=3_cJW0A9vt8INQowzJ_kZtmYT1mlBNy-__f-tvLiC3Q,639
 mixpeek/models/sparseembedding.py,sha256=-nXJSRELVSQqTyXAPYA4swPKBscLdljq9vH4N91Yz7A,530
 mixpeek/models/tasks_model_taskresponse.py,sha256=oyO5jpGPk9UEDS-gyZ6VGqjZrLUcYto_ODMzwvT_Z8o,516
@@ -147,16 +148,16 @@ mixpeek/models/videodetectsettings.py,sha256=3l8pOw2USpDQIyPX27yStSPkrgLADPY9wHd
 mixpeek/models/videoreadsettings.py,sha256=3ZmqiQk_SRrylAMHX30PtJuUqgu_u5AwbZEOwfyZ4mM,2409
 mixpeek/models/videosettings.py,sha256=bQe2vWYyaT0DSyELL49XqrcJIPyD0g8JgBaG7McOwSA,4094
 mixpeek/models/videotranscriptionsettings.py,sha256=eIrlsSw5AUA9uE98bXvfIoitK5nu6ppq7412YQWQqtk,2453
-mixpeek/namespaces.py,sha256=22JiWMVxJkNIhJSwyDffPZ9vF8LVuPAYojqNnNCvukg,46270
-mixpeek/organizations.py,sha256=QaP1Tu2sQWEaGB7ORK1uT-xuG9IQAfVSgLX5ZmbEjUM,59889
+mixpeek/namespaces.py,sha256=V4GZu9ueay3bw_Rlofo0figPDUPfML4XAZudRmYtEjQ,48214
+mixpeek/organizations.py,sha256=JcnABmWBzvQn8uto9XlNg_NsbzKkFUr3RJoloTY_aXQ,62467
 mixpeek/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
-mixpeek/sdk.py,sha256=HZ-ZQUQr7rnAnyKNZ60D3CaUWV4eMjaTs2IPh6AsesY,10741
-mixpeek/sdkconfiguration.py,sha256=Y-sCAxQ0JtEg9exvfuZC2ATWcGPNwSgnSucEpjP9Rh4,1406
-mixpeek/searchinteractions.py,sha256=gO1lk0y28cLuRT6VSprw0dGOBkWryB1fGSqGLzbd00I,27156
-mixpeek/tasks.py,sha256=AFaqwIhbaI1qItnwW-AJhfLCYEWy8FzSx6dTZXaZyPc,15852
+mixpeek/sdk.py,sha256=h1kSnRLMyKciHehOXJHSPrGDv1b7quk_CuR-HglPwMM,5617
+mixpeek/sdkconfiguration.py,sha256=GQbUnA-vkjh_U-6Q4s3_F6yN1bWj-h01AZjiP0xtNS0,1535
+mixpeek/searchinteractions.py,sha256=g-0QxU0Wi_IaMvT6n7OM2Cryr_vtQZzZ3HZpBl6AG0I,28152
+mixpeek/tasks.py,sha256=lvDpvaP_vIpYltWWuXxeAZtOJXC68Sroh9OgYIT6u5A,16532
 mixpeek/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
 mixpeek/types/basemodel.py,sha256=PexI39iKiOkIlobB8Ueo0yn8PLHp6_wb-WO-zelNDZY,1170
-mixpeek/utils/__init__.py,sha256=1x4KfQf2ULtO_aOk_M2RMCimoz8jgcW0RZd-f34KDAs,2365
+mixpeek/utils/__init__.py,sha256=8npwwHS-7zjVrbkzBGO-Uk4GkjC240PCleMbgPK1Axs,2418
 mixpeek/utils/annotations.py,sha256=aR7mZG34FzgRdew7WZPYEu9QGBerpuKxCF4sek5Z_5Y,1699
 mixpeek/utils/enums.py,sha256=VzjeslROrAr2luZOTJlvu-4UlxgTaGOKlRYtJJ7IfyY,1006
 mixpeek/utils/eventstreaming.py,sha256=LtcrfJYw4nP2Oe4Wl0-cEURLzRGYReRGWNFY5wYECIE,6186
@@ -167,10 +168,10 @@ mixpeek/utils/metadata.py,sha256=Per2KFXXOqOtoUWXrlIfjrSrBg199KrRW0nKQDgHIBU,313
 mixpeek/utils/queryparams.py,sha256=MTK6inMS1_WwjmMJEJmAn67tSHHJyarpdGRlorRHEtI,5899
 mixpeek/utils/requestbodies.py,sha256=ySjEyjcLi731LNUahWvLOrES2HihuA8VrOJx4eQ7Qzg,2101
 mixpeek/utils/retries.py,sha256=6yhfZifqIat9i76xF0lTR2jLj1IN9BNGyqqxATlEFPU,6348
-mixpeek/utils/security.py,sha256=ktep3HKwbFs-MLxUYTM8Jd4v-ZBum5_Z0u1PFIdYBX0,5516
+mixpeek/utils/security.py,sha256=3mF13Je002bp6DvX_HTNiw9maMpX-8EY_Eb2s9SYO0U,6020
 mixpeek/utils/serializers.py,sha256=BSJT7kBOkNBFyP7KREyMoe14JGbgijD1M6AXFMbdmco,4924
 mixpeek/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
 mixpeek/utils/values.py,sha256=_89YXPTI_BU6SXJBzFR4pIzTCBPQW9tsOTN1jeBBIDs,3428
-mixpeek-0.13.2.dist-info/METADATA,sha256=4u_Yh1xznee2lI1C-0NBa5kwdD1AQs-cB1grv9kDq7Y,18871
-mixpeek-0.13.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-mixpeek-0.13.2.dist-info/RECORD,,
+mixpeek-0.14.0.dist-info/METADATA,sha256=Rh1V10nKcCBhckJXfM0ZLcQAdYMm29xRwU2LUubAQNk,19744
+mixpeek-0.14.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+mixpeek-0.14.0.dist-info/RECORD,,

mixpeek/models/errormessage.py

@@ -1,13 +0,0 @@
-"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
-
-from __future__ import annotations
-from mixpeek.types import BaseModel
-from typing_extensions import TypedDict
-
-
-class ErrorMessageTypedDict(TypedDict):
-    msg: str
-
-
-class ErrorMessage(BaseModel):
-    msg: str