pingram-python 1.0.14__tar.gz → 1.0.16__tar.gz

{pingram_python-1.0.14/generated/pingram_python.egg-info → pingram_python-1.0.16}/PKG-INFO

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

{pingram_python-1.0.14 → pingram_python-1.0.16}/generated/pingram/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.14"
+__version__ = "1.0.16"
 
 # Define package exports
 __all__ = [
@@ -80,6 +80,8 @@ __all__ = [
     "CreateOrganizationResponse",
     "DeleteKeyResponse",
     "DeleteUserResponse",
+    "DomainDnsCheck",
+    "DomainDnsCheckRecordsInner",
     "EmailAuthTokenPostRequest",
     "EmailComponentPatchRequest",
     "EmailComponentPostRequest",
@@ -180,6 +182,10 @@ __all__ = [
     "LogsQueryResultResponse",
     "LogsRetentionResponse",
     "LogsTailResponse",
+    "MFASetupRequest",
+    "MFASetupResponse",
+    "MFAStatusResponse",
+    "MFAVerifyRequest",
     "MemberInviteRequest",
     "MemberUpdateRequest",
     "MessageResponse",
@@ -328,6 +334,8 @@ from pingram.models.create_key_response import CreateKeyResponse as CreateKeyRes
 from pingram.models.create_organization_response import CreateOrganizationResponse as CreateOrganizationResponse
 from pingram.models.delete_key_response import DeleteKeyResponse as DeleteKeyResponse
 from pingram.models.delete_user_response import DeleteUserResponse as DeleteUserResponse
+from pingram.models.domain_dns_check import DomainDnsCheck as DomainDnsCheck
+from pingram.models.domain_dns_check_records_inner import DomainDnsCheckRecordsInner as DomainDnsCheckRecordsInner
 from pingram.models.email_auth_token_post_request import EmailAuthTokenPostRequest as EmailAuthTokenPostRequest
 from pingram.models.email_component_patch_request import EmailComponentPatchRequest as EmailComponentPatchRequest
 from pingram.models.email_component_post_request import EmailComponentPostRequest as EmailComponentPostRequest
@@ -428,6 +436,10 @@ from pingram.models.logs_query_response import LogsQueryResponse as LogsQueryRes
 from pingram.models.logs_query_result_response import LogsQueryResultResponse as LogsQueryResultResponse
 from pingram.models.logs_retention_response import LogsRetentionResponse as LogsRetentionResponse
 from pingram.models.logs_tail_response import LogsTailResponse as LogsTailResponse
+from pingram.models.mfa_setup_request import MFASetupRequest as MFASetupRequest
+from pingram.models.mfa_setup_response import MFASetupResponse as MFASetupResponse
+from pingram.models.mfa_status_response import MFAStatusResponse as MFAStatusResponse
+from pingram.models.mfa_verify_request import MFAVerifyRequest as MFAVerifyRequest
 from pingram.models.member_invite_request import MemberInviteRequest as MemberInviteRequest
 from pingram.models.member_update_request import MemberUpdateRequest as MemberUpdateRequest
 from pingram.models.message_response import MessageResponse as MessageResponse

{pingram_python-1.0.14 → pingram_python-1.0.16}/generated/pingram/api/addresses_api.py

@@ -16,9 +16,12 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
+from pydantic import Field, StrictStr
+from typing_extensions import Annotated
 from pingram.models.account_addresses_response import AccountAddressesResponse
 from pingram.models.address_response import AddressResponse
 from pingram.models.create_address_request import CreateAddressRequest
+from pingram.models.success_response import SuccessResponse
 from pingram.models.update_address_request import UpdateAddressRequest
 
 from pingram.api_client import ApiClient, RequestSerialized
@@ -56,7 +59,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> AddressResponse:
-        """Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.
+        """Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.
 
 
         :param create_address_request: (required)
@@ -127,7 +130,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[AddressResponse]:
-        """Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.
+        """Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.
 
 
         :param create_address_request: (required)
@@ -198,7 +201,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.
+        """Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.
 
 
         :param create_address_request: (required)
@@ -328,6 +331,282 @@ class AddressesApi:
 
 
 
+    @validate_call
+    async def addresses_delete_address(
+        self,
+        full_address: Annotated[StrictStr, Field(description="Full address to delete (e.g. hello@example.com)")],
+        _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,
+    ) -> SuccessResponse:
+        """Delete a custom inbound address. Builtin addresses cannot be deleted.
+
+
+        :param full_address: Full address to delete (e.g. hello@example.com) (required)
+        :type full_address: str
+        :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._addresses_delete_address_serialize(
+            full_address=full_address,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SuccessResponse",
+            '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 addresses_delete_address_with_http_info(
+        self,
+        full_address: Annotated[StrictStr, Field(description="Full address to delete (e.g. hello@example.com)")],
+        _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[SuccessResponse]:
+        """Delete a custom inbound address. Builtin addresses cannot be deleted.
+
+
+        :param full_address: Full address to delete (e.g. hello@example.com) (required)
+        :type full_address: str
+        :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._addresses_delete_address_serialize(
+            full_address=full_address,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SuccessResponse",
+            '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 addresses_delete_address_without_preload_content(
+        self,
+        full_address: Annotated[StrictStr, Field(description="Full address to delete (e.g. hello@example.com)")],
+        _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:
+        """Delete a custom inbound address. Builtin addresses cannot be deleted.
+
+
+        :param full_address: Full address to delete (e.g. hello@example.com) (required)
+        :type full_address: str
+        :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._addresses_delete_address_serialize(
+            full_address=full_address,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SuccessResponse",
+            '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 _addresses_delete_address_serialize(
+        self,
+        full_address,
+        _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
+        if full_address is not None:
+            _path_params['fullAddress'] = full_address
+        # 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='DELETE',
+            resource_path='/addresses/{fullAddress}',
+            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 addresses_list_addresses(
         self,
@@ -344,7 +623,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> AccountAddressesResponse:
-        """Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.
+        """List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -411,7 +690,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[AccountAddressesResponse]:
-        """Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.
+        """List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -478,7 +757,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.
+        """List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.
 
 
         :param _request_timeout: timeout setting for this request. If one
@@ -606,7 +885,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> AddressResponse:
-        """Update an existing address
+        """Update an inbox prefix or display name.
 
 
         :param update_address_request: (required)
@@ -677,7 +956,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[AddressResponse]:
-        """Update an existing address
+        """Update an inbox prefix or display name.
 
 
         :param update_address_request: (required)
@@ -748,7 +1027,7 @@ class AddressesApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Update an existing address
+        """Update an inbox prefix or display name.
 
 
         :param update_address_request: (required)

{pingram_python-1.0.14 → pingram_python-1.0.16}/generated/pingram/api/default_api.py

@@ -54,7 +54,7 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> SenderPostResponse:
-        """Send a notification
+        """Send a notification (email, SMS, etc.) to one user. Requires a notification `type` which categorizes this messages for future reporting, and channel-specific payloads such as `email` or `sms`. Recipient is specified with the `to` parameter. Returns a `trackingId` for error or delivery lookup through our Logs.
 
 
         :param sender_post_body: (required)
@@ -125,7 +125,7 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[SenderPostResponse]:
-        """Send a notification
+        """Send a notification (email, SMS, etc.) to one user. Requires a notification `type` which categorizes this messages for future reporting, and channel-specific payloads such as `email` or `sms`. Recipient is specified with the `to` parameter. Returns a `trackingId` for error or delivery lookup through our Logs.
 
 
         :param sender_post_body: (required)
@@ -196,7 +196,7 @@ class DefaultApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Send a notification
+        """Send a notification (email, SMS, etc.) to one user. Requires a notification `type` which categorizes this messages for future reporting, and channel-specific payloads such as `email` or `sms`. Recipient is specified with the `to` parameter. Returns a `trackingId` for error or delivery lookup through our Logs.
 
 
         :param sender_post_body: (required)