Class: GetAroundOwner::InvoicesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoicesApi

Returns a new instance of InvoicesApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_invoice_by_id(id, opts = {}) ⇒ Invoice

Find an invoice by ID Find an invoice by ID

Parameters:

  • id —

    ID of invoice to return

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

    the optional parameters

Returns:



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

def get_invoice_by_id(id, opts = {})
  data, _status_code, _headers = get_invoice_by_id_with_http_info(id, opts)
  data
end

#get_invoice_by_id_with_http_info(id, opts = {}) ⇒ Array<(Invoice, Integer, Hash)>

Find an invoice by ID Find an invoice by ID

Parameters:

  • id —

    ID of invoice to return

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

    the optional parameters

Returns:

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

    Invoice 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/invoices_api.rb', line 34

def get_invoice_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.get_invoice_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 InvoicesApi.get_invoice_by_id"
  end
  # resource path
  local_var_path = '/invoices/{id}.json'.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] || 'Invoice'

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

#get_invoices(opts = {}) ⇒ InvoicesIndex

Find invoices emitted between dates Find invoices emitted between dates

Parameters:

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

    the optional parameters

Options Hash (opts):

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/invoices_api.rb', line 83

def get_invoices(opts = {})
  # Don't specify a return type to get raw response
  opts[:return_type] = nil
  data, status_code, headers = get_invoices_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_invoices_for_rental(rental_id, opts = {}) ⇒ RentalInvoicesIndex

Find invoices associated to a rental Find invoices associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Options Hash (opts):

  • [] (Object) —

    :page Page number

  • [] (Object) —

    :per_page Page size (default to 30)

Returns:



159
160
161
162
 
# File 'lib/get_around_owner/api/invoices_api.rb', line 159

def get_invoices_for_rental(rental_id, opts = {})
  data, _status_code, _headers = get_invoices_for_rental_with_http_info(rental_id, opts)
  data
end

#get_invoices_for_rental_with_http_info(rental_id, opts = {}) ⇒ Array<(RentalInvoicesIndex, Integer, Hash)>

Find invoices associated to a rental Find invoices associated to a rental

Parameters:

  • rental_id —

    ID of rental

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

    the optional parameters

Options Hash (opts):

  • [] (Object) —

    :page Page number

  • [] (Object) —

    :per_page Page size

Returns:

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

    RentalInvoicesIndex 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
212
213
 
# File 'lib/get_around_owner/api/invoices_api.rb', line 171

def get_invoices_for_rental_with_http_info(rental_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.get_invoices_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 InvoicesApi.get_invoices_for_rental"
  end
  # resource path
  local_var_path = '/rentals/{rental_id}/invoices.json'.sub('{' + 'rental_id' + '}', rental_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'RentalInvoicesIndex'

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

#get_invoices_with_http_info(opts = {}) ⇒ Array<(InvoicesIndex, Integer, Hash)>

Find invoices emitted between dates Find invoices emitted between dates

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InvoicesIndex 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
 
# File 'lib/get_around_owner/api/invoices_api.rb', line 111

def get_invoices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.get_invoices ...'
  end
  # resource path
  local_var_path = '/invoices.json'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  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] || 'InvoicesIndex'

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