telnyx 3.5.0a0__py3-none-any.whl → 3.6.0__py3-none-any.whl

telnyx/types/oauth_client.py

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["OAuthClient"]
+
+
+class OAuthClient(BaseModel):
+    client_id: str
+    """OAuth client identifier"""
+
+    client_type: Literal["public", "confidential"]
+    """OAuth client type"""
+
+    created_at: datetime
+    """Timestamp when the client was created"""
+
+    name: str
+    """Human-readable name for the OAuth client"""
+
+    org_id: str
+    """Organization ID that owns this OAuth client"""
+
+    record_type: Literal["oauth_client"]
+    """Record type identifier"""
+
+    require_pkce: bool
+    """Whether PKCE (Proof Key for Code Exchange) is required for this client"""
+
+    updated_at: datetime
+    """Timestamp when the client was last updated"""
+
+    user_id: str
+    """User ID that created this OAuth client"""
+
+    allowed_grant_types: Optional[List[Literal["client_credentials", "authorization_code", "refresh_token"]]] = None
+    """List of allowed OAuth grant types"""
+
+    allowed_scopes: Optional[List[str]] = None
+    """List of allowed OAuth scopes"""
+
+    client_secret: Optional[str] = None
+    """Client secret (only included when available, for confidential clients)"""
+
+    logo_uri: Optional[str] = None
+    """URL of the client logo"""
+
+    policy_uri: Optional[str] = None
+    """URL of the client's privacy policy"""
+
+    redirect_uris: Optional[List[str]] = None
+    """List of allowed redirect URIs"""
+
+    tos_uri: Optional[str] = None
+    """URL of the client's terms of service"""

telnyx/types/oauth_client_create_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["OAuthClientCreateParams"]
+
+
+class OAuthClientCreateParams(TypedDict, total=False):
+    allowed_grant_types: Required[List[Literal["client_credentials", "authorization_code", "refresh_token"]]]
+    """List of allowed OAuth grant types"""
+
+    allowed_scopes: Required[SequenceNotStr[str]]
+    """List of allowed OAuth scopes"""
+
+    client_type: Required[Literal["public", "confidential"]]
+    """OAuth client type"""
+
+    name: Required[str]
+    """The name of the OAuth client"""
+
+    logo_uri: str
+    """URL of the client logo"""
+
+    policy_uri: str
+    """URL of the client's privacy policy"""
+
+    redirect_uris: SequenceNotStr[str]
+    """List of redirect URIs (required for authorization_code flow)"""
+
+    require_pkce: bool
+    """Whether PKCE (Proof Key for Code Exchange) is required for this client"""
+
+    tos_uri: str
+    """URL of the client's terms of service"""

telnyx/types/oauth_client_create_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .oauth_client import OAuthClient
+
+__all__ = ["OAuthClientCreateResponse"]
+
+
+class OAuthClientCreateResponse(BaseModel):
+    data: Optional[OAuthClient] = None

telnyx/types/oauth_client_list_params.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["OAuthClientListParams"]
+
+
+class OAuthClientListParams(TypedDict, total=False):
+    filter_allowed_grant_types_contains: Annotated[
+        Literal["client_credentials", "authorization_code", "refresh_token"],
+        PropertyInfo(alias="filter[allowed_grant_types][contains]"),
+    ]
+    """Filter by allowed grant type"""
+
+    filter_client_id: Annotated[str, PropertyInfo(alias="filter[client_id]")]
+    """Filter by client ID"""
+
+    filter_client_type: Annotated[Literal["confidential", "public"], PropertyInfo(alias="filter[client_type]")]
+    """Filter by client type"""
+
+    filter_name: Annotated[str, PropertyInfo(alias="filter[name]")]
+    """Filter by exact client name"""
+
+    filter_name_contains: Annotated[str, PropertyInfo(alias="filter[name][contains]")]
+    """Filter by client name containing text"""
+
+    filter_verified: Annotated[bool, PropertyInfo(alias="filter[verified]")]
+    """Filter by verification status"""
+
+    page_number: Annotated[int, PropertyInfo(alias="page[number]")]
+    """Page number"""
+
+    page_size: Annotated[int, PropertyInfo(alias="page[size]")]
+    """Number of results per page"""

telnyx/types/oauth_client_list_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .oauth_client import OAuthClient
+from .pagination_meta_oauth import PaginationMetaOAuth
+
+__all__ = ["OAuthClientListResponse"]
+
+
+class OAuthClientListResponse(BaseModel):
+    data: Optional[List[OAuthClient]] = None
+
+    meta: Optional[PaginationMetaOAuth] = None

telnyx/types/oauth_client_retrieve_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .oauth_client import OAuthClient
+
+__all__ = ["OAuthClientRetrieveResponse"]
+
+
+class OAuthClientRetrieveResponse(BaseModel):
+    data: Optional[OAuthClient] = None

