Class: SwaggerClient::BatchMessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/batch_messages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchMessagesApi

Returns a new instance of BatchMessagesApi.



19
20
21
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_scheduled_batch_job(batchid, opts = {}) ⇒ CancelledMessageResponse

Cancels a scheduled SMS message

Parameters:

  • batchid —

    The ID of the batch you would like returned

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 28

def cancel_scheduled_batch_job(batchid, opts = {})
  data, _status_code, _headers = cancel_scheduled_batch_job_with_http_info(batchid, opts)
  return data
end

#cancel_scheduled_batch_job_with_http_info(batchid, opts = {}) ⇒ Array<(CancelledMessageResponse, Fixnum, Hash)>

Cancels a scheduled SMS message

Parameters:

  • batchid —

    The ID of the batch you would like returned

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CancelledMessageResponse, Fixnum, Hash)>) —

    CancelledMessageResponse data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 38

def cancel_scheduled_batch_job_with_http_info(batchid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BatchMessagesApi.cancel_scheduled_batch_job ..."
  end
  # verify the required parameter 'batchid' is set
  if @api_client.config.client_side_validation && batchid.nil?
    fail ArgumentError, "Missing the required parameter 'batchid' when calling BatchMessagesApi.cancel_scheduled_batch_job"
  end
  # resource path
  local_var_path = "/batches/schedule/{batchid}".sub('{' + 'batchid' + '}', batchid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CancelledMessageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchMessagesApi#cancel_scheduled_batch_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_batch_by_id(batchid, opts = {}) ⇒ MessagesResponse

Retrieve all messages in a batch with the given batch ID

Parameters:

  • batchid —

    The ID of the batch you would like returned

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 83

def get_batch_by_id(batchid, opts = {})
  data, _status_code, _headers = get_batch_by_id_with_http_info(batchid, opts)
  return data
end

#get_batch_by_id_with_http_info(batchid, opts = {}) ⇒ Array<(MessagesResponse, Fixnum, Hash)>

Retrieve all messages in a batch with the given batch ID

Parameters:

  • batchid —

    The ID of the batch you would like returned

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessagesResponse, Fixnum, Hash)>) —

    MessagesResponse data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 93

def get_batch_by_id_with_http_info(batchid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BatchMessagesApi.get_batch_by_id ..."
  end
  # verify the required parameter 'batchid' is set
  if @api_client.config.client_side_validation && batchid.nil?
    fail ArgumentError, "Missing the required parameter 'batchid' when calling BatchMessagesApi.get_batch_by_id"
  end
  # resource path
  local_var_path = "/batch/{batchid}".sub('{' + 'batchid' + '}', batchid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchMessagesApi#get_batch_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#schedule_batch(sms_message, opts = {}) ⇒ ScheduledBatchResponse

Schedules a batch of SMS messages to be sent at the date-time you specify

Parameters:

  • sms_message —

    Message properties

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 138

def schedule_batch(sms_message, opts = {})
  data, _status_code, _headers = schedule_batch_with_http_info(sms_message, opts)
  return data
end

#schedule_batch_with_http_info(sms_message, opts = {}) ⇒ Array<(ScheduledBatchResponse, Fixnum, Hash)>

Schedules a batch of SMS messages to be sent at the date-time you specify

Parameters:

  • sms_message —

    Message properties

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScheduledBatchResponse, Fixnum, Hash)>) —

    ScheduledBatchResponse data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 148

def schedule_batch_with_http_info(sms_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BatchMessagesApi.schedule_batch ..."
  end
  # verify the required parameter 'sms_message' is set
  if @api_client.config.client_side_validation && sms_message.nil?
    fail ArgumentError, "Missing the required parameter 'sms_message' when calling BatchMessagesApi.schedule_batch"
  end
  # resource path
  local_var_path = "/batch/schedule"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(sms_message)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScheduledBatchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchMessagesApi#schedule_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_batch(sms_message, opts = {}) ⇒ BatchMessageResponse

Send a single SMS message to multiple recipients

Parameters:

  • sms_message —

    Message properties

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 193

def send_batch(sms_message, opts = {})
  data, _status_code, _headers = send_batch_with_http_info(sms_message, opts)
  return data
end

#send_batch_with_http_info(sms_message, opts = {}) ⇒ Array<(BatchMessageResponse, Fixnum, Hash)>

Send a single SMS message to multiple recipients

Parameters:

  • sms_message —

    Message properties

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BatchMessageResponse, Fixnum, Hash)>) —

    BatchMessageResponse data, response status code and response headers



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/swagger_client/api/batch_messages_api.rb', line 203

def send_batch_with_http_info(sms_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BatchMessagesApi.send_batch ..."
  end
  # verify the required parameter 'sms_message' is set
  if @api_client.config.client_side_validation && sms_message.nil?
    fail ArgumentError, "Missing the required parameter 'sms_message' when calling BatchMessagesApi.send_batch"
  end
  # resource path
  local_var_path = "/batch/send"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(sms_message)
  auth_names = ['JWT']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BatchMessageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BatchMessagesApi#send_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end