feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 25
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-7002d4e40fb0a8dc4454b7f72f86d6068245cb367ddf7c784f00e35f6f75de1f.yml
-openapi_spec_hash: da6f7b8ab297306b97ed9fe8df9ad1a0
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-b84f53b1a92511eff85645f287ec08d43adcdcc589367c015770bde836422a65.yml
+openapi_spec_hash: 71e317da7bc58cfc3bc2e4180f5b6267
 config_hash: f86a4e06ae5ed725aa79d58d7a8dc27c

src/context/dev/types/ai_ai_query_response.py

@@ -4,7 +4,7 @@
 
 from .._models import BaseModel
 
-__all__ = ["AIAIQueryResponse", "DataExtracted"]
+__all__ = ["AIAIQueryResponse", "DataExtracted", "KeyMetadata"]
 
 
 class DataExtracted(BaseModel):
@@ -19,13 +19,33 @@ class DataExtracted(BaseModel):
     """
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class AIAIQueryResponse(BaseModel):
     data_extracted: Optional[List[DataExtracted]] = None
     """Array of extracted data points"""
 
     domain: Optional[str] = None
     """The domain that was analyzed"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""
 

src/context/dev/types/ai_extract_product_response.py

@@ -5,7 +5,20 @@
 
 from .._models import BaseModel
 
-__all__ = ["AIExtractProductResponse", "Product"]
+__all__ = ["AIExtractProductResponse", "KeyMetadata", "Product"]
+
+
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
 
 
 class Product(BaseModel):
@@ -58,6 +71,13 @@ class AIExtractProductResponse(BaseModel):
     is_product_page: Optional[bool] = None
     """Whether the given URL is a product detail page"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     platform: Optional[Literal["amazon", "tiktok_shop", "etsy", "generic"]] = None
     """The detected ecommerce platform, or null if not a product page"""
 

src/context/dev/types/ai_extract_products_response.py

@@ -5,7 +5,20 @@
 
 from .._models import BaseModel
 
-__all__ = ["AIExtractProductsResponse", "Product"]
+__all__ = ["AIExtractProductsResponse", "KeyMetadata", "Product"]
+
+
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
 
 
 class Product(BaseModel):
@@ -53,5 +66,12 @@ class Product(BaseModel):
 
 
 class AIExtractProductsResponse(BaseModel):
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     products: Optional[List[Product]] = None
     """Array of products extracted from the website"""

src/context/dev/types/brand_identify_from_transaction_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandIdentifyFromTransactionResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""

src/context/dev/types/brand_retrieve_by_email_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandRetrieveByEmailResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""

src/context/dev/types/brand_retrieve_by_isin_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandRetrieveByIsinResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""

src/context/dev/types/brand_retrieve_by_name_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandRetrieveByNameResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""

src/context/dev/types/brand_retrieve_by_ticker_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandRetrieveByTickerResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""

src/context/dev/types/brand_retrieve_response.py

@@ -21,6 +21,7 @@
     "BrandLogoResolution",
     "BrandSocial",
     "BrandStock",
+    "KeyMetadata",
 ]
 
 
@@ -650,12 +651,32 @@ class Brand(BaseModel):
     """The title or name of the brand"""
 
 
+class KeyMetadata(BaseModel):
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the response status is not 200.
+    """
+
+    credits_consumed: int
+    """The number of credits consumed by this request."""
+
+    credits_remaining: int
+    """The number of credits remaining for your organization after this request."""
+
+
 class BrandRetrieveResponse(BaseModel):
     brand: Optional[Brand] = None
     """Detailed brand information"""
 
     code: Optional[int] = None
     """HTTP status code"""
 
+    key_metadata: Optional[KeyMetadata] = None
+    """Metadata about the API key used for the request.
+
+    Included in every response whenever a valid API key is provided, even when the
+    response status is not 200.
+    """
+
     status: Optional[str] = None
     """Status of the response, e.g., 'ok'"""