Class: Devdraft::InvoicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/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.



19
20
21
 
# File 'lib/devdraft/api/invoices_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/devdraft/api/invoices_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#invoice_controller_create(create_invoice_dto, opts = {}) ⇒ nil

Create a new invoice

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/devdraft/api/invoices_api.rb', line 26

def invoice_controller_create(create_invoice_dto, opts = {})
  invoice_controller_create_with_http_info(create_invoice_dto, opts)
  nil
end

#invoice_controller_create_with_http_info(create_invoice_dto, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create a new invoice

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/devdraft/api/invoices_api.rb', line 35

def invoice_controller_create_with_http_info(create_invoice_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoice_controller_create ...'
  end
  # verify the required parameter 'create_invoice_dto' is set
  if @api_client.config.client_side_validation && create_invoice_dto.nil?
    fail ArgumentError, "Missing the required parameter 'create_invoice_dto' when calling InvoicesApi.invoice_controller_create"
  end
  # resource path
  local_var_path = '/api/v0/invoices'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoice_controller_create",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoice_controller_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoice_controller_find_all(opts = {}) ⇒ nil

Get all invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Float) —

    Number of records to skip

  • :take (Float) —

    Number of records to take

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/devdraft/api/invoices_api.rb', line 91

def invoice_controller_find_all(opts = {})
  invoice_controller_find_all_with_http_info(opts)
  nil
end

#invoice_controller_find_all_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get all invoices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Float) —

    Number of records to skip

  • :take (Float) —

    Number of records to take

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/devdraft/api/invoices_api.rb', line 101

def invoice_controller_find_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoice_controller_find_all ...'
  end
  # resource path
  local_var_path = '/api/v0/invoices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoice_controller_find_all",
    :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: InvoicesApi#invoice_controller_find_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoice_controller_find_one(id, opts = {}) ⇒ nil

Get an invoice by ID

Parameters:

  • id (String) —

    Invoice ID

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

    the optional parameters

Returns:

  • (nil) 


149
150
151
152
 
# File 'lib/devdraft/api/invoices_api.rb', line 149

def invoice_controller_find_one(id, opts = {})
  invoice_controller_find_one_with_http_info(id, opts)
  nil
end

#invoice_controller_find_one_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get an invoice by ID

Parameters:

  • id (String) —

    Invoice ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



158
159
160
161
162
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
202
 
# File 'lib/devdraft/api/invoices_api.rb', line 158

def invoice_controller_find_one_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoice_controller_find_one ...'
  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.invoice_controller_find_one"
  end
  # resource path
  local_var_path = '/api/v0/invoices/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoice_controller_find_one",
    :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: InvoicesApi#invoice_controller_find_one\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoice_controller_update(id, create_invoice_dto, opts = {}) ⇒ nil

Update an invoice

Parameters:

  • id (String) —

    Invoice ID

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

    the optional parameters

Returns:

  • (nil) 


209
210
211
212
 
# File 'lib/devdraft/api/invoices_api.rb', line 209

def invoice_controller_update(id, create_invoice_dto, opts = {})
  invoice_controller_update_with_http_info(id, create_invoice_dto, opts)
  nil
end

#invoice_controller_update_with_http_info(id, create_invoice_dto, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update an invoice

Parameters:

  • id (String) —

    Invoice ID

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

    the optional parameters

Returns:

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

    nil, 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
264
265
266
267
268
269
270
271
272
 
# File 'lib/devdraft/api/invoices_api.rb', line 219

def invoice_controller_update_with_http_info(id, create_invoice_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoice_controller_update ...'
  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.invoice_controller_update"
  end
  # verify the required parameter 'create_invoice_dto' is set
  if @api_client.config.client_side_validation && create_invoice_dto.nil?
    fail ArgumentError, "Missing the required parameter 'create_invoice_dto' when calling InvoicesApi.invoice_controller_update"
  end
  # resource path
  local_var_path = '/api/v0/invoices/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['x-client-secret', 'x-client-key']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoice_controller_update",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoice_controller_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end