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,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 InboundSMSRulesApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Delete inbound sms automation
|
|
23
|
+
# Delete inbound sms automation
|
|
24
|
+
# @param inbound_rule_id Inbound rule id
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [String]
|
|
27
|
+
def sms_inbound_automation_delete(inbound_rule_id, opts = {})
|
|
28
|
+
data, _status_code, _headers = sms_inbound_automation_delete_with_http_info(inbound_rule_id, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Delete inbound sms automation
|
|
33
|
+
# Delete inbound sms automation
|
|
34
|
+
# @param inbound_rule_id Inbound 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_inbound_automation_delete_with_http_info(inbound_rule_id, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: InboundSMSRulesApi.sms_inbound_automation_delete ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'inbound_rule_id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && inbound_rule_id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundSMSRulesApi.sms_inbound_automation_delete"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/automations/sms/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_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: InboundSMSRulesApi#sms_inbound_automation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
|
+
end
|
|
74
|
+
return data, status_code, headers
|
|
75
|
+
end
|
|
76
|
+
# Get specific inbound sms automation
|
|
77
|
+
# Get specific inbound sms automation
|
|
78
|
+
# @param inbound_rule_id Inbound rule id
|
|
79
|
+
# @param [Hash] opts the optional parameters
|
|
80
|
+
# @return [String]
|
|
81
|
+
def sms_inbound_automation_get(inbound_rule_id, opts = {})
|
|
82
|
+
data, _status_code, _headers = sms_inbound_automation_get_with_http_info(inbound_rule_id, opts)
|
|
83
|
+
data
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Get specific inbound sms automation
|
|
87
|
+
# Get specific inbound sms automation
|
|
88
|
+
# @param inbound_rule_id Inbound 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_inbound_automation_get_with_http_info(inbound_rule_id, opts = {})
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug 'Calling API: InboundSMSRulesApi.sms_inbound_automation_get ...'
|
|
94
|
+
end
|
|
95
|
+
# verify the required parameter 'inbound_rule_id' is set
|
|
96
|
+
if @api_client.config.client_side_validation && inbound_rule_id.nil?
|
|
97
|
+
fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundSMSRulesApi.sms_inbound_automation_get"
|
|
98
|
+
end
|
|
99
|
+
# resource path
|
|
100
|
+
local_var_path = '/automations/sms/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_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: InboundSMSRulesApi#sms_inbound_automation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
127
|
+
end
|
|
128
|
+
return data, status_code, headers
|
|
129
|
+
end
|
|
130
|
+
# Create new inbound sms automation
|
|
131
|
+
# Create new inbound sms automation
|
|
132
|
+
# @param inbound_sms_rule Inbound sms rule model
|
|
133
|
+
# @param [Hash] opts the optional parameters
|
|
134
|
+
# @return [String]
|
|
135
|
+
def sms_inbound_automation_post(inbound_sms_rule, opts = {})
|
|
136
|
+
data, _status_code, _headers = sms_inbound_automation_post_with_http_info(inbound_sms_rule, opts)
|
|
137
|
+
data
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# Create new inbound sms automation
|
|
141
|
+
# Create new inbound sms automation
|
|
142
|
+
# @param inbound_sms_rule Inbound sms 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_inbound_automation_post_with_http_info(inbound_sms_rule, opts = {})
|
|
146
|
+
if @api_client.config.debugging
|
|
147
|
+
@api_client.config.logger.debug 'Calling API: InboundSMSRulesApi.sms_inbound_automation_post ...'
|
|
148
|
+
end
|
|
149
|
+
# verify the required parameter 'inbound_sms_rule' is set
|
|
150
|
+
if @api_client.config.client_side_validation && inbound_sms_rule.nil?
|
|
151
|
+
fail ArgumentError, "Missing the required parameter 'inbound_sms_rule' when calling InboundSMSRulesApi.sms_inbound_automation_post"
|
|
152
|
+
end
|
|
153
|
+
# resource path
|
|
154
|
+
local_var_path = '/automations/sms/inbound'
|
|
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(inbound_sms_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: InboundSMSRulesApi#sms_inbound_automation_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
181
|
+
end
|
|
182
|
+
return data, status_code, headers
|
|
183
|
+
end
|
|
184
|
+
# Update inbound sms automation
|
|
185
|
+
# Update inbound sms automation
|
|
186
|
+
# @param inbound_rule_id Inbound rule id
|
|
187
|
+
# @param inbound_sms_rule Inbound sms rule model
|
|
188
|
+
# @param [Hash] opts the optional parameters
|
|
189
|
+
# @return [String]
|
|
190
|
+
def sms_inbound_automation_put(inbound_rule_id, inbound_sms_rule, opts = {})
|
|
191
|
+
data, _status_code, _headers = sms_inbound_automation_put_with_http_info(inbound_rule_id, inbound_sms_rule, opts)
|
|
192
|
+
data
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# Update inbound sms automation
|
|
196
|
+
# Update inbound sms automation
|
|
197
|
+
# @param inbound_rule_id Inbound rule id
|
|
198
|
+
# @param inbound_sms_rule Inbound sms 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_inbound_automation_put_with_http_info(inbound_rule_id, inbound_sms_rule, opts = {})
|
|
202
|
+
if @api_client.config.debugging
|
|
203
|
+
@api_client.config.logger.debug 'Calling API: InboundSMSRulesApi.sms_inbound_automation_put ...'
|
|
204
|
+
end
|
|
205
|
+
# verify the required parameter 'inbound_rule_id' is set
|
|
206
|
+
if @api_client.config.client_side_validation && inbound_rule_id.nil?
|
|
207
|
+
fail ArgumentError, "Missing the required parameter 'inbound_rule_id' when calling InboundSMSRulesApi.sms_inbound_automation_put"
|
|
208
|
+
end
|
|
209
|
+
# verify the required parameter 'inbound_sms_rule' is set
|
|
210
|
+
if @api_client.config.client_side_validation && inbound_sms_rule.nil?
|
|
211
|
+
fail ArgumentError, "Missing the required parameter 'inbound_sms_rule' when calling InboundSMSRulesApi.sms_inbound_automation_put"
|
|
212
|
+
end
|
|
213
|
+
# resource path
|
|
214
|
+
local_var_path = '/automations/sms/inbound/{inbound_rule_id}'.sub('{' + 'inbound_rule_id' + '}', inbound_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(inbound_sms_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: InboundSMSRulesApi#sms_inbound_automation_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
241
|
+
end
|
|
242
|
+
return data, status_code, headers
|
|
243
|
+
end
|
|
244
|
+
# Get all inbound sms automations
|
|
245
|
+
# Get all inbound sms 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_inbound_automations_get(opts = {})
|
|
252
|
+
data, _status_code, _headers = sms_inbound_automations_get_with_http_info(opts)
|
|
253
|
+
data
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# Get all inbound sms automations
|
|
257
|
+
# Get all inbound sms 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_inbound_automations_get_with_http_info(opts = {})
|
|
264
|
+
if @api_client.config.debugging
|
|
265
|
+
@api_client.config.logger.debug 'Calling API: InboundSMSRulesApi.sms_inbound_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 InboundSMSRulesApi.sms_inbound_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 InboundSMSRulesApi.sms_inbound_automations_get, must be greater than or equal to 1.'
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# resource path
|
|
276
|
+
local_var_path = '/automations/sms/inbound'
|
|
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: InboundSMSRulesApi#sms_inbound_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
|
|
@@ -0,0 +1,323 @@
|
|
|
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 MasterEmailTemplatesApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get all master email template categories
|
|
23
|
+
# Get all master email template categories
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
26
|
+
# @option opts [Integer] :limit Number of records per page (default to 10)
|
|
27
|
+
# @return [String]
|
|
28
|
+
def master_email_template_categories_get(opts = {})
|
|
29
|
+
data, _status_code, _headers = master_email_template_categories_get_with_http_info(opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Get all master email template categories
|
|
34
|
+
# Get all master email template categories
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @option opts [Integer] :page Page number
|
|
37
|
+
# @option opts [Integer] :limit Number of records per page
|
|
38
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
39
|
+
def master_email_template_categories_get_with_http_info(opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_template_categories_get ...'
|
|
42
|
+
end
|
|
43
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
44
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_template_categories_get, must be greater than or equal to 1.'
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
48
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_template_categories_get, must be greater than or equal to 1.'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/email/master-templates-categories'
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = {}
|
|
56
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
57
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
58
|
+
|
|
59
|
+
# header parameters
|
|
60
|
+
header_params = {}
|
|
61
|
+
# HTTP header 'Accept' (if needed)
|
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
63
|
+
# HTTP header 'Content-Type'
|
|
64
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
65
|
+
|
|
66
|
+
# form parameters
|
|
67
|
+
form_params = {}
|
|
68
|
+
|
|
69
|
+
# http body (model)
|
|
70
|
+
post_body = nil
|
|
71
|
+
auth_names = ['BasicAuth']
|
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
73
|
+
:header_params => header_params,
|
|
74
|
+
:query_params => query_params,
|
|
75
|
+
:form_params => form_params,
|
|
76
|
+
:body => post_body,
|
|
77
|
+
:auth_names => auth_names,
|
|
78
|
+
:return_type => 'String')
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
# Get specific master email template category
|
|
85
|
+
# Get specific master email template category
|
|
86
|
+
# @param category_id Email category id
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [String]
|
|
89
|
+
def master_email_template_category_get(category_id, opts = {})
|
|
90
|
+
data, _status_code, _headers = master_email_template_category_get_with_http_info(category_id, opts)
|
|
91
|
+
data
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Get specific master email template category
|
|
95
|
+
# Get specific master email template category
|
|
96
|
+
# @param category_id Email category id
|
|
97
|
+
# @param [Hash] opts the optional parameters
|
|
98
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
99
|
+
def master_email_template_category_get_with_http_info(category_id, opts = {})
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_template_category_get ...'
|
|
102
|
+
end
|
|
103
|
+
# verify the required parameter 'category_id' is set
|
|
104
|
+
if @api_client.config.client_side_validation && category_id.nil?
|
|
105
|
+
fail ArgumentError, "Missing the required parameter 'category_id' when calling MasterEmailTemplatesApi.master_email_template_category_get"
|
|
106
|
+
end
|
|
107
|
+
# resource path
|
|
108
|
+
local_var_path = '/email/master-templates-categories/{category_id}'.sub('{' + 'category_id' + '}', category_id.to_s)
|
|
109
|
+
|
|
110
|
+
# query parameters
|
|
111
|
+
query_params = {}
|
|
112
|
+
|
|
113
|
+
# header parameters
|
|
114
|
+
header_params = {}
|
|
115
|
+
# HTTP header 'Accept' (if needed)
|
|
116
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
117
|
+
# HTTP header 'Content-Type'
|
|
118
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
119
|
+
|
|
120
|
+
# form parameters
|
|
121
|
+
form_params = {}
|
|
122
|
+
|
|
123
|
+
# http body (model)
|
|
124
|
+
post_body = nil
|
|
125
|
+
auth_names = ['BasicAuth']
|
|
126
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
127
|
+
:header_params => header_params,
|
|
128
|
+
:query_params => query_params,
|
|
129
|
+
:form_params => form_params,
|
|
130
|
+
:body => post_body,
|
|
131
|
+
:auth_names => auth_names,
|
|
132
|
+
:return_type => 'String')
|
|
133
|
+
if @api_client.config.debugging
|
|
134
|
+
@api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_category_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
135
|
+
end
|
|
136
|
+
return data, status_code, headers
|
|
137
|
+
end
|
|
138
|
+
# Get specific master email template
|
|
139
|
+
# Get specific master email template
|
|
140
|
+
# @param template_id Email template id
|
|
141
|
+
# @param [Hash] opts the optional parameters
|
|
142
|
+
# @return [String]
|
|
143
|
+
def master_email_template_get(template_id, opts = {})
|
|
144
|
+
data, _status_code, _headers = master_email_template_get_with_http_info(template_id, opts)
|
|
145
|
+
data
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Get specific master email template
|
|
149
|
+
# Get specific master email template
|
|
150
|
+
# @param template_id Email template id
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
153
|
+
def master_email_template_get_with_http_info(template_id, opts = {})
|
|
154
|
+
if @api_client.config.debugging
|
|
155
|
+
@api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_template_get ...'
|
|
156
|
+
end
|
|
157
|
+
# verify the required parameter 'template_id' is set
|
|
158
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
|
159
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling MasterEmailTemplatesApi.master_email_template_get"
|
|
160
|
+
end
|
|
161
|
+
# resource path
|
|
162
|
+
local_var_path = '/email/master-templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
|
|
163
|
+
|
|
164
|
+
# query parameters
|
|
165
|
+
query_params = {}
|
|
166
|
+
|
|
167
|
+
# header parameters
|
|
168
|
+
header_params = {}
|
|
169
|
+
# HTTP header 'Accept' (if needed)
|
|
170
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
171
|
+
# HTTP header 'Content-Type'
|
|
172
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
173
|
+
|
|
174
|
+
# form parameters
|
|
175
|
+
form_params = {}
|
|
176
|
+
|
|
177
|
+
# http body (model)
|
|
178
|
+
post_body = nil
|
|
179
|
+
auth_names = ['BasicAuth']
|
|
180
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
181
|
+
:header_params => header_params,
|
|
182
|
+
:query_params => query_params,
|
|
183
|
+
:form_params => form_params,
|
|
184
|
+
:body => post_body,
|
|
185
|
+
:auth_names => auth_names,
|
|
186
|
+
:return_type => 'String')
|
|
187
|
+
if @api_client.config.debugging
|
|
188
|
+
@api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_template_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
189
|
+
end
|
|
190
|
+
return data, status_code, headers
|
|
191
|
+
end
|
|
192
|
+
# Get all master email templates
|
|
193
|
+
# Get all master email templates
|
|
194
|
+
# @param [Hash] opts the optional parameters
|
|
195
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
196
|
+
# @option opts [Integer] :limit Number of records per page (default to 10)
|
|
197
|
+
# @return [String]
|
|
198
|
+
def master_email_templates_get(opts = {})
|
|
199
|
+
data, _status_code, _headers = master_email_templates_get_with_http_info(opts)
|
|
200
|
+
data
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Get all master email templates
|
|
204
|
+
# Get all master email templates
|
|
205
|
+
# @param [Hash] opts the optional parameters
|
|
206
|
+
# @option opts [Integer] :page Page number
|
|
207
|
+
# @option opts [Integer] :limit Number of records per page
|
|
208
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
209
|
+
def master_email_templates_get_with_http_info(opts = {})
|
|
210
|
+
if @api_client.config.debugging
|
|
211
|
+
@api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_templates_get ...'
|
|
212
|
+
end
|
|
213
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
214
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_templates_get, must be greater than or equal to 1.'
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
218
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_templates_get, must be greater than or equal to 1.'
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# resource path
|
|
222
|
+
local_var_path = '/email/master-templates'
|
|
223
|
+
|
|
224
|
+
# query parameters
|
|
225
|
+
query_params = {}
|
|
226
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
227
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
228
|
+
|
|
229
|
+
# header parameters
|
|
230
|
+
header_params = {}
|
|
231
|
+
# HTTP header 'Accept' (if needed)
|
|
232
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
233
|
+
# HTTP header 'Content-Type'
|
|
234
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
235
|
+
|
|
236
|
+
# form parameters
|
|
237
|
+
form_params = {}
|
|
238
|
+
|
|
239
|
+
# http body (model)
|
|
240
|
+
post_body = nil
|
|
241
|
+
auth_names = ['BasicAuth']
|
|
242
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
243
|
+
:header_params => header_params,
|
|
244
|
+
:query_params => query_params,
|
|
245
|
+
:form_params => form_params,
|
|
246
|
+
:body => post_body,
|
|
247
|
+
:auth_names => auth_names,
|
|
248
|
+
:return_type => 'String')
|
|
249
|
+
if @api_client.config.debugging
|
|
250
|
+
@api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_templates_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
251
|
+
end
|
|
252
|
+
return data, status_code, headers
|
|
253
|
+
end
|
|
254
|
+
# Get all master email templates in a category
|
|
255
|
+
# Get all master email templates in a category
|
|
256
|
+
# @param category_id Email category id
|
|
257
|
+
# @param [Hash] opts the optional parameters
|
|
258
|
+
# @option opts [Integer] :page Page number (default to 1)
|
|
259
|
+
# @option opts [Integer] :limit Number of records per page (default to 10)
|
|
260
|
+
# @return [String]
|
|
261
|
+
def master_email_templates_in_category_get(category_id, opts = {})
|
|
262
|
+
data, _status_code, _headers = master_email_templates_in_category_get_with_http_info(category_id, opts)
|
|
263
|
+
data
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
# Get all master email templates in a category
|
|
267
|
+
# Get all master email templates in a category
|
|
268
|
+
# @param category_id Email category id
|
|
269
|
+
# @param [Hash] opts the optional parameters
|
|
270
|
+
# @option opts [Integer] :page Page number
|
|
271
|
+
# @option opts [Integer] :limit Number of records per page
|
|
272
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
273
|
+
def master_email_templates_in_category_get_with_http_info(category_id, opts = {})
|
|
274
|
+
if @api_client.config.debugging
|
|
275
|
+
@api_client.config.logger.debug 'Calling API: MasterEmailTemplatesApi.master_email_templates_in_category_get ...'
|
|
276
|
+
end
|
|
277
|
+
# verify the required parameter 'category_id' is set
|
|
278
|
+
if @api_client.config.client_side_validation && category_id.nil?
|
|
279
|
+
fail ArgumentError, "Missing the required parameter 'category_id' when calling MasterEmailTemplatesApi.master_email_templates_in_category_get"
|
|
280
|
+
end
|
|
281
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
282
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MasterEmailTemplatesApi.master_email_templates_in_category_get, must be greater than or equal to 1.'
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
286
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterEmailTemplatesApi.master_email_templates_in_category_get, must be greater than or equal to 1.'
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# resource path
|
|
290
|
+
local_var_path = '/email/master-templates-categories/{category_id}/master-templates'.sub('{' + 'category_id' + '}', category_id.to_s)
|
|
291
|
+
|
|
292
|
+
# query parameters
|
|
293
|
+
query_params = {}
|
|
294
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
295
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
296
|
+
|
|
297
|
+
# header parameters
|
|
298
|
+
header_params = {}
|
|
299
|
+
# HTTP header 'Accept' (if needed)
|
|
300
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
301
|
+
# HTTP header 'Content-Type'
|
|
302
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
303
|
+
|
|
304
|
+
# form parameters
|
|
305
|
+
form_params = {}
|
|
306
|
+
|
|
307
|
+
# http body (model)
|
|
308
|
+
post_body = nil
|
|
309
|
+
auth_names = ['BasicAuth']
|
|
310
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
311
|
+
:header_params => header_params,
|
|
312
|
+
:query_params => query_params,
|
|
313
|
+
:form_params => form_params,
|
|
314
|
+
:body => post_body,
|
|
315
|
+
:auth_names => auth_names,
|
|
316
|
+
:return_type => 'String')
|
|
317
|
+
if @api_client.config.debugging
|
|
318
|
+
@api_client.config.logger.debug "API called: MasterEmailTemplatesApi#master_email_templates_in_category_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
319
|
+
end
|
|
320
|
+
return data, status_code, headers
|
|
321
|
+
end
|
|
322
|
+
end
|
|
323
|
+
end
|