Module: ClickSendClient

Defined in:
lib/clicksend_client/version.rb,
lib/clicksend_client.rb,
lib/clicksend_client/api_error.rb,
lib/clicksend_client/api_client.rb,
lib/clicksend_client/models/url.rb,
lib/clicksend_client/api/fax_api.rb,
lib/clicksend_client/api/mms_api.rb,
lib/clicksend_client/api/sms_api.rb,
lib/clicksend_client/models/email.rb,
lib/clicksend_client/api/voice_api.rb,
lib/clicksend_client/configuration.rb,
lib/clicksend_client/models/fields.rb,
lib/clicksend_client/api/number_api.rb,
lib/clicksend_client/api/search_api.rb,
lib/clicksend_client/api/upload_api.rb,
lib/clicksend_client/models/account.rb,
lib/clicksend_client/models/address.rb,
lib/clicksend_client/models/contact.rb,
lib/clicksend_client/api/account_api.rb,
lib/clicksend_client/api/contact_api.rb,
lib/clicksend_client/api/countries_api.rb,
lib/clicksend_client/api/timezones_api.rb,
lib/clicksend_client/models/attachment.rb,
lib/clicksend_client/models/email_from.rb,
lib/clicksend_client/models/subaccount.rb,
lib/clicksend_client/api/statistics_api.rb,
lib/clicksend_client/api/subaccount_api.rb,
lib/clicksend_client/models/credit_card.rb,
lib/clicksend_client/models/date_before.rb,
lib/clicksend_client/models/fax_message.rb,
lib/clicksend_client/models/mms_message.rb,
lib/clicksend_client/models/post_letter.rb,
lib/clicksend_client/models/sms_message.rb,
lib/clicksend_client/models/upload_file.rb,
lib/clicksend_client/api/post_letter_api.rb,
lib/clicksend_client/models/contact_list.rb,
lib/clicksend_client/models/mms_campaign.rb,
lib/clicksend_client/models/sms_campaign.rb,
lib/clicksend_client/models/sms_template.rb,
lib/clicksend_client/api/contact_list_api.rb,
lib/clicksend_client/api/email_to_sms_api.rb,
lib/clicksend_client/api/mms_campaign_api.rb,
lib/clicksend_client/api/sms_campaign_api.rb,
lib/clicksend_client/models/email_address.rb,
lib/clicksend_client/models/fields_fields.rb,
lib/clicksend_client/models/post_postcard.rb,
lib/clicksend_client/models/voice_message.rb,
lib/clicksend_client/api/post_postcard_api.rb,
lib/clicksend_client/models/account_verify.rb,
lib/clicksend_client/models/delivery_issue.rb,
lib/clicksend_client/models/email_campaign.rb,
lib/clicksend_client/models/post_recipient.rb,
lib/clicksend_client/api/detect_address_api.rb,
lib/clicksend_client/models/email_recipient.rb,
lib/clicksend_client/models/forgot_password.rb,
lib/clicksend_client/models/forgot_username.rb,
lib/clicksend_client/models/stripped_string.rb,
lib/clicksend_client/api/delivery_issues_api.rb,
lib/clicksend_client/api/email_marketing_api.rb,
lib/clicksend_client/api/transfer_credit_api.rb,
lib/clicksend_client/models/inbound_fax_rule.rb,
lib/clicksend_client/models/inbound_sms_rule.rb,
lib/clicksend_client/models/reseller_account.rb,
lib/clicksend_client/api/account_recharge_api.rb,
lib/clicksend_client/api/referral_account_api.rb,
lib/clicksend_client/api/reseller_account_api.rb,
lib/clicksend_client/models/email_sms_address.rb,
lib/clicksend_client/api/inbound_fax_rules_api.rb,
lib/clicksend_client/api/inbound_sms_rules_api.rb,
lib/clicksend_client/models/email_template_new.rb,
lib/clicksend_client/models/contact_list_import.rb,
lib/clicksend_client/api/post_return_address_api.rb,
lib/clicksend_client/api/transactional_email_api.rb,
lib/clicksend_client/api/user_email_templates_api.rb,
lib/clicksend_client/models/delivery_receipt_rule.rb,
lib/clicksend_client/models/email_template_update.rb,
lib/clicksend_client/models/fax_message_collection.rb,
lib/clicksend_client/models/mms_message_collection.rb,
lib/clicksend_client/models/sms_message_collection.rb,
lib/clicksend_client/api/master_email_templates_api.rb,
lib/clicksend_client/models/voice_message_collection.rb,
lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb,
lib/clicksend_client/api/sms_delivery_receipt_rules_api.rb,
lib/clicksend_client/api/email_delivery_receipt_rules_api.rb,
lib/clicksend_client/api/voice_delivery_receipt_rules_api.rb,
lib/clicksend_client/models/account_forgot_password_verify.rb,
lib/clicksend_client/models/reseller_account_transfer_credit.rb

Overview

#ClickSend v3 API

# This is an official SDK for [ClickSend](clicksend.com) 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](dashboard.clicksend.com/#/signup/step1/)..*

OpenAPI spec version: 3.1 Contact: [email protected] Generated by: github.com/clicksend-api/clicksend-codegen.git ClickSend Codegen version: 2.4.22-SNAPSHOT

Defined Under Namespace

Classes: Account, AccountApi, AccountForgotPasswordVerify, AccountRechargeApi, AccountVerify, Address, ApiClient, ApiError, Attachment, Configuration, Contact, ContactApi, ContactList, ContactListApi, ContactListImport, CountriesApi, CreditCard, DateBefore, DeliveryIssue, DeliveryIssuesApi, DeliveryReceiptRule, DetectAddressApi, Email, EmailAddress, EmailCampaign, EmailDeliveryReceiptRulesApi, EmailFrom, EmailMarketingApi, EmailRecipient, EmailSMSAddress, EmailTemplateNew, EmailTemplateUpdate, EmailToSmsApi, FAXApi, FAXDeliveryReceiptRulesApi, FaxMessage, FaxMessageCollection, Fields, FieldsFields, ForgotPassword, ForgotUsername, InboundFAXRulesApi, InboundFaxRule, InboundSMSRule, InboundSMSRulesApi, MMSApi, MasterEmailTemplatesApi, MmsCampaign, MmsCampaignApi, MmsMessage, MmsMessageCollection, NumberApi, PostLetter, PostLetterApi, PostPostcard, PostPostcardApi, PostRecipient, PostReturnAddressApi, ReferralAccountApi, ResellerAccount, ResellerAccountApi, ResellerAccountTransferCredit, SMSApi, SMSDeliveryReceiptRulesApi, SearchApi, SmsCampaign, SmsCampaignApi, SmsMessage, SmsMessageCollection, SmsTemplate, StatisticsApi, StrippedString, Subaccount, SubaccountApi, TimezonesApi, TransactionalEmailApi, TransferCreditApi, UploadApi, UploadFile, Url, UserEmailTemplatesApi, VoiceApi, VoiceDeliveryReceiptRulesApi, VoiceMessage, VoiceMessageCollection

Constant Summary collapse

VERSION = 
'5.0.75'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

ClickSendClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



113
114
115
116
117
118
119
 
# File 'lib/clicksend_client.rb', line 113

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end