ClicksendsmsClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'sms_inbound_automation': {'operation_id': 'sms_inbound_automation', 'path': '/{connectionId}/ms-flow/automations/sms/inbound', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}}
Classes
dataclass
dataclass
SmsSendResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send SMS
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Msg
dataclass
dataclass
CreateListResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Create New Contact List
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
GetContactListsResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Get Contact Lists
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
dataclass
SendVoiceResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send Voice Message
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
DeleteListResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None)
Response for Delete List
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
dataclass
CreateListContactInput(first_name: str, last_name: str, phone_number: str, *, email: Optional[str] = None, fax_number: Optional[str] = None, organization_name: Optional[str] = None, address_country: Optional[str] = None, address_state: Optional[str] = None, address_city: Optional[str] = None, custom1: Optional[str] = None, custom3: Optional[str] = None, address_postal_code: Optional[str] = None, custom2: Optional[str] = None, custom4: Optional[str] = None, address_line1: Optional[str] = None, address_line2: Optional[str] = None)
Create New Contact
Attributes
instance-attribute
The contact phone in local or international format e.g. +61411111111.
class-attribute
instance-attribute
Contact's email address.
class-attribute
instance-attribute
Contact's fax number.
class-attribute
instance-attribute
Contact's organization name.
class-attribute
instance-attribute
The contact's country.
class-attribute
instance-attribute
State
class-attribute
instance-attribute
Address City
class-attribute
instance-attribute
custom1: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'custom_1'})
Custom 1
class-attribute
instance-attribute
custom3: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'custom_3'})
Custom 3
class-attribute
instance-attribute
custom2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'custom_2'})
Custom 2
class-attribute
instance-attribute
custom4: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'custom_4'})
Custom 4
dataclass
CreateListContactResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Create New Contact
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
ViewListContactsResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Get Contacts in a List
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
DeleteListContactResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None)
Response for Delete a Contact
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
dataclass
dataclass
SendMmsResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send MMS
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
dataclass
SendFaxResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send Fax
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
dataclass
UploadMediaResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Convert Media File Format
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
SearchContactListResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Search Contact Lists
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
SendLetterInput(file_url: str, colour: int, duplex: int, recipients: List[Dict[str, Any]], source: str, *, template_used: Optional[int] = None, priority_post: Optional[int] = None)
Send Letter
Attributes
instance-attribute
Maximum file size is 10 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications.
class-attribute
instance-attribute
Whether using letter template. Flag value must be 1 for yes or 0 for no.
instance-attribute
Choose to use colour or B&W printing. (Black & White = 0, Colour = 1)
instance-attribute
Choose to use Duplex = 1 (double-sided) or Simplex = 0(single sided) printing.
class-attribute
instance-attribute
Whether letter is priority, Flag value must be 1 for yes or 0 for no.
dataclass
SendLetterResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send Letter
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
dataclass
SendPostcardResponse(*, http_code: Optional[int] = None, response_code: Optional[str] = None, response_msg: Optional[str] = None, data: Optional[Dict[str, Any]] = None)
Response for Send Postcard
Attributes
class-attribute
instance-attribute
Http Code
class-attribute
instance-attribute
Response Code
class-attribute
instance-attribute
Response Message
dataclass
SmsInboundAutomationInput(message_search_type: int, message_search_term: str, action_address: str, dedicated_number: str, rule_name: str, webhook_type: str, action: str, enabled: int)
SMS Inbound Automation
Attributes
instance-attribute
Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
instance-attribute
Decicated Number. Can be '*' to apply to all numbers.
instance-attribute
Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
ClicksendsmsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for clicksendsms connector.
Initialize a ClicksendsmsClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
sms_send(input: SmsSendInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send SMS
Each 160 characters = 1 SMS. Can send up to 1,224 standard characters.
Swagger operation ID: sms_send.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SmsSendInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_list(input: CreateListInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create New Contact List
Create New Contact List
Swagger operation ID: create_list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateListInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_contact_lists(*, page: Optional[int] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Contact Lists
Get all contact lists unless specified in the advance options
Swagger operation ID: get_contact_lists.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
page
|
Optional[int]
|
Page number. |
None
|
limit
|
Optional[int]
|
Number of records per page. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_voice(input: SendVoiceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send Voice Message
Each 300 characters = 1 voice message. Can send up to 1,200 standard characters
Swagger operation ID: send_voice.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendVoiceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
delete_list(list_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete List
Delete a specific contact list
Swagger operation ID: delete_list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_id
|
int
|
You may use the Search Contact List action OR Get Contact List action to get the List ID. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_list_contact(input: CreateListContactInput | Mapping[str, Any], list_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create New Contact
Create New Contact
Swagger operation ID: create_list_contact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateListContactInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
list_id
|
int
|
You may use the Search Contact List action OR Get Contact List action to get the List ID. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
view_list_contacts(list_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Contacts in a List
Get all Contacts in a List
Swagger operation ID: view_list_contacts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_id
|
int
|
You may use the Search Contact List action OR Get Contact List action to get the List ID. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
delete_list_contact(list_id: int, contact_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete a Contact
Delete a Contact
Swagger operation ID: delete_list_contact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_id
|
int
|
You may use the Search Contact List action OR Get Contact List action to get the List ID. |
required |
contact_id
|
int
|
Contact ID. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_mms(input: SendMmsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send MMS
Send MMS
Swagger operation ID: send_mms.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendMmsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_fax(input: SendFaxInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send Fax
Send Fax
Swagger operation ID: send_fax.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendFaxInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
upload_media(input: UploadMediaInput | Mapping[str, Any], convert: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Convert Media File Format
Convert Media File Format
Swagger operation ID: upload_media.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UploadMediaInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
convert
|
str
|
Select action the file is needed for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
search_contact_list(q: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Search Contact Lists
Get list of searched contact list
Swagger operation ID: search_contact_list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q
|
str
|
Search for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_letter(input: SendLetterInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send Letter
Send Letter
Swagger operation ID: send_letter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendLetterInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_postcard(input: SendPostcardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send Postcard
Send one or more postcards
Swagger operation ID: send_postcard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendPostcardInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |