stract-api 0.1.0__py3-none-any.whl

stract_api/exceptions.py

@@ -0,0 +1,219 @@
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

stract_api/models/__init__.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from stract_api.models.account import Account
+from stract_api.models.account_credit_cache import AccountCreditCache
+from stract_api.models.account_credit_ledger import AccountCreditLedger
+from stract_api.models.account_user import AccountUser
+from stract_api.models.account_user_role import AccountUserRole
+from stract_api.models.api_key import ApiKey
+from stract_api.models.catalog import Catalog
+from stract_api.models.create_account_user_request import CreateAccountUserRequest
+from stract_api.models.create_catalog_request import CreateCatalogRequest
+from stract_api.models.create_field_request import CreateFieldRequest
+from stract_api.models.create_job_request import CreateJobRequest
+from stract_api.models.create_struct_request import CreateStructRequest
+from stract_api.models.deleted_document import DeletedDocument
+from stract_api.models.deleted_field import DeletedField
+from stract_api.models.document import Document
+from stract_api.models.document_link import DocumentLink
+from stract_api.models.document_processing_status import DocumentProcessingStatus
+from stract_api.models.document_text import DocumentText
+from stract_api.models.edit_account_request import EditAccountRequest
+from stract_api.models.edit_field_request import EditFieldRequest
+from stract_api.models.edit_my_user_request import EditMyUserRequest
+from stract_api.models.field_type import FieldType
+from stract_api.models.job import Job
+from stract_api.models.job_document import JobDocument
+from stract_api.models.job_output import JobOutput
+from stract_api.models.job_output_record import JobOutputRecord
+from stract_api.models.job_status import JobStatus
+from stract_api.models.llm_model import LlmModel
+from stract_api.models.login_request import LoginRequest
+from stract_api.models.login_response import LoginResponse
+from stract_api.models.model_field import ModelField
+from stract_api.models.struct import Struct
+from stract_api.models.sync_text_job_request import SyncTextJobRequest
+from stract_api.models.upload_text_document_request import UploadTextDocumentRequest
+from stract_api.models.user import User
+

stract_api/models/account.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
+from stract_api.models.account_user_role import AccountUserRole
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class Account(BaseModel):
+    """
+    Account
+    """ # noqa: E501
+    id: UUID = Field(description="Unique identifier of the account")
+    name: StrictStr = Field(description="Name of the account")
+    date_created: date = Field(description="Date when the account was created")
+    account_user_role: AccountUserRole
+    subscription_type: Optional[StrictStr] = Field(description="The account's active subscription type, or null if the account has no active subscription")
+    subscription_dt_started: Optional[datetime] = Field(description="Timestamp when the account's active subscription started, or null if the account has no active subscription")
+    subscription_billing_period_end: Optional[datetime] = Field(description="Timestamp when the account's current subscription billing period ends, or null if the account has no active subscription")
+    __properties: ClassVar[List[str]] = ["id", "name", "date_created", "account_user_role", "subscription_type", "subscription_dt_started", "subscription_billing_period_end"]
+
+    @field_validator('subscription_type')
+    def subscription_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['team', 'enterprise']):
+            raise ValueError("must be one of enum values ('team', 'enterprise')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Account from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if subscription_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.subscription_type is None and "subscription_type" in self.model_fields_set:
+            _dict['subscription_type'] = None
+
+        # set to None if subscription_dt_started (nullable) is None
+        # and model_fields_set contains the field
+        if self.subscription_dt_started is None and "subscription_dt_started" in self.model_fields_set:
+            _dict['subscription_dt_started'] = None
+
+        # set to None if subscription_billing_period_end (nullable) is None
+        # and model_fields_set contains the field
+        if self.subscription_billing_period_end is None and "subscription_billing_period_end" in self.model_fields_set:
+            _dict['subscription_billing_period_end'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Account from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "date_created": obj.get("date_created"),
+            "account_user_role": obj.get("account_user_role"),
+            "subscription_type": obj.get("subscription_type"),
+            "subscription_dt_started": obj.get("subscription_dt_started"),
+            "subscription_billing_period_end": obj.get("subscription_billing_period_end")
+        })
+        return _obj
+
+

stract_api/models/account_credit_cache.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class AccountCreditCache(BaseModel):
+    """
+    AccountCreditCache
+    """ # noqa: E501
+    id: UUID = Field(description="Unique identifier of the account credit balance")
+    account_id: UUID = Field(description="ID of the account this credit balance belongs to")
+    suser_id: Optional[UUID] = Field(description="ID of the user this credit balance belongs to, or null if it is the organization credit balance")
+    cached_balance: Union[StrictFloat, StrictInt] = Field(description="Credit balance for the account", json_schema_extra={"examples": [42]})
+    __properties: ClassVar[List[str]] = ["id", "account_id", "suser_id", "cached_balance"]
+
+    @_coerce_field_validator('cached_balance', mode="before")
+    def cached_balance_coerce_numeric_string(cls, value):
+        """The API sends numbers as strings (e.g. '29532'); convert them before strict validation"""
+        if isinstance(value, str):
+            try:
+                return int(value)
+            except ValueError:
+                return float(value)
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccountCreditCache from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if suser_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.suser_id is None and "suser_id" in self.model_fields_set:
+            _dict['suser_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccountCreditCache from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "account_id": obj.get("account_id"),
+            "suser_id": obj.get("suser_id"),
+            "cached_balance": obj.get("cached_balance")
+        })
+        return _obj
+
+

stract_api/models/account_credit_ledger.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class AccountCreditLedger(BaseModel):
+    """
+    AccountCreditLedger
+    """ # noqa: E501
+    id: UUID = Field(description="Unique identifier of the ledger entry")
+    account_id: UUID = Field(description="ID of the account this ledger entry belongs to")
+    suser_id: Optional[UUID] = Field(description="ID of the user account that was charged or null if charged to the organization account")
+    spending_suser_id: UUID = Field(description="ID of the user who performed the action that created this ledger entry")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Change in credits for this entry (negative for credits spent, positive for credits added)", json_schema_extra={"examples": [42]})
+    created_at: datetime = Field(description="Timestamp when the ledger entry was created")
+    type: StrictStr = Field(description="The kind of activity that produced this ledger entry")
+    reference_id: StrictStr = Field(description="ID of the object (found in reference_table) that this ledger entry relates to")
+    reference_table: Optional[StrictStr] = Field(default=None, description="Object type where reference_id can be found")
+    idempotency_key: StrictStr = Field(description="Unique key used to prevent duplicate ledger entries")
+    __properties: ClassVar[List[str]] = ["id", "account_id", "suser_id", "spending_suser_id", "amount", "created_at", "type", "reference_id", "reference_table", "idempotency_key"]
+
+    @_coerce_field_validator('amount', mode="before")
+    def amount_coerce_numeric_string(cls, value):
+        """The API sends numbers as strings (e.g. '29532'); convert them before strict validation"""
+        if isinstance(value, str):
+            try:
+                return int(value)
+            except ValueError:
+                return float(value)
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccountCreditLedger from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if suser_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.suser_id is None and "suser_id" in self.model_fields_set:
+            _dict['suser_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccountCreditLedger from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "account_id": obj.get("account_id"),
+            "suser_id": obj.get("suser_id"),
+            "spending_suser_id": obj.get("spending_suser_id"),
+            "amount": obj.get("amount"),
+            "created_at": obj.get("created_at"),
+            "type": obj.get("type"),
+            "reference_id": obj.get("reference_id"),
+            "reference_table": obj.get("reference_table"),
+            "idempotency_key": obj.get("idempotency_key")
+        })
+        return _obj
+
+