clicksend_client 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +78 -0
- data/Rakefile +8 -0
- data/clicksend_client-1.0.1.gem +0 -0
- data/clicksend_client.gemspec +45 -0
- data/docs/Account.md +15 -0
- data/docs/AccountApi.md +433 -0
- data/docs/AccountForgotPasswordVerify.md +10 -0
- data/docs/AccountRechargeApi.md +330 -0
- data/docs/AccountVerify.md +10 -0
- data/docs/Address.md +14 -0
- data/docs/Attachment.md +12 -0
- data/docs/Contact.md +23 -0
- data/docs/ContactApi.md +416 -0
- data/docs/ContactList.md +8 -0
- data/docs/ContactListApi.md +398 -0
- data/docs/ContactListImport.md +9 -0
- data/docs/CountriesApi.md +50 -0
- data/docs/CreditCard.md +13 -0
- data/docs/DateBefore.md +8 -0
- data/docs/DeliveryIssue.md +12 -0
- data/docs/DeliveryIssuesApi.md +119 -0
- data/docs/DeliveryReceiptRule.md +12 -0
- data/docs/DetectAddressApi.md +62 -0
- data/docs/Email.md +15 -0
- data/docs/EmailAddress.md +8 -0
- data/docs/EmailCampaign.md +15 -0
- data/docs/EmailDeliveryReceiptRulesApi.md +286 -0
- data/docs/EmailFrom.md +9 -0
- data/docs/EmailMarketingApi.md +793 -0
- data/docs/EmailRecipient.md +9 -0
- data/docs/EmailSMSAddress.md +10 -0
- data/docs/EmailTemplateNew.md +9 -0
- data/docs/EmailTemplateUpdate.md +9 -0
- data/docs/EmailToSmsApi.md +395 -0
- data/docs/FAXApi.md +401 -0
- data/docs/FAXDeliveryReceiptRulesApi.md +286 -0
- data/docs/FaxMessage.md +15 -0
- data/docs/FaxMessageCollection.md +9 -0
- data/docs/Fields.md +8 -0
- data/docs/FieldsFields.md +23 -0
- data/docs/ForgotPassword.md +8 -0
- data/docs/ForgotUsername.md +9 -0
- data/docs/InboundFAXRulesApi.md +286 -0
- data/docs/InboundFaxRule.md +12 -0
- data/docs/InboundSMSRule.md +14 -0
- data/docs/InboundSMSRulesApi.md +286 -0
- data/docs/MMSApi.md +228 -0
- data/docs/MasterEmailTemplatesApi.md +290 -0
- data/docs/MmsCampaign.md +14 -0
- data/docs/MmsCampaignApi.md +338 -0
- data/docs/MmsMessage.md +17 -0
- data/docs/MmsMessageCollection.md +9 -0
- data/docs/NumberApi.md +183 -0
- data/docs/PostLetter.md +14 -0
- data/docs/PostLetterApi.md +227 -0
- data/docs/PostPostcard.md +9 -0
- data/docs/PostPostcardApi.md +227 -0
- data/docs/PostRecipient.md +16 -0
- data/docs/PostReturnAddressApi.md +284 -0
- data/docs/ReferralAccountApi.md +65 -0
- data/docs/ResellerAccount.md +15 -0
- data/docs/ResellerAccountApi.md +230 -0
- data/docs/ResellerAccountTransferCredit.md +10 -0
- data/docs/SMSApi.md +999 -0
- data/docs/SMSDeliveryReceiptRulesApi.md +286 -0
- data/docs/SearchApi.md +68 -0
- data/docs/SmsCampaign.md +12 -0
- data/docs/SmsCampaignApi.md +338 -0
- data/docs/SmsMessage.md +16 -0
- data/docs/SmsMessageCollection.md +8 -0
- data/docs/SmsTemplate.md +9 -0
- data/docs/StatisticsApi.md +104 -0
- data/docs/StrippedString.md +8 -0
- data/docs/Subaccount.md +18 -0
- data/docs/SubaccountApi.md +338 -0
- data/docs/TimezonesApi.md +65 -0
- data/docs/TransactionalEmailApi.md +237 -0
- data/docs/TransferCreditApi.md +62 -0
- data/docs/UploadApi.md +65 -0
- data/docs/UploadFile.md +8 -0
- data/docs/Url.md +8 -0
- data/docs/UserEmailTemplatesApi.md +284 -0
- data/docs/VoiceApi.md +547 -0
- data/docs/VoiceDeliveryReceiptRulesApi.md +286 -0
- data/docs/VoiceMessage.md +18 -0
- data/docs/VoiceMessageCollection.md +8 -0
- data/lib/clicksend_client.rb +121 -0
- data/lib/clicksend_client/api/account_api.rb +447 -0
- data/lib/clicksend_client/api/account_recharge_api.rb +346 -0
- data/lib/clicksend_client/api/contact_api.rb +463 -0
- data/lib/clicksend_client/api/contact_list_api.rb +427 -0
- data/lib/clicksend_client/api/countries_api.rb +71 -0
- data/lib/clicksend_client/api/delivery_issues_api.rb +139 -0
- data/lib/clicksend_client/api/detect_address_api.rb +77 -0
- data/lib/clicksend_client/api/email_delivery_receipt_rules_api.rb +310 -0
- data/lib/clicksend_client/api/email_marketing_api.rb +829 -0
- data/lib/clicksend_client/api/email_to_sms_api.rb +423 -0
- data/lib/clicksend_client/api/fax_api.rb +425 -0
- data/lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb +310 -0
- data/lib/clicksend_client/api/inbound_fax_rules_api.rb +310 -0
- data/lib/clicksend_client/api/inbound_sms_rules_api.rb +310 -0
- data/lib/clicksend_client/api/master_email_templates_api.rb +323 -0
- data/lib/clicksend_client/api/mms_api.rb +243 -0
- data/lib/clicksend_client/api/mms_campaign_api.rb +361 -0
- data/lib/clicksend_client/api/number_api.rb +213 -0
- data/lib/clicksend_client/api/post_letter_api.rb +248 -0
- data/lib/clicksend_client/api/post_postcard_api.rb +248 -0
- data/lib/clicksend_client/api/post_return_address_api.rb +307 -0
- data/lib/clicksend_client/api/referral_account_api.rb +85 -0
- data/lib/clicksend_client/api/reseller_account_api.rb +253 -0
- data/lib/clicksend_client/api/search_api.rb +92 -0
- data/lib/clicksend_client/api/sms_api.rb +1032 -0
- data/lib/clicksend_client/api/sms_campaign_api.rb +361 -0
- data/lib/clicksend_client/api/sms_delivery_receipt_rules_api.rb +310 -0
- data/lib/clicksend_client/api/statistics_api.rb +119 -0
- data/lib/clicksend_client/api/subaccount_api.rb +361 -0
- data/lib/clicksend_client/api/timezones_api.rb +85 -0
- data/lib/clicksend_client/api/transactional_email_api.rb +260 -0
- data/lib/clicksend_client/api/transfer_credit_api.rb +77 -0
- data/lib/clicksend_client/api/upload_api.rb +84 -0
- data/lib/clicksend_client/api/user_email_templates_api.rb +307 -0
- data/lib/clicksend_client/api/voice_api.rb +570 -0
- data/lib/clicksend_client/api/voice_delivery_receipt_rules_api.rb +310 -0
- data/lib/clicksend_client/api_client.rb +389 -0
- data/lib/clicksend_client/api_error.rb +38 -0
- data/lib/clicksend_client/configuration.rb +209 -0
- data/lib/clicksend_client/models/account.rb +295 -0
- data/lib/clicksend_client/models/account_forgot_password_verify.rb +219 -0
- data/lib/clicksend_client/models/account_verify.rb +220 -0
- data/lib/clicksend_client/models/address.rb +270 -0
- data/lib/clicksend_client/models/attachment.rb +250 -0
- data/lib/clicksend_client/models/contact.rb +345 -0
- data/lib/clicksend_client/models/contact_list.rb +190 -0
- data/lib/clicksend_client/models/contact_list_import.rb +207 -0
- data/lib/clicksend_client/models/credit_card.rb +265 -0
- data/lib/clicksend_client/models/date_before.rb +185 -0
- data/lib/clicksend_client/models/delivery_issue.rb +240 -0
- data/lib/clicksend_client/models/delivery_receipt_rule.rb +250 -0
- data/lib/clicksend_client/models/email.rb +277 -0
- data/lib/clicksend_client/models/email_address.rb +189 -0
- data/lib/clicksend_client/models/email_campaign.rb +287 -0
- data/lib/clicksend_client/models/email_from.rb +200 -0
- data/lib/clicksend_client/models/email_recipient.rb +200 -0
- data/lib/clicksend_client/models/email_sms_address.rb +215 -0
- data/lib/clicksend_client/models/email_template_new.rb +205 -0
- data/lib/clicksend_client/models/email_template_update.rb +200 -0
- data/lib/clicksend_client/models/fax_message.rb +262 -0
- data/lib/clicksend_client/models/fax_message_collection.rb +207 -0
- data/lib/clicksend_client/models/fields.rb +184 -0
- data/lib/clicksend_client/models/fields_fields.rb +335 -0
- data/lib/clicksend_client/models/forgot_password.rb +189 -0
- data/lib/clicksend_client/models/forgot_username.rb +194 -0
- data/lib/clicksend_client/models/inbound_fax_rule.rb +250 -0
- data/lib/clicksend_client/models/inbound_sms_rule.rb +280 -0
- data/lib/clicksend_client/models/mms_campaign.rb +272 -0
- data/lib/clicksend_client/models/mms_message.rb +294 -0
- data/lib/clicksend_client/models/mms_message_collection.rb +207 -0
- data/lib/clicksend_client/models/post_letter.rb +267 -0
- data/lib/clicksend_client/models/post_postcard.rb +209 -0
- data/lib/clicksend_client/models/post_recipient.rb +302 -0
- data/lib/clicksend_client/models/reseller_account.rb +295 -0
- data/lib/clicksend_client/models/reseller_account_transfer_credit.rb +220 -0
- data/lib/clicksend_client/models/sms_campaign.rb +242 -0
- data/lib/clicksend_client/models/sms_message.rb +279 -0
- data/lib/clicksend_client/models/sms_message_collection.rb +192 -0
- data/lib/clicksend_client/models/sms_template.rb +205 -0
- data/lib/clicksend_client/models/stripped_string.rb +190 -0
- data/lib/clicksend_client/models/subaccount.rb +325 -0
- data/lib/clicksend_client/models/upload_file.rb +190 -0
- data/lib/clicksend_client/models/url.rb +190 -0
- data/lib/clicksend_client/models/voice_message.rb +316 -0
- data/lib/clicksend_client/models/voice_message_collection.rb +192 -0
- data/lib/clicksend_client/version.rb +15 -0
- data/spec/api/account_api_spec.rb +131 -0
- data/spec/api/account_recharge_api_spec.rb +107 -0
- data/spec/api/contact_api_spec.rb +129 -0
- data/spec/api/contact_list_api_spec.rb +123 -0
- data/spec/api/countries_api_spec.rb +46 -0
- data/spec/api/delivery_issues_api_spec.rb +60 -0
- data/spec/api/detect_address_api_spec.rb +47 -0
- data/spec/api/email_delivery_receipt_rules_api_spec.rb +98 -0
- data/spec/api/email_marketing_api_spec.rb +213 -0
- data/spec/api/email_to_sms_api_spec.rb +122 -0
- data/spec/api/fax_api_spec.rb +125 -0
- data/spec/api/fax_delivery_receipt_rules_api_spec.rb +98 -0
- data/spec/api/inbound_fax_rules_api_spec.rb +98 -0
- data/spec/api/inbound_sms_rules_api_spec.rb +98 -0
- data/spec/api/master_email_templates_api_spec.rb +99 -0
- data/spec/api/mms_api_spec.rb +84 -0
- data/spec/api/mms_campaign_api_spec.rb +109 -0
- data/spec/api/number_api_spec.rb +76 -0
- data/spec/api/post_letter_api_spec.rb +84 -0
- data/spec/api/post_postcard_api_spec.rb +84 -0
- data/spec/api/post_return_address_api_spec.rb +97 -0
- data/spec/api/referral_account_api_spec.rb +48 -0
- data/spec/api/reseller_account_api_spec.rb +85 -0
- data/spec/api/search_api_spec.rb +49 -0
- data/spec/api/sms_api_spec.rb +259 -0
- data/spec/api/sms_campaign_api_spec.rb +109 -0
- data/spec/api/sms_delivery_receipt_rules_api_spec.rb +98 -0
- data/spec/api/statistics_api_spec.rb +57 -0
- data/spec/api/subaccount_api_spec.rb +109 -0
- data/spec/api/timezones_api_spec.rb +48 -0
- data/spec/api/transactional_email_api_spec.rb +88 -0
- data/spec/api/transfer_credit_api_spec.rb +47 -0
- data/spec/api/upload_api_spec.rb +48 -0
- data/spec/api/user_email_templates_api_spec.rb +97 -0
- data/spec/api/voice_api_spec.rb +157 -0
- data/spec/api/voice_delivery_receipt_rules_api_spec.rb +98 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_forgot_password_verify_spec.rb +53 -0
- data/spec/models/account_spec.rb +83 -0
- data/spec/models/account_verify_spec.rb +53 -0
- data/spec/models/address_spec.rb +77 -0
- data/spec/models/attachment_spec.rb +65 -0
- data/spec/models/contact_list_import_spec.rb +47 -0
- data/spec/models/contact_list_spec.rb +41 -0
- data/spec/models/contact_spec.rb +131 -0
- data/spec/models/credit_card_spec.rb +71 -0
- data/spec/models/date_before_spec.rb +41 -0
- data/spec/models/delivery_issue_spec.rb +65 -0
- data/spec/models/delivery_receipt_rule_spec.rb +65 -0
- data/spec/models/email_address_spec.rb +41 -0
- data/spec/models/email_campaign_spec.rb +83 -0
- data/spec/models/email_from_spec.rb +47 -0
- data/spec/models/email_recipient_spec.rb +47 -0
- data/spec/models/email_sms_address_spec.rb +53 -0
- data/spec/models/email_spec.rb +83 -0
- data/spec/models/email_template_new_spec.rb +47 -0
- data/spec/models/email_template_update_spec.rb +47 -0
- data/spec/models/fax_message_collection_spec.rb +47 -0
- data/spec/models/fax_message_spec.rb +83 -0
- data/spec/models/fields_fields_spec.rb +131 -0
- data/spec/models/fields_spec.rb +41 -0
- data/spec/models/forgot_password_spec.rb +41 -0
- data/spec/models/forgot_username_spec.rb +47 -0
- data/spec/models/inbound_fax_rule_spec.rb +65 -0
- data/spec/models/inbound_sms_rule_spec.rb +77 -0
- data/spec/models/mms_campaign_spec.rb +77 -0
- data/spec/models/mms_message_collection_spec.rb +47 -0
- data/spec/models/mms_message_spec.rb +95 -0
- data/spec/models/post_letter_spec.rb +77 -0
- data/spec/models/post_postcard_spec.rb +47 -0
- data/spec/models/post_recipient_spec.rb +89 -0
- data/spec/models/reseller_account_spec.rb +83 -0
- data/spec/models/reseller_account_transfer_credit_spec.rb +53 -0
- data/spec/models/sms_campaign_spec.rb +65 -0
- data/spec/models/sms_message_collection_spec.rb +41 -0
- data/spec/models/sms_message_spec.rb +89 -0
- data/spec/models/sms_template_spec.rb +47 -0
- data/spec/models/stripped_string_spec.rb +41 -0
- data/spec/models/subaccount_spec.rb +101 -0
- data/spec/models/upload_file_spec.rb +41 -0
- data/spec/models/url_spec.rb +41 -0
- data/spec/models/voice_message_collection_spec.rb +41 -0
- data/spec/models/voice_message_spec.rb +101 -0
- data/spec/spec_helper.rb +111 -0
- metadata +568 -0
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#ClickSend v3 API
|
|
3
|
+
|
|
4
|
+
# This is an official SDK for [ClickSend](https://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](https://dashboard.clicksend.com/#/signup/step1/)..*
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.1
|
|
7
|
+
Contact: support@clicksend.com
|
|
8
|
+
Generated by: https://github.com/clicksend-api/clicksend-codegen.git
|
|
9
|
+
ClickSend Codegen version: 2.4.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module ClickSendClient
|
|
16
|
+
class SmsCampaignApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get specific sms campaign
|
|
23
|
+
# Get specific sms campaign
|
|
24
|
+
# @param sms_campaign_id ID of SMS campaign to retrieve
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [String]
|
|
27
|
+
def sms_campaign_by_sms_campaign_id_get(sms_campaign_id, opts = {})
|
|
28
|
+
data, _status_code, _headers = sms_campaign_by_sms_campaign_id_get_with_http_info(sms_campaign_id, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Get specific sms campaign
|
|
33
|
+
# Get specific sms campaign
|
|
34
|
+
# @param sms_campaign_id ID of SMS campaign to retrieve
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
37
|
+
def sms_campaign_by_sms_campaign_id_get_with_http_info(sms_campaign_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaign_by_sms_campaign_id_get ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'sms_campaign_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && sms_campaign_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'sms_campaign_id' when calling SmsCampaignApi.sms_campaign_by_sms_campaign_id_get"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/sms-campaigns/{sms_campaign_id}'.sub('{' + 'sms_campaign_id' + '}', sms_campaign_id.to_s)
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
55
|
+
# HTTP header 'Content-Type'
|
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
57
|
+
|
|
58
|
+
# form parameters
|
|
59
|
+
form_params = {}
|
|
60
|
+
|
|
61
|
+
# http body (model)
|
|
62
|
+
post_body = nil
|
|
63
|
+
auth_names = ['BasicAuth']
|
|
64
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
65
|
+
:header_params => header_params,
|
|
66
|
+
:query_params => query_params,
|
|
67
|
+
:form_params => form_params,
|
|
68
|
+
:body => post_body,
|
|
69
|
+
:auth_names => auth_names,
|
|
70
|
+
:return_type => 'String')
|
|
71
|
+
if @api_client.config.debugging
|
|
72
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaign_by_sms_campaign_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
|
+
end
|
|
74
|
+
return data, status_code, headers
|
|
75
|
+
end
|
|
76
|
+
# Update sms campaign
|
|
77
|
+
# Update sms campaign
|
|
78
|
+
# @param sms_campaign_id ID of SMS campaign to update
|
|
79
|
+
# @param campaign SmsCampaign model
|
|
80
|
+
# @param [Hash] opts the optional parameters
|
|
81
|
+
# @return [String]
|
|
82
|
+
def sms_campaigns_by_sms_campaign_id_put(sms_campaign_id, campaign, opts = {})
|
|
83
|
+
data, _status_code, _headers = sms_campaigns_by_sms_campaign_id_put_with_http_info(sms_campaign_id, campaign, opts)
|
|
84
|
+
data
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Update sms campaign
|
|
88
|
+
# Update sms campaign
|
|
89
|
+
# @param sms_campaign_id ID of SMS campaign to update
|
|
90
|
+
# @param campaign SmsCampaign model
|
|
91
|
+
# @param [Hash] opts the optional parameters
|
|
92
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
93
|
+
def sms_campaigns_by_sms_campaign_id_put_with_http_info(sms_campaign_id, campaign, opts = {})
|
|
94
|
+
if @api_client.config.debugging
|
|
95
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaigns_by_sms_campaign_id_put ...'
|
|
96
|
+
end
|
|
97
|
+
# verify the required parameter 'sms_campaign_id' is set
|
|
98
|
+
if @api_client.config.client_side_validation && sms_campaign_id.nil?
|
|
99
|
+
fail ArgumentError, "Missing the required parameter 'sms_campaign_id' when calling SmsCampaignApi.sms_campaigns_by_sms_campaign_id_put"
|
|
100
|
+
end
|
|
101
|
+
# verify the required parameter 'campaign' is set
|
|
102
|
+
if @api_client.config.client_side_validation && campaign.nil?
|
|
103
|
+
fail ArgumentError, "Missing the required parameter 'campaign' when calling SmsCampaignApi.sms_campaigns_by_sms_campaign_id_put"
|
|
104
|
+
end
|
|
105
|
+
# resource path
|
|
106
|
+
local_var_path = '/sms-campaigns/{sms_campaign_id}'.sub('{' + 'sms_campaign_id' + '}', sms_campaign_id.to_s)
|
|
107
|
+
|
|
108
|
+
# query parameters
|
|
109
|
+
query_params = {}
|
|
110
|
+
|
|
111
|
+
# header parameters
|
|
112
|
+
header_params = {}
|
|
113
|
+
# HTTP header 'Accept' (if needed)
|
|
114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
115
|
+
# HTTP header 'Content-Type'
|
|
116
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
117
|
+
|
|
118
|
+
# form parameters
|
|
119
|
+
form_params = {}
|
|
120
|
+
|
|
121
|
+
# http body (model)
|
|
122
|
+
post_body = @api_client.object_to_http_body(campaign)
|
|
123
|
+
auth_names = ['BasicAuth']
|
|
124
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
125
|
+
:header_params => header_params,
|
|
126
|
+
:query_params => query_params,
|
|
127
|
+
:form_params => form_params,
|
|
128
|
+
:body => post_body,
|
|
129
|
+
:auth_names => auth_names,
|
|
130
|
+
:return_type => 'String')
|
|
131
|
+
if @api_client.config.debugging
|
|
132
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaigns_by_sms_campaign_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
133
|
+
end
|
|
134
|
+
return data, status_code, headers
|
|
135
|
+
end
|
|
136
|
+
# Cancel sms campaign
|
|
137
|
+
# Cancel sms campaign
|
|
138
|
+
# @param sms_campaign_id ID of SMS Campaign to cancel
|
|
139
|
+
# @param [Hash] opts the optional parameters
|
|
140
|
+
# @return [String]
|
|
141
|
+
def sms_campaigns_cancel_by_sms_campaign_id_put(sms_campaign_id, opts = {})
|
|
142
|
+
data, _status_code, _headers = sms_campaigns_cancel_by_sms_campaign_id_put_with_http_info(sms_campaign_id, opts)
|
|
143
|
+
data
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Cancel sms campaign
|
|
147
|
+
# Cancel sms campaign
|
|
148
|
+
# @param sms_campaign_id ID of SMS Campaign to cancel
|
|
149
|
+
# @param [Hash] opts the optional parameters
|
|
150
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
151
|
+
def sms_campaigns_cancel_by_sms_campaign_id_put_with_http_info(sms_campaign_id, opts = {})
|
|
152
|
+
if @api_client.config.debugging
|
|
153
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaigns_cancel_by_sms_campaign_id_put ...'
|
|
154
|
+
end
|
|
155
|
+
# verify the required parameter 'sms_campaign_id' is set
|
|
156
|
+
if @api_client.config.client_side_validation && sms_campaign_id.nil?
|
|
157
|
+
fail ArgumentError, "Missing the required parameter 'sms_campaign_id' when calling SmsCampaignApi.sms_campaigns_cancel_by_sms_campaign_id_put"
|
|
158
|
+
end
|
|
159
|
+
# resource path
|
|
160
|
+
local_var_path = '/sms-campaigns/{sms_campaign_id}/cancel'.sub('{' + 'sms_campaign_id' + '}', sms_campaign_id.to_s)
|
|
161
|
+
|
|
162
|
+
# query parameters
|
|
163
|
+
query_params = {}
|
|
164
|
+
|
|
165
|
+
# header parameters
|
|
166
|
+
header_params = {}
|
|
167
|
+
# HTTP header 'Accept' (if needed)
|
|
168
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
169
|
+
# HTTP header 'Content-Type'
|
|
170
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
171
|
+
|
|
172
|
+
# form parameters
|
|
173
|
+
form_params = {}
|
|
174
|
+
|
|
175
|
+
# http body (model)
|
|
176
|
+
post_body = nil
|
|
177
|
+
auth_names = ['BasicAuth']
|
|
178
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
179
|
+
:header_params => header_params,
|
|
180
|
+
:query_params => query_params,
|
|
181
|
+
:form_params => form_params,
|
|
182
|
+
:body => post_body,
|
|
183
|
+
:auth_names => auth_names,
|
|
184
|
+
:return_type => 'String')
|
|
185
|
+
if @api_client.config.debugging
|
|
186
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaigns_cancel_by_sms_campaign_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
187
|
+
end
|
|
188
|
+
return data, status_code, headers
|
|
189
|
+
end
|
|
190
|
+
# Get list of sms campaigns
|
|
191
|
+
# Get list of sms campaigns
|
|
192
|
+
# @param [Hash] opts the optional parameters
|
|
193
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
194
|
+
# @option opts [Integer] :limit Number of records per page (default to 10)
|
|
195
|
+
# @return [String]
|
|
196
|
+
def sms_campaigns_get(opts = {})
|
|
197
|
+
data, _status_code, _headers = sms_campaigns_get_with_http_info(opts)
|
|
198
|
+
data
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Get list of sms campaigns
|
|
202
|
+
# Get list of sms campaigns
|
|
203
|
+
# @param [Hash] opts the optional parameters
|
|
204
|
+
# @option opts [Integer] :page Page number
|
|
205
|
+
# @option opts [Integer] :limit Number of records per page
|
|
206
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
207
|
+
def sms_campaigns_get_with_http_info(opts = {})
|
|
208
|
+
if @api_client.config.debugging
|
|
209
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaigns_get ...'
|
|
210
|
+
end
|
|
211
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
212
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SmsCampaignApi.sms_campaigns_get, must be greater than or equal to 1.'
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
216
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SmsCampaignApi.sms_campaigns_get, must be greater than or equal to 1.'
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# resource path
|
|
220
|
+
local_var_path = '/sms-campaigns'
|
|
221
|
+
|
|
222
|
+
# query parameters
|
|
223
|
+
query_params = {}
|
|
224
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
225
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
226
|
+
|
|
227
|
+
# header parameters
|
|
228
|
+
header_params = {}
|
|
229
|
+
# HTTP header 'Accept' (if needed)
|
|
230
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
231
|
+
# HTTP header 'Content-Type'
|
|
232
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
233
|
+
|
|
234
|
+
# form parameters
|
|
235
|
+
form_params = {}
|
|
236
|
+
|
|
237
|
+
# http body (model)
|
|
238
|
+
post_body = nil
|
|
239
|
+
auth_names = ['BasicAuth']
|
|
240
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
241
|
+
:header_params => header_params,
|
|
242
|
+
:query_params => query_params,
|
|
243
|
+
:form_params => form_params,
|
|
244
|
+
:body => post_body,
|
|
245
|
+
:auth_names => auth_names,
|
|
246
|
+
:return_type => 'String')
|
|
247
|
+
if @api_client.config.debugging
|
|
248
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
249
|
+
end
|
|
250
|
+
return data, status_code, headers
|
|
251
|
+
end
|
|
252
|
+
# Calculate price for sms campaign
|
|
253
|
+
# Calculate price for sms campaign
|
|
254
|
+
# @param campaign SmsCampaign model
|
|
255
|
+
# @param [Hash] opts the optional parameters
|
|
256
|
+
# @return [String]
|
|
257
|
+
def sms_campaigns_price_post(campaign, opts = {})
|
|
258
|
+
data, _status_code, _headers = sms_campaigns_price_post_with_http_info(campaign, opts)
|
|
259
|
+
data
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
# Calculate price for sms campaign
|
|
263
|
+
# Calculate price for sms campaign
|
|
264
|
+
# @param campaign SmsCampaign model
|
|
265
|
+
# @param [Hash] opts the optional parameters
|
|
266
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
267
|
+
def sms_campaigns_price_post_with_http_info(campaign, opts = {})
|
|
268
|
+
if @api_client.config.debugging
|
|
269
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaigns_price_post ...'
|
|
270
|
+
end
|
|
271
|
+
# verify the required parameter 'campaign' is set
|
|
272
|
+
if @api_client.config.client_side_validation && campaign.nil?
|
|
273
|
+
fail ArgumentError, "Missing the required parameter 'campaign' when calling SmsCampaignApi.sms_campaigns_price_post"
|
|
274
|
+
end
|
|
275
|
+
# resource path
|
|
276
|
+
local_var_path = '/sms-campaigns/price'
|
|
277
|
+
|
|
278
|
+
# query parameters
|
|
279
|
+
query_params = {}
|
|
280
|
+
|
|
281
|
+
# header parameters
|
|
282
|
+
header_params = {}
|
|
283
|
+
# HTTP header 'Accept' (if needed)
|
|
284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
285
|
+
# HTTP header 'Content-Type'
|
|
286
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
287
|
+
|
|
288
|
+
# form parameters
|
|
289
|
+
form_params = {}
|
|
290
|
+
|
|
291
|
+
# http body (model)
|
|
292
|
+
post_body = @api_client.object_to_http_body(campaign)
|
|
293
|
+
auth_names = ['BasicAuth']
|
|
294
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
295
|
+
:header_params => header_params,
|
|
296
|
+
:query_params => query_params,
|
|
297
|
+
:form_params => form_params,
|
|
298
|
+
:body => post_body,
|
|
299
|
+
:auth_names => auth_names,
|
|
300
|
+
:return_type => 'String')
|
|
301
|
+
if @api_client.config.debugging
|
|
302
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaigns_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
303
|
+
end
|
|
304
|
+
return data, status_code, headers
|
|
305
|
+
end
|
|
306
|
+
# Create sms campaign
|
|
307
|
+
# Create sms campaign
|
|
308
|
+
# @param campaign SmsCampaign model
|
|
309
|
+
# @param [Hash] opts the optional parameters
|
|
310
|
+
# @return [String]
|
|
311
|
+
def sms_campaigns_send_post(campaign, opts = {})
|
|
312
|
+
data, _status_code, _headers = sms_campaigns_send_post_with_http_info(campaign, opts)
|
|
313
|
+
data
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
# Create sms campaign
|
|
317
|
+
# Create sms campaign
|
|
318
|
+
# @param campaign SmsCampaign model
|
|
319
|
+
# @param [Hash] opts the optional parameters
|
|
320
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
321
|
+
def sms_campaigns_send_post_with_http_info(campaign, opts = {})
|
|
322
|
+
if @api_client.config.debugging
|
|
323
|
+
@api_client.config.logger.debug 'Calling API: SmsCampaignApi.sms_campaigns_send_post ...'
|
|
324
|
+
end
|
|
325
|
+
# verify the required parameter 'campaign' is set
|
|
326
|
+
if @api_client.config.client_side_validation && campaign.nil?
|
|
327
|
+
fail ArgumentError, "Missing the required parameter 'campaign' when calling SmsCampaignApi.sms_campaigns_send_post"
|
|
328
|
+
end
|
|
329
|
+
# resource path
|
|
330
|
+
local_var_path = '/sms-campaigns/send'
|
|
331
|
+
|
|
332
|
+
# query parameters
|
|
333
|
+
query_params = {}
|
|
334
|
+
|
|
335
|
+
# header parameters
|
|
336
|
+
header_params = {}
|
|
337
|
+
# HTTP header 'Accept' (if needed)
|
|
338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
339
|
+
# HTTP header 'Content-Type'
|
|
340
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
341
|
+
|
|
342
|
+
# form parameters
|
|
343
|
+
form_params = {}
|
|
344
|
+
|
|
345
|
+
# http body (model)
|
|
346
|
+
post_body = @api_client.object_to_http_body(campaign)
|
|
347
|
+
auth_names = ['BasicAuth']
|
|
348
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
349
|
+
:header_params => header_params,
|
|
350
|
+
:query_params => query_params,
|
|
351
|
+
:form_params => form_params,
|
|
352
|
+
:body => post_body,
|
|
353
|
+
:auth_names => auth_names,
|
|
354
|
+
:return_type => 'String')
|
|
355
|
+
if @api_client.config.debugging
|
|
356
|
+
@api_client.config.logger.debug "API called: SmsCampaignApi#sms_campaigns_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
357
|
+
end
|
|
358
|
+
return data, status_code, headers
|
|
359
|
+
end
|
|
360
|
+
end
|
|
361
|
+
end
|
|
@@ -0,0 +1,310 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#ClickSend v3 API
|
|
3
|
+
|
|
4
|
+
# This is an official SDK for [ClickSend](https://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](https://dashboard.clicksend.com/#/signup/step1/)..*
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 3.1
|
|
7
|
+
Contact: support@clicksend.com
|
|
8
|
+
Generated by: https://github.com/clicksend-api/clicksend-codegen.git
|
|
9
|
+
ClickSend Codegen version: 2.4.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'uri'
|
|
14
|
+
|
|
15
|
+
module ClickSendClient
|
|
16
|
+
class SMSDeliveryReceiptRulesApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Delete sms delivery receipt automation
|
|
23
|
+
# Delete sms delivery receipt automation
|
|
24
|
+
# @param receipt_rule_id Receipt rule id
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [String]
|
|
27
|
+
def sms_delivery_receipt_automation_delete(receipt_rule_id, opts = {})
|
|
28
|
+
data, _status_code, _headers = sms_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Delete sms delivery receipt automation
|
|
33
|
+
# Delete sms delivery receipt automation
|
|
34
|
+
# @param receipt_rule_id Receipt rule id
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
37
|
+
def sms_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_delete ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'receipt_rule_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && receipt_rule_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_delete"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/automations/sms/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
55
|
+
# HTTP header 'Content-Type'
|
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
57
|
+
|
|
58
|
+
# form parameters
|
|
59
|
+
form_params = {}
|
|
60
|
+
|
|
61
|
+
# http body (model)
|
|
62
|
+
post_body = nil
|
|
63
|
+
auth_names = ['BasicAuth']
|
|
64
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
65
|
+
:header_params => header_params,
|
|
66
|
+
:query_params => query_params,
|
|
67
|
+
:form_params => form_params,
|
|
68
|
+
:body => post_body,
|
|
69
|
+
:auth_names => auth_names,
|
|
70
|
+
:return_type => 'String')
|
|
71
|
+
if @api_client.config.debugging
|
|
72
|
+
@api_client.config.logger.debug "API called: SMSDeliveryReceiptRulesApi#sms_delivery_receipt_automation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
|
+
end
|
|
74
|
+
return data, status_code, headers
|
|
75
|
+
end
|
|
76
|
+
# Get specific sms delivery receipt automation
|
|
77
|
+
# Get specific sms delivery receipt automation
|
|
78
|
+
# @param receipt_rule_id Receipt rule id
|
|
79
|
+
# @param [Hash] opts the optional parameters
|
|
80
|
+
# @return [String]
|
|
81
|
+
def sms_delivery_receipt_automation_get(receipt_rule_id, opts = {})
|
|
82
|
+
data, _status_code, _headers = sms_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts)
|
|
83
|
+
data
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Get specific sms delivery receipt automation
|
|
87
|
+
# Get specific sms delivery receipt automation
|
|
88
|
+
# @param receipt_rule_id Receipt rule id
|
|
89
|
+
# @param [Hash] opts the optional parameters
|
|
90
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
91
|
+
def sms_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts = {})
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug 'Calling API: SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_get ...'
|
|
94
|
+
end
|
|
95
|
+
# verify the required parameter 'receipt_rule_id' is set
|
|
96
|
+
if @api_client.config.client_side_validation && receipt_rule_id.nil?
|
|
97
|
+
fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_get"
|
|
98
|
+
end
|
|
99
|
+
# resource path
|
|
100
|
+
local_var_path = '/automations/sms/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
|
|
101
|
+
|
|
102
|
+
# query parameters
|
|
103
|
+
query_params = {}
|
|
104
|
+
|
|
105
|
+
# header parameters
|
|
106
|
+
header_params = {}
|
|
107
|
+
# HTTP header 'Accept' (if needed)
|
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
109
|
+
# HTTP header 'Content-Type'
|
|
110
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
111
|
+
|
|
112
|
+
# form parameters
|
|
113
|
+
form_params = {}
|
|
114
|
+
|
|
115
|
+
# http body (model)
|
|
116
|
+
post_body = nil
|
|
117
|
+
auth_names = ['BasicAuth']
|
|
118
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
119
|
+
:header_params => header_params,
|
|
120
|
+
:query_params => query_params,
|
|
121
|
+
:form_params => form_params,
|
|
122
|
+
:body => post_body,
|
|
123
|
+
:auth_names => auth_names,
|
|
124
|
+
:return_type => 'String')
|
|
125
|
+
if @api_client.config.debugging
|
|
126
|
+
@api_client.config.logger.debug "API called: SMSDeliveryReceiptRulesApi#sms_delivery_receipt_automation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
127
|
+
end
|
|
128
|
+
return data, status_code, headers
|
|
129
|
+
end
|
|
130
|
+
# Create sms delivery receipt automations
|
|
131
|
+
# Create sms delivery receipt automations
|
|
132
|
+
# @param delivery_receipt_rule sms delivery receipt rule model
|
|
133
|
+
# @param [Hash] opts the optional parameters
|
|
134
|
+
# @return [String]
|
|
135
|
+
def sms_delivery_receipt_automation_post(delivery_receipt_rule, opts = {})
|
|
136
|
+
data, _status_code, _headers = sms_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts)
|
|
137
|
+
data
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# Create sms delivery receipt automations
|
|
141
|
+
# Create sms delivery receipt automations
|
|
142
|
+
# @param delivery_receipt_rule sms delivery receipt rule model
|
|
143
|
+
# @param [Hash] opts the optional parameters
|
|
144
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
145
|
+
def sms_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts = {})
|
|
146
|
+
if @api_client.config.debugging
|
|
147
|
+
@api_client.config.logger.debug 'Calling API: SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_post ...'
|
|
148
|
+
end
|
|
149
|
+
# verify the required parameter 'delivery_receipt_rule' is set
|
|
150
|
+
if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
|
|
151
|
+
fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_post"
|
|
152
|
+
end
|
|
153
|
+
# resource path
|
|
154
|
+
local_var_path = '/automations/sms/receipts'
|
|
155
|
+
|
|
156
|
+
# query parameters
|
|
157
|
+
query_params = {}
|
|
158
|
+
|
|
159
|
+
# header parameters
|
|
160
|
+
header_params = {}
|
|
161
|
+
# HTTP header 'Accept' (if needed)
|
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
163
|
+
# HTTP header 'Content-Type'
|
|
164
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
165
|
+
|
|
166
|
+
# form parameters
|
|
167
|
+
form_params = {}
|
|
168
|
+
|
|
169
|
+
# http body (model)
|
|
170
|
+
post_body = @api_client.object_to_http_body(delivery_receipt_rule)
|
|
171
|
+
auth_names = ['BasicAuth']
|
|
172
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
173
|
+
:header_params => header_params,
|
|
174
|
+
:query_params => query_params,
|
|
175
|
+
:form_params => form_params,
|
|
176
|
+
:body => post_body,
|
|
177
|
+
:auth_names => auth_names,
|
|
178
|
+
:return_type => 'String')
|
|
179
|
+
if @api_client.config.debugging
|
|
180
|
+
@api_client.config.logger.debug "API called: SMSDeliveryReceiptRulesApi#sms_delivery_receipt_automation_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
181
|
+
end
|
|
182
|
+
return data, status_code, headers
|
|
183
|
+
end
|
|
184
|
+
# Update sms delivery receipt automation
|
|
185
|
+
# Update sms delivery receipt automation
|
|
186
|
+
# @param receipt_rule_id Receipt rule id
|
|
187
|
+
# @param delivery_receipt_rule Delivery receipt rule model
|
|
188
|
+
# @param [Hash] opts the optional parameters
|
|
189
|
+
# @return [String]
|
|
190
|
+
def sms_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule, opts = {})
|
|
191
|
+
data, _status_code, _headers = sms_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts)
|
|
192
|
+
data
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# Update sms delivery receipt automation
|
|
196
|
+
# Update sms delivery receipt automation
|
|
197
|
+
# @param receipt_rule_id Receipt rule id
|
|
198
|
+
# @param delivery_receipt_rule Delivery receipt rule model
|
|
199
|
+
# @param [Hash] opts the optional parameters
|
|
200
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
201
|
+
def sms_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts = {})
|
|
202
|
+
if @api_client.config.debugging
|
|
203
|
+
@api_client.config.logger.debug 'Calling API: SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_put ...'
|
|
204
|
+
end
|
|
205
|
+
# verify the required parameter 'receipt_rule_id' is set
|
|
206
|
+
if @api_client.config.client_side_validation && receipt_rule_id.nil?
|
|
207
|
+
fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_put"
|
|
208
|
+
end
|
|
209
|
+
# verify the required parameter 'delivery_receipt_rule' is set
|
|
210
|
+
if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
|
|
211
|
+
fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automation_put"
|
|
212
|
+
end
|
|
213
|
+
# resource path
|
|
214
|
+
local_var_path = '/automations/sms/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_id.to_s)
|
|
215
|
+
|
|
216
|
+
# query parameters
|
|
217
|
+
query_params = {}
|
|
218
|
+
|
|
219
|
+
# header parameters
|
|
220
|
+
header_params = {}
|
|
221
|
+
# HTTP header 'Accept' (if needed)
|
|
222
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
223
|
+
# HTTP header 'Content-Type'
|
|
224
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
225
|
+
|
|
226
|
+
# form parameters
|
|
227
|
+
form_params = {}
|
|
228
|
+
|
|
229
|
+
# http body (model)
|
|
230
|
+
post_body = @api_client.object_to_http_body(delivery_receipt_rule)
|
|
231
|
+
auth_names = ['BasicAuth']
|
|
232
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
233
|
+
:header_params => header_params,
|
|
234
|
+
:query_params => query_params,
|
|
235
|
+
:form_params => form_params,
|
|
236
|
+
:body => post_body,
|
|
237
|
+
:auth_names => auth_names,
|
|
238
|
+
:return_type => 'String')
|
|
239
|
+
if @api_client.config.debugging
|
|
240
|
+
@api_client.config.logger.debug "API called: SMSDeliveryReceiptRulesApi#sms_delivery_receipt_automation_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
241
|
+
end
|
|
242
|
+
return data, status_code, headers
|
|
243
|
+
end
|
|
244
|
+
# Get all sms delivery receipt automations
|
|
245
|
+
# Get all sms delivery receipt automations
|
|
246
|
+
# @param [Hash] opts the optional parameters
|
|
247
|
+
# @option opts [String] :q Your keyword or query.
|
|
248
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
249
|
+
# @option opts [Integer] :limit Number of records per page (default to 10)
|
|
250
|
+
# @return [String]
|
|
251
|
+
def sms_delivery_receipt_automations_get(opts = {})
|
|
252
|
+
data, _status_code, _headers = sms_delivery_receipt_automations_get_with_http_info(opts)
|
|
253
|
+
data
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# Get all sms delivery receipt automations
|
|
257
|
+
# Get all sms delivery receipt automations
|
|
258
|
+
# @param [Hash] opts the optional parameters
|
|
259
|
+
# @option opts [String] :q Your keyword or query.
|
|
260
|
+
# @option opts [Integer] :page Page number
|
|
261
|
+
# @option opts [Integer] :limit Number of records per page
|
|
262
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
263
|
+
def sms_delivery_receipt_automations_get_with_http_info(opts = {})
|
|
264
|
+
if @api_client.config.debugging
|
|
265
|
+
@api_client.config.logger.debug 'Calling API: SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automations_get ...'
|
|
266
|
+
end
|
|
267
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
268
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automations_get, must be greater than or equal to 1.'
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
272
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSDeliveryReceiptRulesApi.sms_delivery_receipt_automations_get, must be greater than or equal to 1.'
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# resource path
|
|
276
|
+
local_var_path = '/automations/sms/receipts'
|
|
277
|
+
|
|
278
|
+
# query parameters
|
|
279
|
+
query_params = {}
|
|
280
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
281
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
282
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
283
|
+
|
|
284
|
+
# header parameters
|
|
285
|
+
header_params = {}
|
|
286
|
+
# HTTP header 'Accept' (if needed)
|
|
287
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
288
|
+
# HTTP header 'Content-Type'
|
|
289
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
290
|
+
|
|
291
|
+
# form parameters
|
|
292
|
+
form_params = {}
|
|
293
|
+
|
|
294
|
+
# http body (model)
|
|
295
|
+
post_body = nil
|
|
296
|
+
auth_names = ['BasicAuth']
|
|
297
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
298
|
+
:header_params => header_params,
|
|
299
|
+
:query_params => query_params,
|
|
300
|
+
:form_params => form_params,
|
|
301
|
+
:body => post_body,
|
|
302
|
+
:auth_names => auth_names,
|
|
303
|
+
:return_type => 'String')
|
|
304
|
+
if @api_client.config.debugging
|
|
305
|
+
@api_client.config.logger.debug "API called: SMSDeliveryReceiptRulesApi#sms_delivery_receipt_automations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
306
|
+
end
|
|
307
|
+
return data, status_code, headers
|
|
308
|
+
end
|
|
309
|
+
end
|
|
310
|
+
end
|