Class: ClickSendClient::MMSApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/mms_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MMSApi

Returns a new instance of MMSApi.



19
20
21
 
# File 'lib/clicksend_client/api/mms_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/clicksend_client/api/mms_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#mms_history_export_get(filename, opts = {}) ⇒ String

Export all mms history Export all mms history

Parameters:

  • filename —

    Filename to download history as

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/mms_api.rb', line 27

def mms_history_export_get(filename, opts = {})
  data, _status_code, _headers = mms_history_export_get_with_http_info(filename, opts)
  data
end

#mms_history_export_get_with_http_info(filename, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Export all mms history Export all mms history

Parameters:

  • filename —

    Filename to download history as

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



37
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/clicksend_client/api/mms_api.rb', line 37

def mms_history_export_get_with_http_info(filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_history_export_get ...'
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling MMSApi.mms_history_export_get"
  end
  # resource path
  local_var_path = '/mms/history/export'

  # query parameters
  query_params = {}
  query_params[:'filename'] = filename

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_history_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mms_history_get(opts = {}) ⇒ String

Get all mms history Get all mms history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Custom query Example: from:number,status_code:201.

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


86
87
88
89
 
# File 'lib/clicksend_client/api/mms_api.rb', line 86

def mms_history_get(opts = {})
  data, _status_code, _headers = mms_history_get_with_http_info(opts)
  data
end

#mms_history_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all mms history Get all mms history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Custom query Example: from:number,status_code:201.

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/clicksend_client/api/mms_api.rb', line 100

def mms_history_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_history_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MMSApi.mms_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MMSApi.mms_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/mms/history'

  # query parameters
  query_params = {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mms_price_post(mms_messages, opts = {}) ⇒ String

Get Price for MMS sent Get Price for MMS sent

Parameters:

  • mms_messages —

    MmsMessageCollection model

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

    the optional parameters

Returns:

  • (String) 


153
154
155
156
 
# File 'lib/clicksend_client/api/mms_api.rb', line 153

def mms_price_post(mms_messages, opts = {})
  data, _status_code, _headers = mms_price_post_with_http_info(mms_messages, opts)
  data
end

#mms_price_post_with_http_info(mms_messages, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get Price for MMS sent Get Price for MMS sent

Parameters:

  • mms_messages —

    MmsMessageCollection model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/clicksend_client/api/mms_api.rb', line 163

def mms_price_post_with_http_info(mms_messages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_price_post ...'
  end
  # verify the required parameter 'mms_messages' is set
  if @api_client.config.client_side_validation && mms_messages.nil?
    fail ArgumentError, "Missing the required parameter 'mms_messages' when calling MMSApi.mms_price_post"
  end
  # resource path
  local_var_path = '/mms/price'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(mms_messages)
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mms_receipts_get(opts = {}) ⇒ String

Get all delivery receipts Get all delivery receipts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


208
209
210
211
 
# File 'lib/clicksend_client/api/mms_api.rb', line 208

def mms_receipts_get(opts = {})
  data, _status_code, _headers = mms_receipts_get_with_http_info(opts)
  data
end

#mms_receipts_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all delivery receipts Get all delivery receipts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/clicksend_client/api/mms_api.rb', line 219

def mms_receipts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_receipts_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MMSApi.mms_receipts_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MMSApi.mms_receipts_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/mms/receipts'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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 = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_receipts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mms_receipts_read_put(opts = {}) ⇒ String

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


269
270
271
272
 
# File 'lib/clicksend_client/api/mms_api.rb', line 269

def mms_receipts_read_put(opts = {})
  data, _status_code, _headers = mms_receipts_read_put_with_http_info(opts)
  data
end

#mms_receipts_read_put_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/clicksend_client/api/mms_api.rb', line 279

def mms_receipts_read_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_receipts_read_put ...'
  end
  # resource path
  local_var_path = '/mms/receipts-read'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(opts[:'date_before'])
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_receipts_read_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mms_send_post(mms_messages, opts = {}) ⇒ String

Send MMS Send MMS

Parameters:

  • mms_messages —

    MmsMessageCollection model

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

    the optional parameters

Returns:

  • (String) 


319
320
321
322
 
# File 'lib/clicksend_client/api/mms_api.rb', line 319

def mms_send_post(mms_messages, opts = {})
  data, _status_code, _headers = mms_send_post_with_http_info(mms_messages, opts)
  data
end

#mms_send_post_with_http_info(mms_messages, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send MMS Send MMS

Parameters:

  • mms_messages —

    MmsMessageCollection model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/clicksend_client/api/mms_api.rb', line 329

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(mms_messages)
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end