signupcheck-sdk 0.1.0__tar.gz

signupcheck_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: signupcheck-sdk
+Version: 0.1.0
+Summary: Python client for the SignupCheck anti-abuse API
+Author-email: Visian Systems <support@signupcheck.com>
+License-Expression: MIT
+Project-URL: Homepage, https://signupcheck.com
+Project-URL: Repository, https://gitlab.com/visian/infra-structure/signupcheck-sdk
+Project-URL: Issues, https://gitlab.com/visian/infra-structure/signupcheck-sdk/-/issues
+Keywords: signupcheck,anti-abuse,api,sdk,openapi
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.2.1; extra == "dev"
+Requires-Dist: pytest-cov>=2.8.1; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+
+# signupcheck-sdk
+
+Python client for the [SignupCheck](https://signupcheck.com) anti-abuse API — block disposable emails, VPNs, proxies, bots, and malicious IPs at signup.
+
+## Install
+
+```bash
+pip install signupcheck-sdk
+```
+
+Requires Python 3.9+.
+
+## Quick start
+
+```python
+import os
+import signupcheck
+from signupcheck.models.evaluate_signup_request import EvaluateSignupRequest
+
+cfg = signupcheck.Configuration(host="https://api.signupcheck.com")
+cfg.api_key["API Key"] = os.environ["SIGNUPCHECK_API_KEY"]
+
+with signupcheck.ApiClient(cfg) as client:
+    api = signupcheck.DecisionEngineApi(client)
+    resp = api.evaluate_signup(EvaluateSignupRequest(
+        email="user@example.com",
+        ip="1.2.3.4",
+    ))
+    print(resp.decision, resp.risk_score)
+```
+
+The client reads the API key via the `X-API-Key` header. To use Bearer auth instead:
+
+```python
+cfg.api_key["Bearer"] = os.environ["SIGNUPCHECK_API_KEY"]
+cfg.api_key_prefix["Bearer"] = "Bearer"
+```
+
+## Available APIs
+
+| Class              | Endpoint prefix          | Purpose                                |
+|--------------------|--------------------------|----------------------------------------|
+| `DecisionEngineApi`| `/v1/evaluate/signup`    | ALLOW / CHALLENGE / BLOCK decision     |
+| `ChecksApi`        | `/v1/evaluate/{email,ip}`| Standalone email / IP risk checks      |
+| `ListsApi`         | `/v1/lists`              | Manage allow / block lists             |
+| `RulesApi`         | `/v1/rules`              | Manage custom rules                    |
+| `FeedbackApi`      | `/v1/feedback/signup`    | Submit outcome feedback                |
+| `ObservabilityApi` | `/v1/events`, `/v1/metrics/signup` | Query events and metrics   |
+| `AccountApi`       | `/v1/me`                 | Validate API key (no credit charge)    |
+
+## Development
+
+This package is generated from the OpenAPI spec in the [signupcheck API repo](https://gitlab.com/visian/infra-structure/signupcheck). To regenerate after a schema change, run `make sdk-python` in the API repo.
+
+Local build and test from this directory:
+
+```bash
+make build      # python -m build → dist/
+make check      # twine check dist/*
+```
+
+## License
+
+Proprietary. See the repository for terms.

signupcheck_sdk-0.1.0/README.md

@@ -0,0 +1,64 @@
+# signupcheck-sdk
+
+Python client for the [SignupCheck](https://signupcheck.com) anti-abuse API — block disposable emails, VPNs, proxies, bots, and malicious IPs at signup.
+
+## Install
+
+```bash
+pip install signupcheck-sdk
+```
+
+Requires Python 3.9+.
+
+## Quick start
+
+```python
+import os
+import signupcheck
+from signupcheck.models.evaluate_signup_request import EvaluateSignupRequest
+
+cfg = signupcheck.Configuration(host="https://api.signupcheck.com")
+cfg.api_key["API Key"] = os.environ["SIGNUPCHECK_API_KEY"]
+
+with signupcheck.ApiClient(cfg) as client:
+    api = signupcheck.DecisionEngineApi(client)
+    resp = api.evaluate_signup(EvaluateSignupRequest(
+        email="user@example.com",
+        ip="1.2.3.4",
+    ))
+    print(resp.decision, resp.risk_score)
+```
+
+The client reads the API key via the `X-API-Key` header. To use Bearer auth instead:
+
+```python
+cfg.api_key["Bearer"] = os.environ["SIGNUPCHECK_API_KEY"]
+cfg.api_key_prefix["Bearer"] = "Bearer"
+```
+
+## Available APIs
+
+| Class              | Endpoint prefix          | Purpose                                |
+|--------------------|--------------------------|----------------------------------------|
+| `DecisionEngineApi`| `/v1/evaluate/signup`    | ALLOW / CHALLENGE / BLOCK decision     |
+| `ChecksApi`        | `/v1/evaluate/{email,ip}`| Standalone email / IP risk checks      |
+| `ListsApi`         | `/v1/lists`              | Manage allow / block lists             |
+| `RulesApi`         | `/v1/rules`              | Manage custom rules                    |
+| `FeedbackApi`      | `/v1/feedback/signup`    | Submit outcome feedback                |
+| `ObservabilityApi` | `/v1/events`, `/v1/metrics/signup` | Query events and metrics   |
+| `AccountApi`       | `/v1/me`                 | Validate API key (no credit charge)    |
+
+## Development
+
+This package is generated from the OpenAPI spec in the [signupcheck API repo](https://gitlab.com/visian/infra-structure/signupcheck). To regenerate after a schema change, run `make sdk-python` in the API repo.
+
+Local build and test from this directory:
+
+```bash
+make build      # python -m build → dist/
+make check      # twine check dist/*
+```
+
+## License
+
+Proprietary. See the repository for terms.

signupcheck_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "signupcheck-sdk"
+version = "0.1.0"
+description = "Python client for the SignupCheck anti-abuse API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "Visian Systems", email = "support@signupcheck.com" }]
+keywords = ["signupcheck", "anti-abuse", "api", "sdk", "openapi"]
+
+dependencies = [
+  "urllib3>=2.1.0,<3.0.0",
+  "python-dateutil>=2.8.2",
+  "pydantic>=2.11",
+  "typing-extensions>=4.7.1",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.2.1",
+  "pytest-cov>=2.8.1",
+  "build>=1.0.0",
+  "twine>=5.0.0",
+]
+
+[project.urls]
+Homepage   = "https://signupcheck.com"
+Repository = "https://gitlab.com/visian/infra-structure/signupcheck-sdk"
+Issues     = "https://gitlab.com/visian/infra-structure/signupcheck-sdk/-/issues"
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["signupcheck*"]
+exclude = ["test*", "tests*", "docs*"]
+
+[tool.setuptools.package-data]
+signupcheck = ["py.typed"]

signupcheck_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

signupcheck_sdk-0.1.0/signupcheck/__init__.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    SignupCheck
+
+     # Anti-Abuse API for SaaS Sign-ups  Block disposable emails, VPNs, proxies, bots, and malicious IPs.  ## Authentication  All API endpoints require authentication via API key:  ``` X-API-Key: your-api-key-here ```  Or via Bearer token:  ``` Authorization: Bearer your-api-key-here ```  ## Endpoints  | Endpoint | Method | Description | |----------|--------|-------------| | `/v1/evaluate/signup` | POST | Core decision engine - returns ALLOW/CHALLENGE/BLOCK | | `/v1/evaluate/email` | GET | Standalone email risk check | | `/v1/evaluate/ip` | GET | Standalone IP risk check | | `/v1/lists` | GET/POST | Manage allow/block lists | | `/v1/rules` | GET/POST | Manage custom rules | | `/v1/feedback/signup` | POST | Submit feedback for model improvement | | `/v1/events` | GET | Query signup events | | `/v1/metrics/signup` | GET | Get signup metrics |  ## Decision Engine  The core `/v1/evaluate/signup` endpoint evaluates signup attempts and returns one of three decisions:  - **ALLOW** (risk score < 50) - Safe to proceed - **CHALLENGE** (risk score 50-79) - Require additional verification - **BLOCK** (risk score >= 80) - Reject signup  ## Rate Limits  - 1000 requests per minute per API key - 10,000 requests per hour per API key 
+
+    The version of the OpenAPI document: v1
+    Contact: support@signupcheck.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.0"
+
+# Define package exports
+__all__ = [
+    "AccountApi",
+    "ChecksApi",
+    "DecisionEngineApi",
+    "FeedbackApi",
+    "ListsApi",
+    "ObservabilityApi",
+    "RulesApi",
+    "V1Api",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "DecisionCounts",
+    "DeviceFingerprint",
+    "EmailSignals",
+    "Error",
+    "EvaluateSignupRequest",
+    "EvaluateSignupResponse",
+    "FeedbackRequest",
+    "GetMe200Response",
+    "GetMe401Response",
+    "IPSignals",
+    "ListCreate",
+    "ListItemCreate",
+    "ListSignals",
+    "MetricsResponse",
+    "Reason",
+    "RecommendedAction",
+    "RuleCreate",
+    "RuleTestRequest",
+    "RuleTestResponse",
+    "RuleUpdate",
+    "RulesSignals",
+    "Signals",
+    "TopItem",
+    "TriggeredRule",
+    "V1EmailCheckResponse",
+    "V1EmailClassification",
+    "V1EmailDNS",
+    "V1EmailDeliverability",
+    "V1EmailMX",
+    "V1EmailMasked",
+    "V1EmailMeta",
+    "V1EmailNormalized",
+    "V1EmailProvider",
+    "V1EmailRisk",
+    "V1EventDetail",
+    "V1EventList",
+    "V1FeedbackResponse",
+    "V1IPAnonymity",
+    "V1IPCheckResponse",
+    "V1IPContinent",
+    "V1IPCoordinates",
+    "V1IPCountry",
+    "V1IPDatacenter",
+    "V1IPGeo",
+    "V1IPMeta",
+    "V1IPNetwork",
+    "V1IPNormalized",
+    "V1IPProxy",
+    "V1IPRegion",
+    "V1IPReputation",
+    "V1IPRisk",
+    "V1IPTor",
+    "V1IPVPN",
+    "V1IPiCloudRelay",
+    "V1ListItemResponse",
+    "V1ListResponse",
+    "V1RuleResponse",
+    "VelocitySignals",
+]
+
+# import apis into sdk package
+from signupcheck.api.account_api import AccountApi as AccountApi
+from signupcheck.api.checks_api import ChecksApi as ChecksApi
+from signupcheck.api.decision_engine_api import DecisionEngineApi as DecisionEngineApi
+from signupcheck.api.feedback_api import FeedbackApi as FeedbackApi
+from signupcheck.api.lists_api import ListsApi as ListsApi
+from signupcheck.api.observability_api import ObservabilityApi as ObservabilityApi
+from signupcheck.api.rules_api import RulesApi as RulesApi
+from signupcheck.api.v1_api import V1Api as V1Api
+
+# import ApiClient
+from signupcheck.api_response import ApiResponse as ApiResponse
+from signupcheck.api_client import ApiClient as ApiClient
+from signupcheck.configuration import Configuration as Configuration
+from signupcheck.exceptions import OpenApiException as OpenApiException
+from signupcheck.exceptions import ApiTypeError as ApiTypeError
+from signupcheck.exceptions import ApiValueError as ApiValueError
+from signupcheck.exceptions import ApiKeyError as ApiKeyError
+from signupcheck.exceptions import ApiAttributeError as ApiAttributeError
+from signupcheck.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from signupcheck.models.decision_counts import DecisionCounts as DecisionCounts
+from signupcheck.models.device_fingerprint import DeviceFingerprint as DeviceFingerprint
+from signupcheck.models.email_signals import EmailSignals as EmailSignals
+from signupcheck.models.error import Error as Error
+from signupcheck.models.evaluate_signup_request import EvaluateSignupRequest as EvaluateSignupRequest
+from signupcheck.models.evaluate_signup_response import EvaluateSignupResponse as EvaluateSignupResponse
+from signupcheck.models.feedback_request import FeedbackRequest as FeedbackRequest
+from signupcheck.models.get_me200_response import GetMe200Response as GetMe200Response
+from signupcheck.models.get_me401_response import GetMe401Response as GetMe401Response
+from signupcheck.models.ip_signals import IPSignals as IPSignals
+from signupcheck.models.list_create import ListCreate as ListCreate
+from signupcheck.models.list_item_create import ListItemCreate as ListItemCreate
+from signupcheck.models.list_signals import ListSignals as ListSignals
+from signupcheck.models.metrics_response import MetricsResponse as MetricsResponse
+from signupcheck.models.reason import Reason as Reason
+from signupcheck.models.recommended_action import RecommendedAction as RecommendedAction
+from signupcheck.models.rule_create import RuleCreate as RuleCreate
+from signupcheck.models.rule_test_request import RuleTestRequest as RuleTestRequest
+from signupcheck.models.rule_test_response import RuleTestResponse as RuleTestResponse
+from signupcheck.models.rule_update import RuleUpdate as RuleUpdate
+from signupcheck.models.rules_signals import RulesSignals as RulesSignals
+from signupcheck.models.signals import Signals as Signals
+from signupcheck.models.top_item import TopItem as TopItem
+from signupcheck.models.triggered_rule import TriggeredRule as TriggeredRule
+from signupcheck.models.v1_email_check_response import V1EmailCheckResponse as V1EmailCheckResponse
+from signupcheck.models.v1_email_classification import V1EmailClassification as V1EmailClassification
+from signupcheck.models.v1_email_dns import V1EmailDNS as V1EmailDNS
+from signupcheck.models.v1_email_deliverability import V1EmailDeliverability as V1EmailDeliverability
+from signupcheck.models.v1_email_mx import V1EmailMX as V1EmailMX
+from signupcheck.models.v1_email_masked import V1EmailMasked as V1EmailMasked
+from signupcheck.models.v1_email_meta import V1EmailMeta as V1EmailMeta
+from signupcheck.models.v1_email_normalized import V1EmailNormalized as V1EmailNormalized
+from signupcheck.models.v1_email_provider import V1EmailProvider as V1EmailProvider
+from signupcheck.models.v1_email_risk import V1EmailRisk as V1EmailRisk
+from signupcheck.models.v1_event_detail import V1EventDetail as V1EventDetail
+from signupcheck.models.v1_event_list import V1EventList as V1EventList
+from signupcheck.models.v1_feedback_response import V1FeedbackResponse as V1FeedbackResponse
+from signupcheck.models.v1_ip_anonymity import V1IPAnonymity as V1IPAnonymity
+from signupcheck.models.v1_ip_check_response import V1IPCheckResponse as V1IPCheckResponse
+from signupcheck.models.v1_ip_continent import V1IPContinent as V1IPContinent
+from signupcheck.models.v1_ip_coordinates import V1IPCoordinates as V1IPCoordinates
+from signupcheck.models.v1_ip_country import V1IPCountry as V1IPCountry
+from signupcheck.models.v1_ip_datacenter import V1IPDatacenter as V1IPDatacenter
+from signupcheck.models.v1_ip_geo import V1IPGeo as V1IPGeo
+from signupcheck.models.v1_ip_meta import V1IPMeta as V1IPMeta
+from signupcheck.models.v1_ip_network import V1IPNetwork as V1IPNetwork
+from signupcheck.models.v1_ip_normalized import V1IPNormalized as V1IPNormalized
+from signupcheck.models.v1_ip_proxy import V1IPProxy as V1IPProxy
+from signupcheck.models.v1_ip_region import V1IPRegion as V1IPRegion
+from signupcheck.models.v1_ip_reputation import V1IPReputation as V1IPReputation
+from signupcheck.models.v1_ip_risk import V1IPRisk as V1IPRisk
+from signupcheck.models.v1_ip_tor import V1IPTor as V1IPTor
+from signupcheck.models.v1_ipvpn import V1IPVPN as V1IPVPN
+from signupcheck.models.v1_ipi_cloud_relay import V1IPiCloudRelay as V1IPiCloudRelay
+from signupcheck.models.v1_list_item_response import V1ListItemResponse as V1ListItemResponse
+from signupcheck.models.v1_list_response import V1ListResponse as V1ListResponse
+from signupcheck.models.v1_rule_response import V1RuleResponse as V1RuleResponse
+from signupcheck.models.velocity_signals import VelocitySignals as VelocitySignals
+

signupcheck_sdk-0.1.0/signupcheck/api/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+# import apis into api package
+from signupcheck.api.account_api import AccountApi
+from signupcheck.api.checks_api import ChecksApi
+from signupcheck.api.decision_engine_api import DecisionEngineApi
+from signupcheck.api.feedback_api import FeedbackApi
+from signupcheck.api.lists_api import ListsApi
+from signupcheck.api.observability_api import ObservabilityApi
+from signupcheck.api.rules_api import RulesApi
+from signupcheck.api.v1_api import V1Api
+

signupcheck_sdk-0.1.0/signupcheck/api/account_api.py

@@ -0,0 +1,286 @@
+"""
+    SignupCheck
+
+     # Anti-Abuse API for SaaS Sign-ups  Block disposable emails, VPNs, proxies, bots, and malicious IPs.  ## Authentication  All API endpoints require authentication via API key:  ``` X-API-Key: your-api-key-here ```  Or via Bearer token:  ``` Authorization: Bearer your-api-key-here ```  ## Endpoints  | Endpoint | Method | Description | |----------|--------|-------------| | `/v1/evaluate/signup` | POST | Core decision engine - returns ALLOW/CHALLENGE/BLOCK | | `/v1/evaluate/email` | GET | Standalone email risk check | | `/v1/evaluate/ip` | GET | Standalone IP risk check | | `/v1/lists` | GET/POST | Manage allow/block lists | | `/v1/rules` | GET/POST | Manage custom rules | | `/v1/feedback/signup` | POST | Submit feedback for model improvement | | `/v1/events` | GET | Query signup events | | `/v1/metrics/signup` | GET | Get signup metrics |  ## Decision Engine  The core `/v1/evaluate/signup` endpoint evaluates signup attempts and returns one of three decisions:  - **ALLOW** (risk score < 50) - Safe to proceed - **CHALLENGE** (risk score 50-79) - Require additional verification - **BLOCK** (risk score >= 80) - Reject signup  ## Rate Limits  - 1000 requests per minute per API key - 10,000 requests per hour per API key 
+
+    The version of the OpenAPI document: v1
+    Contact: support@signupcheck.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from signupcheck.models.get_me200_response import GetMe200Response
+
+from signupcheck.api_client import ApiClient, RequestSerialized
+from signupcheck.api_response import ApiResponse
+from signupcheck.rest import RESTResponseType
+
+
+class AccountApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_me(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetMe200Response:
+        """Validate API key
+
+        Validates the API key and returns account information. This endpoint does NOT consume API credits.
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :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
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_me_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetMe200Response",
+            '401': "GetMe401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_me_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetMe200Response]:
+        """Validate API key
+
+        Validates the API key and returns account information. This endpoint does NOT consume API credits.
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :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
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_me_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetMe200Response",
+            '401': "GetMe401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_me_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Validate API key
+
+        Validates the API key and returns account information. This endpoint does NOT consume API credits.
+
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :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
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_me_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetMe200Response",
+            '401': "GetMe401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_me_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'API Key', 
+            'Bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/me',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+