Class: MailSlurpClient::MissedSmsControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/missed_sms_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MissedSmsControllerApi

Returns a new instance of MissedSmsControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/missed_sms_controller_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/mailslurp_client/api/missed_sms_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all_missed_sms_messages(opts = {}) ⇒ PageMissedSmsProjection

Get all missed SMS messages in paginated format

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Optional receiving phone number to filter missed SMS for

  • :page (Integer) —

    Optional page index in list pagination (default to 0)

  • :size (Integer) —

    Optional page size in list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

  • :since (DateTime) —

    Optional filter missed SMS after given date time

  • :before (DateTime) —

    Optional filter missed SMS before given date time

  • :search (String) —

    Optional search filter

Returns:



32
33
34
35
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 32

def get_all_missed_sms_messages(opts = {})
  data, _status_code, _headers = get_all_missed_sms_messages_with_http_info(opts)
  data
end

#get_all_missed_sms_messages_with_http_info(opts = {}) ⇒ Array<(PageMissedSmsProjection, Integer, Hash)>

Get all missed SMS messages in paginated format

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Optional receiving phone number to filter missed SMS for

  • :page (Integer) —

    Optional page index in list pagination

  • :size (Integer) —

    Optional page size in list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :since (DateTime) —

    Optional filter missed SMS after given date time

  • :before (DateTime) —

    Optional filter missed SMS before given date time

  • :search (String) —

    Optional search filter

Returns:

  • (Array<(PageMissedSmsProjection, Integer, Hash)>) —

    PageMissedSmsProjection data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 47

def get_all_missed_sms_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_all_missed_sms_messages ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling MissedSmsControllerApi.get_all_missed_sms_messages, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/missed-sms'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageMissedSmsProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MissedSmsControllerApi#get_all_missed_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_missed_sms_count(opts = {}) ⇒ CountDto

Get missed SMS count

Parameters:

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

    the optional parameters

Returns:



108
109
110
111
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 108

def get_missed_sms_count(opts = {})
  data, _status_code, _headers = get_missed_sms_count_with_http_info(opts)
  data
end

#get_missed_sms_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>

Get missed SMS count

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CountDto, Integer, Hash)>) —

    CountDto data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 116

def get_missed_sms_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_missed_sms_count ...'
  end
  # resource path
  local_var_path = '/missed-sms/count'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CountDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MissedSmsControllerApi#get_missed_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_missed_sms_message(missed_sms_id, opts = {}) ⇒ MissedSmsDto

Get missed SMS content Returns a missed SMS with full content.

Parameters:

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 164

def get_missed_sms_message(missed_sms_id, opts = {})
  data, _status_code, _headers = get_missed_sms_message_with_http_info(missed_sms_id, opts)
  data
end

#get_missed_sms_message_with_http_info(missed_sms_id, opts = {}) ⇒ Array<(MissedSmsDto, Integer, Hash)>

Get missed SMS content Returns a missed SMS with full content.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(MissedSmsDto, Integer, Hash)>) —

    MissedSmsDto data, response status code and response headers



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/mailslurp_client/api/missed_sms_controller_api.rb', line 174

def get_missed_sms_message_with_http_info(missed_sms_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_missed_sms_message ...'
  end
  # verify the required parameter 'missed_sms_id' is set
  if @api_client.config.client_side_validation && missed_sms_id.nil?
    fail ArgumentError, "Missing the required parameter 'missed_sms_id' when calling MissedSmsControllerApi.get_missed_sms_message"
  end
  # resource path
  local_var_path = '/missed-sms/{missedSmsId}'.sub('{' + 'missedSmsId' + '}', CGI.escape(missed_sms_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'MissedSmsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MissedSmsControllerApi#get_missed_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end