Class: GetAroundOwner::CheckinsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CheckinsApi

Returns a new instance of CheckinsApi.



16
17
18
 
# File 'lib/get_around_owner/api/checkins_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/checkins_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_checkin_by_rental_id(rental_id, opts = {}) ⇒ Checkin

Find a checkin by rental ID Find a checkin by rental ID

Parameters:

  • rental_id —

    ID of the rental related to the checkin to return

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/get_around_owner/api/checkins_api.rb', line 24

def get_checkin_by_rental_id(rental_id, opts = {})
  data, _status_code, _headers = get_checkin_by_rental_id_with_http_info(rental_id, opts)
  data
end

#get_checkin_by_rental_id_with_http_info(rental_id, opts = {}) ⇒ Array<(Checkin, Integer, Hash)>

Find a checkin by rental ID Find a checkin by rental ID

Parameters:

  • rental_id —

    ID of the rental related to the checkin to return

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

    the optional parameters

Returns:

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

    Checkin data, response status code and response headers



34
35
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
 
# File 'lib/get_around_owner/api/checkins_api.rb', line 34

def get_checkin_by_rental_id_with_http_info(rental_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckinsApi.get_checkin_by_rental_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 CheckinsApi.get_checkin_by_rental_id"
  end
  # resource path
  local_var_path = '/rentals/{rental_id}/checkin.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] || 'Checkin'

  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: CheckinsApi#get_checkin_by_rental_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_checkins(start_date, end_date, opts = {}) ⇒ CheckinsIndex

List of checkins that occurred between two dates List of checkins that occurred between two dates

Parameters:

Options Hash (opts):

  • [] (Object) —

    :page Page number

  • [] (Object) —

    :per_page Page size (default to 30)

Returns:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/get_around_owner/api/checkins_api.rb', line 83

def get_checkins(start_date, end_date, opts = {})
  # Don't specify a return type to get raw response
  opts[:return_type] = nil
  data, status_code, headers = get_checkins_with_http_info(start_date, end_date, 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_checkins_with_http_info(start_date, end_date, opts = {}) ⇒ Array<(CheckinsIndex, Integer, Hash)>

List of checkins that occurred between two dates List of checkins that occurred between two dates

Parameters:

Options Hash (opts):

  • [] (Object) —

    :page Page number

  • [] (Object) —

    :per_page Page size

Returns:

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

    CheckinsIndex data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/get_around_owner/api/checkins_api.rb', line 111

def get_checkins_with_http_info(start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckinsApi.get_checkins ...'
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling CheckinsApi.get_checkins"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling CheckinsApi.get_checkins"
  end
  # resource path
  local_var_path = '/checkins.json'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = end_date
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # 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] || 'CheckinsIndex'

  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: CheckinsApi#get_checkins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end