clicksend-client

This is an official SDK for ClickSend Below you will find a current list of the available methods for clicksend. NOTE: You will need to create a free account to use the API. You can register here..

This Python package is automatically generated by the Swagger Codegen project:

• API version: 3.1
• Package version: 1.0.0
• Build package: io.clicksend.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importclicksend_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importclicksend_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ importprint_functionimporttimeimportclicksend_clientfromclicksend_client.restimportApiExceptionfrompprintimportpprint# Configure HTTP basic authorization: BasicAuthconfiguration=clicksend_client.Configuration()
configuration.username='YOUR_USERNAME'configuration.password='YOUR_PASSWORD'# create an instance of the API classapi_instance=clicksend_client.AccountApi(clicksend_client.ApiClient(configuration))
try:
# Get account informationapi_response=api_instance.account_get()
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling AccountApi->account_get: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to https://rest.clicksend.com/v3

Class	Method	HTTP request	Description
AccountApi	account_get	GET /account	Get account information
AccountApi	account_post	POST /account	Create a new account
AccountApi	account_useage_by_subaccount_get	GET /account/usage/{year}/{month}/subaccount	Get account useage by subaccount
AccountApi	account_verify_send_put	PUT /account-verify/send	Send account activation token
AccountApi	account_verify_verify_by_activation_token_put	PUT /account-verify/verify/{activation_token}	Verify new account
AccountApi	forgot_password_put	PUT /forgot-password	Forgot password
AccountApi	forgot_password_verify_put	PUT /forgot-password/verify	Verify forgot password
AccountApi	forgot_username_put	PUT /forgot-username	Forgot username
AccountRechargeApi	recharge_credit_card_get	GET /recharge/credit-card	Get Credit Card info
AccountRechargeApi	recharge_credit_card_put	PUT /recharge/credit-card	Update credit card info
AccountRechargeApi	recharge_packages_get	GET /recharge/packages	Get list of all packages
AccountRechargeApi	recharge_purchase_by_package_id_put	PUT /recharge/purchase/{package_id}	Purchase a package
AccountRechargeApi	recharge_transactions_by_transaction_id_get	GET /recharge/transactions/{transaction_id}	Get specific Transaction
AccountRechargeApi	recharge_transactions_get	GET /recharge/transactions	Purchase a package
ContactApi	lists_contacts_by_list_id_and_contact_id_delete	DELETE /lists/{list_id}/contacts/{contact_id}	Delete a contact
ContactApi	lists_contacts_by_list_id_and_contact_id_get	GET /lists/{list_id}/contacts/{contact_id}	Get a specific contact
ContactApi	lists_contacts_by_list_id_and_contact_id_put	PUT /lists/{list_id}/contacts/{contact_id}	Update specific contact
ContactApi	lists_contacts_by_list_id_get	GET /lists/{list_id}/contacts	Get all contacts in a list
ContactApi	lists_contacts_by_list_id_post	POST /lists/{list_id}/contacts	Create new contact
ContactApi	lists_copy_contact_put	PUT /lists/{from_list_id}/contacts/{contact_id}/copy/{to_list_id}	Copy contact to another list
ContactApi	lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put	PUT /lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}	Remove all opted out contacts
ContactApi	lists_transfer_contact_put	PUT /lists/{from_list_id}/contacts/{contact_id}/transfer/{to_list_id}	Transfer contact to another list
ContactListApi	lists_by_list_id_delete	DELETE /lists/{list_id}	ListsByListIdDelete
ContactListApi	lists_by_list_id_get	GET /lists/{list_id}	Get specific contact list
ContactListApi	lists_by_list_id_put	PUT /lists/{list_id}	Update specific contact list
ContactListApi	lists_get	GET /lists	Get all contact lists
ContactListApi	lists_import_by_list_id_post	POST /lists/{list_id}/import	Import contacts to list
ContactListApi	lists_post	POST /lists	Create new contact list
ContactListApi	lists_remove_duplicates_by_list_id_put	PUT /lists/{list_id}/remove-duplicates	Remove duplicate contacts
CountriesApi	countries_get	GET /countries	Get all country codes
DeliveryIssuesApi	delivery_issues_get	GET /delivery-issues	Get all delivery issues
DeliveryIssuesApi	delivery_issues_post	POST /delivery-issues	Create delivery Issue
DetectAddressApi	detect_address_post	POST /post/letters/detect-address	Detects address in uploaded file.
EmailDeliveryReceiptRulesApi	email_delivery_receipt_automation_delete	DELETE /automations/email/receipts/{receipt_rule_id}	Delete email delivery receipt automation
EmailDeliveryReceiptRulesApi	email_delivery_receipt_automation_get	GET /automations/email/receipts/{receipt_rule_id}	Get specific email delivery receipt automation
EmailDeliveryReceiptRulesApi	email_delivery_receipt_automation_post	POST /automations/email/receipts	Create email delivery receipt automations
EmailDeliveryReceiptRulesApi	email_delivery_receipt_automation_put	PUT /automations/email/receipts/{receipt_rule_id}	Update email delivery receipt automation
EmailDeliveryReceiptRulesApi	email_delivery_receipt_automations_get	GET /automations/email/receipts	Get all email delivery receipt automations
EmailMarketingApi	allowed_email_address_get	GET /email/addresses	Get all email addresses
EmailMarketingApi	allowed_email_address_post	POST /email/addresses	Create allowed Email Address
EmailMarketingApi	cancel_email_campaign_put	PUT /email-campaigns/{email_campaign_id}/cancel	Cancel email campaign
EmailMarketingApi	email_campaign_get	GET /email-campaigns/{email_campaign_id}	Get specific email campaign
EmailMarketingApi	email_campaign_history_export_get	GET /email-campaigns/{email_campaign_id}/history/export	Export specific email campaign history
EmailMarketingApi	email_campaign_history_get	GET /email-campaigns/{email_campaign_id}/history	Get specific email campaign history
EmailMarketingApi	email_campaign_post	POST /email-campaigns/send	Send email campaign
EmailMarketingApi	email_campaign_price_post	POST /email-campaigns/price	Calculate email campaign price
EmailMarketingApi	email_campaign_put	PUT /email-campaigns/{email_campaign_id}	Edit email campaign
EmailMarketingApi	email_campaigns_get	GET /email-campaigns	Get all email campaigns
EmailMarketingApi	send_verification_token_get	PUT /email/address-verify/{email_address_id}/send	Send verification token
EmailMarketingApi	specific_allowed_email_address_delete	DELETE /email/addresses/{email_address_id}	Delete specific email address
EmailMarketingApi	specific_allowed_email_address_get	GET /email/addresses/{email_address_id}	Get specific email address
EmailMarketingApi	verify_allowed_email_address_get	PUT /email/address-verify/{email_address_id}/verify/{activation_token}	Verify email address using verification token
EmailToSmsApi	sms_email_sms_get	GET /sms/email-sms	Get list of email to sms allowed addresses
EmailToSmsApi	sms_email_sms_post	POST /sms/email-sms	Create email to sms allowed address
EmailToSmsApi	sms_email_sms_stripped_string_delete	DELETE /sms/email-sms-stripped-strings/{rule_id}	Delete email to sms stripped string rule
EmailToSmsApi	sms_email_sms_stripped_string_get	GET /sms/email-sms-stripped-strings/{rule_id}	Get email to sms stripped string rule
EmailToSmsApi	sms_email_sms_stripped_string_post	POST /sms/email-sms-stripped-strings	Create email to sms stripped string rule
EmailToSmsApi	sms_email_sms_stripped_string_put	PUT /sms/email-sms-stripped-strings/{rule_id}	Update email to sms stripped string rule
EmailToSmsApi	sms_email_sms_stripped_strings_get	GET /sms/email-sms-stripped-strings	Get list of email to sms stripped string rules
FAXApi	fax_history_get	GET /fax/history	Get a list of Fax History.
FAXApi	fax_price_post	POST /fax/price	Calculate Total Price for Fax Messages sent
FAXApi	fax_receipts_by_message_id_get	GET /fax/receipts/{message_id}	Get a single fax receipt based on message id.
FAXApi	fax_receipts_get	GET /fax/receipts	Get all delivery receipts
FAXApi	fax_receipts_post	POST /fax/receipts	Add a delivery receipt
FAXApi	fax_receipts_read_put	PUT /fax/receipts-read	Mark delivery receipts as read
FAXApi	fax_send_post	POST /fax/send	Send a fax using supplied supported file-types.
FAXDeliveryReceiptRulesApi	fax_delivery_receipt_automation_delete	DELETE /automations/fax/receipts/{receipt_rule_id}	Delete fax delivery receipt automation
FAXDeliveryReceiptRulesApi	fax_delivery_receipt_automation_get	GET /automations/fax/receipts/{receipt_rule_id}	Get specific fax delivery receipt automation
FAXDeliveryReceiptRulesApi	fax_delivery_receipt_automation_post	POST /automations/fax/receipts	Create fax delivery receipt automations
FAXDeliveryReceiptRulesApi	fax_delivery_receipt_automation_put	PUT /automations/fax/receipts/{receipt_rule_id}	Update fax delivery receipt automation
FAXDeliveryReceiptRulesApi	fax_delivery_receipt_automations_get	GET /automations/fax/receipts	Get all fax delivery receipt automations
GlobalSendingApi	list_countries_get	GET /country-list	List of countries
GlobalSendingApi	user_countries_agree_post	POST /user-countries/agree	Agree to rules and regulation
GlobalSendingApi	user_countries_get	GET /user-countries	Get Countries for Global Sending
GlobalSendingApi	user_countries_post	POST /user-countries	Select Countries for Global Sending
InboundFAXRulesApi	fax_inbound_automation_delete	DELETE /automations/fax/inbound/{inbound_rule_id}	Delete inbound fax automation
InboundFAXRulesApi	fax_inbound_automation_get	GET /automations/fax/inbound/{inbound_rule_id}	Get specific inbound fax automation
InboundFAXRulesApi	fax_inbound_automation_post	POST /automations/fax/inbound	Create new inbound fax automation
InboundFAXRulesApi	fax_inbound_automation_put	PUT /automations/fax/inbound/{inbound_rule_id}	Update inbound fax automation
InboundFAXRulesApi	fax_inbound_automations_get	GET /automations/fax/inbound	Get all inbound fax automations
InboundSMSRulesApi	sms_inbound_automation_delete	DELETE /automations/sms/inbound/{inbound_rule_id}	Delete inbound sms automation
InboundSMSRulesApi	sms_inbound_automation_get	GET /automations/sms/inbound/{inbound_rule_id}	Get specific inbound sms automation
InboundSMSRulesApi	sms_inbound_automation_post	POST /automations/sms/inbound	Create new inbound sms automation
InboundSMSRulesApi	sms_inbound_automation_put	PUT /automations/sms/inbound/{inbound_rule_id}	Update inbound sms automation
InboundSMSRulesApi	sms_inbound_automations_get	GET /automations/sms/inbound	Get all inbound sms automations
MMSApi	mms_history_export_get	GET /mms/history/export	Export all mms history
MMSApi	mms_history_get	GET /mms/history	Get all mms history
MMSApi	mms_price_post	POST /mms/price	Get Price for MMS sent
MMSApi	mms_receipts_get	GET /mms/receipts	Get all delivery receipts
MMSApi	mms_receipts_read_put	PUT /mms/receipts-read	Mark delivery receipts as read
MMSApi	mms_send_post	POST /mms/send	Send MMS
MasterEmailTemplatesApi	master_email_template_categories_get	GET /email/master-templates-categories	Get all master email template categories
MasterEmailTemplatesApi	master_email_template_category_get	GET /email/master-templates-categories/{category_id}	Get specific master email template category
MasterEmailTemplatesApi	master_email_template_get	GET /email/master-templates/{template_id}	Get specific master email template
MasterEmailTemplatesApi	master_email_templates_get	GET /email/master-templates	Get all master email templates
MasterEmailTemplatesApi	master_email_templates_in_category_get	GET /email/master-templates-categories/{category_id}/master-templates	Get all master email templates in a category
MmsCampaignApi	mms_campaign_by_mms_campaign_id_get	GET /mms-campaigns/{mms_campaign_id}	Get specific mms campaign
MmsCampaignApi	mms_campaigns_by_mms_campaign_id_put	PUT /mms-campaigns/{mms_campaign_id}	Update mms campaign
MmsCampaignApi	mms_campaigns_cancel_by_mms_campaign_id_put	PUT /mms-campaigns/{mms_campaign_id}/cancel	Cancel mms campaign
MmsCampaignApi	mms_campaigns_get	GET /mms-campaigns	Get list of mms campaigns
MmsCampaignApi	mms_campaigns_price_post	POST /mms-campaigns/price	Calculate price for mms campaign
MmsCampaignApi	mms_campaigns_send_post	POST /mms-campaigns/send	Create mms campaign
NumberApi	numbers_buy_by_dedicated_number_post	POST /numbers/buy/{dedicated_number}	Buy dedicated number
NumberApi	numbers_get	GET /numbers	Get all availible dedicated numbers
NumberApi	numbers_search_by_country_get	GET /numbers/search/{country}	Get all dedicated numbers by country
PostLetterApi	post_letters_export_get	GET /post/letters/history/export	export post letter history
PostLetterApi	post_letters_history_get	GET /post/letters/history	Get all post letter history
PostLetterApi	post_letters_price_post	POST /post/letters/price	Calculate post letter price
PostLetterApi	post_letters_send_post	POST /post/letters/send	Send post letter
PostPostcardApi	post_postcards_history_export_get	GET /post/postcards/history/export	Export postcard history to a CSV file
PostPostcardApi	post_postcards_history_get	GET /post/postcards/history	Retrieve the history of postcards sent or scheduled
PostPostcardApi	post_postcards_price_post	POST /post/postcards/price	Calculate price for sending one or more postcards
PostPostcardApi	post_postcards_send_post	POST /post/postcards/send	Send one or more postcards
PostReturnAddressApi	post_return_addresses_by_return_address_id_delete	DELETE /post/return-addresses/{return_address_id}	Delete specific post return address
PostReturnAddressApi	post_return_addresses_by_return_address_id_get	GET /post/return-addresses/{return_address_id}	Get specific post return address
PostReturnAddressApi	post_return_addresses_by_return_address_id_put	PUT /post/return-addresses/{return_address_id}	Update post return address
PostReturnAddressApi	post_return_addresses_get	GET /post/return-addresses	Get list of post return addresses
PostReturnAddressApi	post_return_addresses_post	POST /post/return-addresses	Create post return address
ReferralAccountApi	referral_accounts_get	GET /referral/accounts	Get all referral accounts
ResellerAccountApi	reseller_accounts_by_client_user_id_get	GET /reseller/accounts/{client_user_id}	Get Reseller clients Account
ResellerAccountApi	reseller_accounts_by_client_user_id_put	PUT /reseller/accounts/{client_user_id}	Update Reseller clients Account
ResellerAccountApi	reseller_accounts_get	GET /reseller/accounts	Get list of reseller accounts
ResellerAccountApi	reseller_accounts_post	POST /reseller/accounts	Create reseller account
SMSApi	sms_cancel_all_put	PUT /sms/cancel-all	Update all scheduled message as cancelled
SMSApi	sms_cancel_by_message_id_put	PUT /sms/{message_id}/cancel	Update scheduled message as cancelled
SMSApi	sms_history_export_get	GET /sms/history/export	Export all sms history
SMSApi	sms_history_get	GET /sms/history	Get all sms history
SMSApi	sms_inbound_get	GET /sms/inbound	Get all inbound sms
SMSApi	sms_inbound_post	POST /sms/inbound	Create inbound sms
SMSApi	sms_inbound_read_by_message_id_put	PUT /sms/inbound-read/{message_id}	Mark inbound SMS as read
SMSApi	sms_inbound_read_put	PUT /sms/inbound-read	Mark inbound SMS as read
SMSApi	sms_price_post	POST /sms/price	Calculate sms price
SMSApi	sms_receipts_by_message_id_get	GET /sms/receipts/{message_id}	Get a Specific Delivery Receipt
SMSApi	sms_receipts_get	GET /sms/receipts	Get all delivery receipts
SMSApi	sms_receipts_post	POST /sms/receipts	Add a delivery receipt
SMSApi	sms_receipts_read_put	PUT /sms/receipts-read	Mark delivery receipts as read
SMSApi	sms_send_post	POST /sms/send	Send sms message(s)
SMSApi	sms_templates_by_template_id_delete	DELETE /sms/templates/{template_id}	Delete sms template
SMSApi	sms_templates_by_template_id_put	PUT /sms/templates/{template_id}	Update sms template
SMSApi	sms_templates_get	GET /sms/templates	Get lists of all sms templates
SMSApi	sms_templates_post	POST /sms/templates	Create sms template
SMSDeliveryReceiptRulesApi	sms_delivery_receipt_automation_delete	DELETE /automations/sms/receipts/{receipt_rule_id}	Delete sms delivery receipt automation
SMSDeliveryReceiptRulesApi	sms_delivery_receipt_automation_get	GET /automations/sms/receipts/{receipt_rule_id}	Get specific sms delivery receipt automation
SMSDeliveryReceiptRulesApi	sms_delivery_receipt_automation_post	POST /automations/sms/receipts	Create sms delivery receipt automations
SMSDeliveryReceiptRulesApi	sms_delivery_receipt_automation_put	PUT /automations/sms/receipts/{receipt_rule_id}	Update sms delivery receipt automation
SMSDeliveryReceiptRulesApi	sms_delivery_receipt_automations_get	GET /automations/sms/receipts	Get all sms delivery receipt automations
SearchApi	search_contacts_lists_get	GET /search/contacts-lists	Get list of searched contact list
SmsCampaignApi	sms_campaign_by_sms_campaign_id_get	GET /sms-campaigns/{sms_campaign_id}	Get specific sms campaign
SmsCampaignApi	sms_campaigns_by_sms_campaign_id_put	PUT /sms-campaigns/{sms_campaign_id}	Update sms campaign
SmsCampaignApi	sms_campaigns_cancel_by_sms_campaign_id_put	PUT /sms-campaigns/{sms_campaign_id}/cancel	Cancel sms campaign
SmsCampaignApi	sms_campaigns_get	GET /sms-campaigns	Get list of sms campaigns
SmsCampaignApi	sms_campaigns_price_post	POST /sms-campaigns/price	Calculate price for sms campaign
SmsCampaignApi	sms_campaigns_send_post	POST /sms-campaigns/send	Create sms campaign
StatisticsApi	statistics_sms_get	GET /statistics/sms	Get sms statistics
StatisticsApi	statistics_voice_get	GET /statistics/voice	Get voice statistics
SubaccountApi	subaccounts_by_subaccount_id_delete	DELETE /subaccounts/{subaccount_id}	Delete a subaccount
SubaccountApi	subaccounts_by_subaccount_id_get	GET /subaccounts/{subaccount_id}	Get specific subaccount
SubaccountApi	subaccounts_by_subaccount_id_put	PUT /subaccounts/{subaccount_id}	Update subaccount
SubaccountApi	subaccounts_get	GET /subaccounts	Get all subaccounts
SubaccountApi	subaccounts_post	POST /subaccounts	Create new subaccount
SubaccountApi	subaccounts_regen_api_key_by_subaccount_id_put	PUT /subaccounts/{subaccount_id}/regen-api-key	Regenerate an API Key
TimezonesApi	timezones_get	GET /timezones	Get supported list of timezones.
TransactionalEmailApi	email_history_export_get	GET /email/history/export	Export all Transactional Email history
TransactionalEmailApi	email_history_get	GET /email/history	Get all transactional email history
TransactionalEmailApi	email_price_post	POST /email/price	Get transactional email price
TransactionalEmailApi	email_send_post	POST /email/send	Send transactional email
TransferCreditApi	reseller_transfer_credit_put	PUT /reseller/transfer-credit	Transfer Credit
UploadApi	uploads_post	POST /uploads	Upload File
UserEmailTemplatesApi	email_template_delete	DELETE /email/templates/{template_id}	Delete user email template
UserEmailTemplatesApi	email_template_get	GET /email/templates/{template_id}	Get specific user email template
UserEmailTemplatesApi	email_template_post	POST /email/templates	Create email template
UserEmailTemplatesApi	email_template_put	PUT /email/templates/{template_id}	Update email template
UserEmailTemplatesApi	email_templates_get	GET /email/templates	Get all user email templates
VoiceApi	voice_cancel_all_put	PUT /voice/cancel-all	Update all voice messages as cancelled
VoiceApi	voice_cancel_by_message_id_put	PUT /voice/{message_id}/cancel	Update voice message status as cancelled
VoiceApi	voice_history_export_get	GET /voice/history/export	Export voice history
VoiceApi	voice_history_get	GET /voice/history	Get all voice history
VoiceApi	voice_lang_get	GET /voice/lang	Get all voice languages
VoiceApi	voice_price_post	POST /voice/price	Calculate voice price
VoiceApi	voice_receipts_get	GET /voice/receipts	Get all delivery receipts
VoiceApi	voice_receipts_post	POST /voice/receipts	Add a delivery receipt
VoiceApi	voice_receipts_read_put	PUT /voice/receipts-read	Mark delivery receipts as read
VoiceApi	voice_send_post	POST /voice/send	Send voice message(s)
VoiceDeliveryReceiptRulesApi	voice_delivery_receipt_automation_delete	DELETE /automations/voice/receipts/{receipt_rule_id}	Delete voice delivery receipt automation
VoiceDeliveryReceiptRulesApi	voice_delivery_receipt_automation_get	GET /automations/voice/receipts/{receipt_rule_id}	Get specific voice delivery receipt automation
VoiceDeliveryReceiptRulesApi	voice_delivery_receipt_automation_post	POST /automations/voice/receipts	Create voice delivery receipt automations
VoiceDeliveryReceiptRulesApi	voice_delivery_receipt_automation_put	PUT /automations/voice/receipts/{receipt_rule_id}	Update voice delivery receipt automation
VoiceDeliveryReceiptRulesApi	voice_delivery_receipt_automations_get	GET /automations/voice/receipts	Get all voice delivery receipt automations

Documentation For Models

• Account
• AccountForgotPasswordVerify
• AccountVerify
• Address
• Attachment
• Contact
• ContactList
• ContactListImport
• CountryListIds
• CreditCard
• DateBefore
• DeliveryIssue
• DeliveryReceiptRule
• Email
• EmailAddress
• EmailCampaign
• EmailFrom
• EmailRecipient
• EmailSMSAddress
• EmailTemplateNew
• EmailTemplateUpdate
• FaxMessage
• FaxMessageCollection
• Fields
• FieldsFields
• ForgotPassword
• ForgotUsername
• InboundFaxRule
• InboundSMSRule
• MmsCampaign
• MmsMessage
• MmsMessageCollection
• PostLetter
• PostPostcard
• PostRecipient
• ResellerAccount
• ResellerAccountTransferCredit
• SmsCampaign
• SmsMessage
• SmsMessageCollection
• SmsTemplate
• StrippedString
• Subaccount
• UploadFile
• Url
• VoiceMessage
• VoiceMessageCollection

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication

Author

support@clicksend.com