telnyx/types/oauth_client_update_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["OAuthClientUpdateParams"]
+
+
+class OAuthClientUpdateParams(TypedDict, total=False):
+    allowed_grant_types: List[Literal["client_credentials", "authorization_code", "refresh_token"]]
+    """List of allowed OAuth grant types"""
+
+    allowed_scopes: SequenceNotStr[str]
+    """List of allowed OAuth scopes"""
+
+    logo_uri: str
+    """URL of the client logo"""
+
+    name: str
+    """The name of the OAuth client"""
+
+    policy_uri: str
+    """URL of the client's privacy policy"""
+
+    redirect_uris: SequenceNotStr[str]
+    """List of redirect URIs"""
+
+    require_pkce: bool
+    """Whether PKCE (Proof Key for Code Exchange) is required for this client"""
+
+    tos_uri: str
+    """URL of the client's terms of service"""

telnyx/types/oauth_client_update_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .oauth_client import OAuthClient
+
+__all__ = ["OAuthClientUpdateResponse"]
+
+
+class OAuthClientUpdateResponse(BaseModel):
+    data: Optional[OAuthClient] = None

telnyx/types/oauth_grant.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["OAuthGrant"]
+
+
+class OAuthGrant(BaseModel):
+    id: str
+    """Unique identifier for the OAuth grant"""
+
+    client_id: str
+    """OAuth client identifier"""
+
+    created_at: datetime
+    """Timestamp when the grant was created"""
+
+    record_type: Literal["oauth_grant"]
+    """Record type identifier"""
+
+    scopes: List[str]
+    """List of granted OAuth scopes"""
+
+    last_used_at: Optional[datetime] = None
+    """Timestamp when the grant was last used"""

telnyx/types/oauth_grant_delete_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .oauth_grant import OAuthGrant
+
+__all__ = ["OAuthGrantDeleteResponse"]
+
+
+class OAuthGrantDeleteResponse(BaseModel):
+    data: Optional[OAuthGrant] = None

telnyx/types/oauth_grant_list_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["OAuthGrantListParams"]
+
+
+class OAuthGrantListParams(TypedDict, total=False):
+    page_number: Annotated[int, PropertyInfo(alias="page[number]")]
+    """Page number"""
+
+    page_size: Annotated[int, PropertyInfo(alias="page[size]")]
+    """Number of results per page"""

telnyx/types/oauth_grant_list_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .oauth_grant import OAuthGrant
+from .pagination_meta_oauth import PaginationMetaOAuth
+
+__all__ = ["OAuthGrantListResponse"]
+
+
+class OAuthGrantListResponse(BaseModel):
+    data: Optional[List[OAuthGrant]] = None
+
+    meta: Optional[PaginationMetaOAuth] = None

telnyx/types/oauth_grant_retrieve_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .oauth_grant import OAuthGrant
+
+__all__ = ["OAuthGrantRetrieveResponse"]
+
+
+class OAuthGrantRetrieveResponse(BaseModel):
+    data: Optional[OAuthGrant] = None

telnyx/types/oauth_grants_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["OAuthGrantsParams"]
+
+
+class OAuthGrantsParams(TypedDict, total=False):
+    allowed: Required[bool]
+    """Whether the grant is allowed"""
+
+    consent_token: Required[str]
+    """Consent token"""

telnyx/types/oauth_grants_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["OAuthGrantsResponse"]
+
+
+class OAuthGrantsResponse(BaseModel):
+    redirect_uri: str
+    """Redirect URI with authorization code or error"""

telnyx/types/oauth_introspect_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["OAuthIntrospectParams"]
+
+
+class OAuthIntrospectParams(TypedDict, total=False):
+    token: Required[str]
+    """The token to introspect"""

telnyx/types/oauth_introspect_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthIntrospectResponse"]
+
+
+class OAuthIntrospectResponse(BaseModel):
+    active: bool
+    """Whether the token is active"""
+
+    aud: Optional[str] = None
+    """Audience"""
+
+    client_id: Optional[str] = None
+    """Client identifier"""
+
+    exp: Optional[int] = None
+    """Expiration timestamp"""
+
+    iat: Optional[int] = None
+    """Issued at timestamp"""
+
+    iss: Optional[str] = None
+    """Issuer"""
+
+    scope: Optional[str] = None
+    """Space-separated list of scopes"""

telnyx/types/oauth_register_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["OAuthRegisterParams"]
+
+
+class OAuthRegisterParams(TypedDict, total=False):
+    client_name: str
+    """Human-readable string name of the client to be presented to the end-user"""
+
+    grant_types: List[Literal["authorization_code", "client_credentials", "refresh_token"]]
+    """Array of OAuth 2.0 grant type strings that the client may use"""
+
+    logo_uri: str
+    """URL of the client logo"""
+
+    policy_uri: str
+    """URL of the client's privacy policy"""
+
+    redirect_uris: SequenceNotStr[str]
+    """Array of redirection URI strings for use in redirect-based flows"""
+
+    response_types: SequenceNotStr[str]
+    """Array of the OAuth 2.0 response type strings that the client may use"""
+
+    scope: str
+    """Space-separated string of scope values that the client may use"""
+
+    token_endpoint_auth_method: Literal["none", "client_secret_basic", "client_secret_post"]
+    """Authentication method for the token endpoint"""
+
+    tos_uri: str
+    """URL of the client's terms of service"""

