Class: GetAroundOwner::MessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/get_around_owner/api/messages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagesApi

Returns a new instance of MessagesApi.



16
17
18
 
# File 'lib/get_around_owner/api/messages_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/get_around_owner/api/messages_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_messages(rental_id, opts = {}) ⇒ Message

Create Message associated to a rental Create Message associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Options Hash (opts):

Returns:



25
26
27
28
 
# File 'lib/get_around_owner/api/messages_api.rb', line 25

def create_messages(rental_id, opts = {})
  data, _status_code, _headers = create_messages_with_http_info(rental_id, opts)
  data
end

#create_messages_with_http_info(rental_id, opts = {}) ⇒ Array<(Message, Integer, Hash)>

Create Message associated to a rental Create Message associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Message data, response status code and response headers



36
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
77
78
 
# File 'lib/get_around_owner/api/messages_api.rb', line 36

def create_messages_with_http_info(rental_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.create_messages ...'
  end
  # verify the required parameter 'rental_id' is set
  if @api_client.config.client_side_validation && rental_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_id' when calling MessagesApi.create_messages"
  end
  # resource path
  local_var_path = '/rentals/{rental_id}/messages.json'.sub('{' + 'rental_id' + '}', rental_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(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'Message'

  auth_names = opts[:auth_names] || ['bearerAuth']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#create_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_message_by_id(rental_id, id, opts = {}) ⇒ Message

Find a message by ID associated to a rental Find a message by ID associated to a rental

Parameters:

  • rental_id —

    ID of rental

  • id —

    ID of message to return

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

    the optional parameters

Returns:



85
86
87
88
 
# File 'lib/get_around_owner/api/messages_api.rb', line 85

def get_message_by_id(rental_id, id, opts = {})
  data, _status_code, _headers = get_message_by_id_with_http_info(rental_id, id, opts)
  data
end

#get_message_by_id_with_http_info(rental_id, id, opts = {}) ⇒ Array<(Message, Integer, Hash)>

Find a message by ID associated to a rental Find a message by ID associated to a rental

Parameters:

  • rental_id —

    ID of rental

  • id —

    ID of message to return

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

    the optional parameters

Returns:

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

    Message data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
 
# File 'lib/get_around_owner/api/messages_api.rb', line 96

def get_message_by_id_with_http_info(rental_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.get_message_by_id ...'
  end
  # verify the required parameter 'rental_id' is set
  if @api_client.config.client_side_validation && rental_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_id' when calling MessagesApi.get_message_by_id"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MessagesApi.get_message_by_id"
  end
  # resource path
  local_var_path = '/rentals/{rental_id}/messages/{id}.json'.sub('{' + 'rental_id' + '}', rental_id.to_s).sub('{' + 'id' + '}', 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(['application/json'])

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

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

  return_type = opts[:return_type] || 'Message'

  auth_names = opts[:auth_names] || ['bearerAuth']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#get_message_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_messages(opts = {}) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/get_around_owner/api/messages_api.rb', line 213

def get_messages(opts = {})
  # Don't specify a return type to get raw response
  opts[:return_type] = nil
  data, status_code, headers = get_messages_with_http_info(opts)

  if status_code == 200 && data
    begin
      # Parse JSON directly from response body
      JSON.parse(data)
    rescue JSON::ParserError => e
      if @api_client.config.debugging
        @api_client.config.logger.debug "Failed to parse JSON response: #{e.message}"
      end
      nil
    end
  else
    nil
  end
end

#get_messages_for_rental(rental_id, opts = {}) ⇒ RentalMessagesIndex

Find messages associated to a rental Find messages associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/get_around_owner/api/messages_api.rb', line 146

def get_messages_for_rental(rental_id, opts = {})
  # Don't specify a return type to get raw response
  opts[:return_type] = nil
  data, status_code, headers = get_messages_for_rental_with_http_info(rental_id, opts)

  if status_code == 200 && data
    begin
      # Parse JSON directly from response body
      JSON.parse(data)
    rescue JSON::ParserError => e
      if @api_client.config.debugging
        @api_client.config.logger.debug "Failed to parse JSON response: #{e.message}"
      end
      nil
    end
  else
    nil
  end
end

#get_messages_for_rental_with_http_info(rental_id, opts = {}) ⇒ Array<(RentalMessagesIndex, Integer, Hash)>

Find messages associated to a rental Find messages associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Returns:

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

    RentalMessagesIndex data, response status code and response headers



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
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/get_around_owner/api/messages_api.rb', line 171

def get_messages_for_rental_with_http_info(rental_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.get_messages_for_rental ...'
  end
  # verify the required parameter 'rental_id' is set
  if @api_client.config.client_side_validation && rental_id.nil?
    fail ArgumentError, "Missing the required parameter 'rental_id' when calling MessagesApi.get_messages_for_rental"
  end
  # resource path
  local_var_path = '/rentals/{rental_id}/messages.json'.sub('{' + 'rental_id' + '}', rental_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(['application/json'])

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

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

  return_type = opts[:return_type] || 'RentalMessagesIndex'

  auth_names = opts[:auth_names] || ['bearerAuth']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#get_messages_for_rental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end