pingram-python 1.0.22__tar.gz → 1.0.23__tar.gz

{pingram_python-1.0.22/generated/pingram_python.egg-info → pingram_python-1.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pingram-python
-Version: 1.0.22
+Version: 1.0.23
 Summary: Official Python SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more
 Author: Pingram
 License: MIT

{pingram_python-1.0.22 → pingram_python-1.0.23}/generated/pingram/__init__.py

@@ -14,11 +14,12 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.22"
+__version__ = "1.0.23"
 
 # Define package exports
 __all__ = [
     "AccountApi",
+    "AccountsApi",
     "AddressesApi",
     "ComponentsApi",
     "DomainsApi",
@@ -82,6 +83,7 @@ __all__ = [
     "ChangePhoneRequest",
     "ChannelsEnum",
     "CreateAccountRequest",
+    "CreateAccountRequestPlan",
     "CreateAccountResponse",
     "CreateAddressRequest",
     "CreateKeyRequest",
@@ -109,6 +111,8 @@ __all__ = [
     "EnvironmentPatchRequest",
     "EventsWebhookResponse",
     "EventsWebhookUpsertRequest",
+    "FirstAccountRequest",
+    "FirstAccountResponse",
     "GetAccountMetadataResponse",
     "GetAccountMetadataResponseUserAccountMetadata",
     "GetEmailComponentsResponseInner",
@@ -205,6 +209,8 @@ __all__ = [
     "InvitePostResponse",
     "Knowledge",
     "KnowledgeDocumentsInner",
+    "ListAccountsResponse",
+    "ListAccountsResponseAccountsInner",
     "ListInvoicesResponse",
     "ListInvoicesResponseInvoicesInner",
     "ListPersonalAccessTokensResponse",
@@ -320,6 +326,7 @@ __all__ = [
 
 # import apis into sdk package
 from pingram.api.account_api import AccountApi as AccountApi
+from pingram.api.accounts_api import AccountsApi as AccountsApi
 from pingram.api.addresses_api import AddressesApi as AddressesApi
 from pingram.api.components_api import ComponentsApi as ComponentsApi
 from pingram.api.domains_api import DomainsApi as DomainsApi
@@ -387,6 +394,7 @@ from pingram.models.change_email_request import ChangeEmailRequest as ChangeEmai
 from pingram.models.change_phone_request import ChangePhoneRequest as ChangePhoneRequest
 from pingram.models.channels_enum import ChannelsEnum as ChannelsEnum
 from pingram.models.create_account_request import CreateAccountRequest as CreateAccountRequest
+from pingram.models.create_account_request_plan import CreateAccountRequestPlan as CreateAccountRequestPlan
 from pingram.models.create_account_response import CreateAccountResponse as CreateAccountResponse
 from pingram.models.create_address_request import CreateAddressRequest as CreateAddressRequest
 from pingram.models.create_key_request import CreateKeyRequest as CreateKeyRequest
@@ -414,6 +422,8 @@ from pingram.models.environment_create_request import EnvironmentCreateRequest a
 from pingram.models.environment_patch_request import EnvironmentPatchRequest as EnvironmentPatchRequest
 from pingram.models.events_webhook_response import EventsWebhookResponse as EventsWebhookResponse
 from pingram.models.events_webhook_upsert_request import EventsWebhookUpsertRequest as EventsWebhookUpsertRequest
+from pingram.models.first_account_request import FirstAccountRequest as FirstAccountRequest
+from pingram.models.first_account_response import FirstAccountResponse as FirstAccountResponse
 from pingram.models.get_account_metadata_response import GetAccountMetadataResponse as GetAccountMetadataResponse
 from pingram.models.get_account_metadata_response_user_account_metadata import GetAccountMetadataResponseUserAccountMetadata as GetAccountMetadataResponseUserAccountMetadata
 from pingram.models.get_email_components_response_inner import GetEmailComponentsResponseInner as GetEmailComponentsResponseInner
@@ -510,6 +520,8 @@ from pingram.models.intercom_webhook_data_item_any_of_source_author import Inter
 from pingram.models.invite_post_response import InvitePostResponse as InvitePostResponse
 from pingram.models.knowledge import Knowledge as Knowledge
 from pingram.models.knowledge_documents_inner import KnowledgeDocumentsInner as KnowledgeDocumentsInner
+from pingram.models.list_accounts_response import ListAccountsResponse as ListAccountsResponse
+from pingram.models.list_accounts_response_accounts_inner import ListAccountsResponseAccountsInner as ListAccountsResponseAccountsInner
 from pingram.models.list_invoices_response import ListInvoicesResponse as ListInvoicesResponse
 from pingram.models.list_invoices_response_invoices_inner import ListInvoicesResponseInvoicesInner as ListInvoicesResponseInvoicesInner
 from pingram.models.list_personal_access_tokens_response import ListPersonalAccessTokensResponse as ListPersonalAccessTokensResponse

{pingram_python-1.0.22 → pingram_python-1.0.23}/generated/pingram/api/__init__.py

@@ -2,6 +2,7 @@
 
 # import apis into api package
 from pingram.api.account_api import AccountApi
+from pingram.api.accounts_api import AccountsApi
 from pingram.api.addresses_api import AddressesApi
 from pingram.api.components_api import ComponentsApi
 from pingram.api.domains_api import DomainsApi

pingram_python-1.0.23/generated/pingram/api/accounts_api.py

@@ -0,0 +1,588 @@
+# coding: utf-8
+
+"""
+    Pingram
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    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 pingram.models.create_account_request import CreateAccountRequest
+from pingram.models.create_account_response import CreateAccountResponse
+from pingram.models.list_accounts_response import ListAccountsResponse
+
+from pingram.api_client import ApiClient, RequestSerialized
+from pingram.api_response import ApiResponse
+from pingram.rest import RESTResponseType
+
+
+class AccountsApi:
+    """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
+    async def accounts_create_account(
+        self,
+        create_account_request: CreateAccountRequest,
+        _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,
+    ) -> CreateAccountResponse:
+        """Create an additional account for the authenticated user
+
+
+        :param create_account_request: (required)
+        :type create_account_request: CreateAccountRequest
+        :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._accounts_create_account_serialize(
+            create_account_request=create_account_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateAccountResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def accounts_create_account_with_http_info(
+        self,
+        create_account_request: CreateAccountRequest,
+        _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[CreateAccountResponse]:
+        """Create an additional account for the authenticated user
+
+
+        :param create_account_request: (required)
+        :type create_account_request: CreateAccountRequest
+        :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._accounts_create_account_serialize(
+            create_account_request=create_account_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateAccountResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def accounts_create_account_without_preload_content(
+        self,
+        create_account_request: CreateAccountRequest,
+        _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:
+        """Create an additional account for the authenticated user
+
+
+        :param create_account_request: (required)
+        :type create_account_request: CreateAccountRequest
+        :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._accounts_create_account_serialize(
+            create_account_request=create_account_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateAccountResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _accounts_create_account_serialize(
+        self,
+        create_account_request,
+        _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
+        if create_account_request is not None:
+            _body_params = create_account_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'endUserHashed', 
+            'endUser', 
+            'apiKey', 
+            'clientCredentials'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/accounts',
+            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
+        )
+
+
+
+
+    @validate_call
+    async def accounts_list_accounts(
+        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,
+    ) -> ListAccountsResponse:
+        """List accounts the authenticated user can access
+
+
+        :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._accounts_list_accounts_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAccountsResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def accounts_list_accounts_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[ListAccountsResponse]:
+        """List accounts the authenticated user can access
+
+
+        :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._accounts_list_accounts_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAccountsResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def accounts_list_accounts_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:
+        """List accounts the authenticated user can access
+
+
+        :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._accounts_list_accounts_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAccountsResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _accounts_list_accounts_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] = [
+            'endUserHashed', 
+            'endUser', 
+            'apiKey', 
+            'clientCredentials'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/accounts',
+            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
+        )
+
+

{pingram_python-1.0.22 → pingram_python-1.0.23}/generated/pingram/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'pingram-python/1.0.22'
+        self.user_agent = 'pingram-python/1.0.23'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):