telnyx/types/oauth_register_response.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRegisterResponse"]
+
+
+class OAuthRegisterResponse(BaseModel):
+    client_id: str
+    """Unique client identifier"""
+
+    client_id_issued_at: int
+    """Unix timestamp of when the client ID was issued"""
+
+    client_name: Optional[str] = None
+    """Human-readable client name"""
+
+    client_secret: Optional[str] = None
+    """Client secret (only for confidential clients)"""
+
+    grant_types: Optional[List[str]] = None
+    """Array of allowed grant types"""
+
+    logo_uri: Optional[str] = None
+    """URL of the client logo"""
+
+    policy_uri: Optional[str] = None
+    """URL of the client's privacy policy"""
+
+    redirect_uris: Optional[List[str]] = None
+    """Array of redirection URIs"""
+
+    response_types: Optional[List[str]] = None
+    """Array of allowed response types"""
+
+    scope: Optional[str] = None
+    """Space-separated scope values"""
+
+    token_endpoint_auth_method: Optional[str] = None
+    """Token endpoint authentication method"""
+
+    tos_uri: Optional[str] = None
+    """URL of the client's terms of service"""

telnyx/types/oauth_retrieve_authorize_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["OAuthRetrieveAuthorizeParams"]
+
+
+class OAuthRetrieveAuthorizeParams(TypedDict, total=False):
+    client_id: Required[str]
+    """OAuth client identifier"""
+
+    redirect_uri: Required[str]
+    """Redirect URI"""
+
+    response_type: Required[Literal["code"]]
+    """OAuth response type"""
+
+    code_challenge: str
+    """PKCE code challenge"""
+
+    code_challenge_method: Literal["plain", "S256"]
+    """PKCE code challenge method"""
+
+    scope: str
+    """Space-separated list of requested scopes"""
+
+    state: str
+    """State parameter for CSRF protection"""

telnyx/types/oauth_retrieve_jwks_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRetrieveJwksResponse", "Key"]
+
+
+class Key(BaseModel):
+    alg: Optional[str] = None
+    """Algorithm"""
+
+    kid: Optional[str] = None
+    """Key ID"""
+
+    kty: Optional[str] = None
+    """Key type"""
+
+    use: Optional[str] = None
+    """Key use"""
+
+
+class OAuthRetrieveJwksResponse(BaseModel):
+    keys: Optional[List[Key]] = None

telnyx/types/oauth_retrieve_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["OAuthRetrieveResponse", "Data", "DataRequestedScope"]
+
+
+class DataRequestedScope(BaseModel):
+    id: Optional[str] = None
+    """Scope ID"""
+
+    description: Optional[str] = None
+    """Scope description"""
+
+    name: Optional[str] = None
+    """Scope name"""
+
+
+class Data(BaseModel):
+    client_id: Optional[str] = None
+    """Client ID"""
+
+    logo_uri: Optional[str] = None
+    """URL of the client logo"""
+
+    name: Optional[str] = None
+    """Client name"""
+
+    policy_uri: Optional[str] = None
+    """URL of the client's privacy policy"""
+
+    redirect_uri: Optional[str] = None
+    """The redirect URI for this authorization"""
+
+    requested_scopes: Optional[List[DataRequestedScope]] = None
+
+    tos_uri: Optional[str] = None
+    """URL of the client's terms of service"""
+
+    verified: Optional[bool] = None
+    """Whether the client is verified"""
+
+
+class OAuthRetrieveResponse(BaseModel):
+    data: Optional[Data] = None

telnyx/types/oauth_token_params.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["OAuthTokenParams"]
+
+
+class OAuthTokenParams(TypedDict, total=False):
+    grant_type: Required[Literal["client_credentials", "authorization_code", "refresh_token"]]
+    """OAuth 2.0 grant type"""
+
+    client_id: str
+    """OAuth client ID (if not using HTTP Basic auth)"""
+
+    client_secret: str
+    """OAuth client secret (if not using HTTP Basic auth)"""
+
+    code: str
+    """Authorization code (for authorization_code flow)"""
+
+    code_verifier: str
+    """PKCE code verifier (for authorization_code flow)"""
+
+    redirect_uri: str
+    """Redirect URI (for authorization_code flow)"""
+
+    refresh_token: str
+    """Refresh token (for refresh_token flow)"""
+
+    scope: str
+    """Space-separated list of requested scopes (for client_credentials)"""

telnyx/types/oauth_token_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["OAuthTokenResponse"]
+
+
+class OAuthTokenResponse(BaseModel):
+    access_token: str
+    """The access token"""
+
+    expires_in: int
+    """Token lifetime in seconds"""
+
+    token_type: Literal["Bearer"]
+    """Token type"""
+
+    refresh_token: Optional[str] = None
+    """Refresh token (if applicable)"""
+
+    scope: Optional[str] = None
+    """Space-separated list of granted scopes"""