Class: OpenapiClient::BillingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/billing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillingApi

Returns a new instance of BillingApi.



19
20
21
 
# File 'lib/openapi_client/api/billing_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/openapi_client/api/billing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#billing_invoices_get(opts = {}) ⇒ Array<InvoiceResponse>

List invoices

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/billing_api.rb', line 25

def billing_invoices_get(opts = {})
  data, _status_code, _headers = billing_invoices_get_with_http_info(opts)
  data
end

#billing_invoices_get_with_http_info(opts = {}) ⇒ Array<(Array<InvoiceResponse>, Integer, Hash)>

List invoices

Parameters:

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

    the optional parameters

Returns:

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

    Array<InvoiceResponse> data, response status code and response headers



33
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
75
 
# File 'lib/openapi_client/api/billing_api.rb', line 33

def billing_invoices_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_invoices_get ...'
  end
  # resource path
  local_var_path = '/billing/invoices'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<InvoiceResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

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

#billing_portal_post(opts = {}) ⇒ BillingPortalPost200Response

Open customer billing portal

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/openapi_client/api/billing_api.rb', line 80

def billing_portal_post(opts = {})
  data, _status_code, _headers = billing_portal_post_with_http_info(opts)
  data
end

#billing_portal_post_with_http_info(opts = {}) ⇒ Array<(BillingPortalPost200Response, Integer, Hash)>

Open customer billing portal

Parameters:

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

    the optional parameters

Returns:



88
89
90
91
92
93
94
95
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
 
# File 'lib/openapi_client/api/billing_api.rb', line 88

def billing_portal_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_portal_post ...'
  end
  # resource path
  local_var_path = '/billing/portal'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'BillingPortalPost200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

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

#billing_subscription_get(opts = {}) ⇒ SubscriptionResponse

Get current subscription

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/openapi_client/api/billing_api.rb', line 135

def billing_subscription_get(opts = {})
  data, _status_code, _headers = billing_subscription_get_with_http_info(opts)
  data
end

#billing_subscription_get_with_http_info(opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Get current subscription

Parameters:

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
 
# File 'lib/openapi_client/api/billing_api.rb', line 143

def billing_subscription_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_subscription_get ...'
  end
  # resource path
  local_var_path = '/billing/subscription'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'SubscriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

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

#billing_upgrade_post(upgrade_request, opts = {}) ⇒ UpgradeResponse

Upgrade plan

Parameters:

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/openapi_client/api/billing_api.rb', line 191

def billing_upgrade_post(upgrade_request, opts = {})
  data, _status_code, _headers = billing_upgrade_post_with_http_info(upgrade_request, opts)
  data
end

#billing_upgrade_post_with_http_info(upgrade_request, opts = {}) ⇒ Array<(UpgradeResponse, Integer, Hash)>

Upgrade plan

Parameters:

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

    the optional parameters

Returns:

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

    UpgradeResponse data, response status code and response headers



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

def billing_upgrade_post_with_http_info(upgrade_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_upgrade_post ...'
  end
  # verify the required parameter 'upgrade_request' is set
  if @api_client.config.client_side_validation && upgrade_request.nil?
    fail ArgumentError, "Missing the required parameter 'upgrade_request' when calling BillingApi.billing_upgrade_post"
  end
  # resource path
  local_var_path = '/billing/upgrade'

  # 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']) unless header_params['Accept']
  # 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(upgrade_request)

  # return_type
  return_type = opts[:debug_return_type] || 'UpgradeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

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

#billing_usage_get(opts = {}) ⇒ UsageResponse

Get current usage

Parameters:

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

    the optional parameters

Returns:



256
257
258
259
 
# File 'lib/openapi_client/api/billing_api.rb', line 256

def billing_usage_get(opts = {})
  data, _status_code, _headers = billing_usage_get_with_http_info(opts)
  data
end

#billing_usage_get_with_http_info(opts = {}) ⇒ Array<(UsageResponse, Integer, Hash)>

Get current usage

Parameters:

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

    the optional parameters

Returns:

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

    UsageResponse data, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/openapi_client/api/billing_api.rb', line 264

def billing_usage_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_usage_get ...'
  end
  # resource path
  local_var_path = '/billing/usage'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UsageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

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

#billing_webhook_iyzico_post(body, opts = {}) ⇒ nil

iyzico webhook receiver

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


312
313
314
315
 
# File 'lib/openapi_client/api/billing_api.rb', line 312

def billing_webhook_iyzico_post(body, opts = {})
  billing_webhook_iyzico_post_with_http_info(body, opts)
  nil
end

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

iyzico webhook receiver

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/openapi_client/api/billing_api.rb', line 321

def billing_webhook_iyzico_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_webhook_iyzico_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.billing_webhook_iyzico_post"
  end
  # resource path
  local_var_path = '/billing/webhook/iyzico'

  # 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(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#billing_webhook_polar_post(body, opts = {}) ⇒ nil

Polar.sh webhook receiver

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


376
377
378
379
 
# File 'lib/openapi_client/api/billing_api.rb', line 376

def billing_webhook_polar_post(body, opts = {})
  billing_webhook_polar_post_with_http_info(body, opts)
  nil
end

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

Polar.sh webhook receiver

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/openapi_client/api/billing_api.rb', line 385

def billing_webhook_polar_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_webhook_polar_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.billing_webhook_polar_post"
  end
  # resource path
  local_var_path = '/billing/webhook/polar'

  # 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(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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

#billing_webhook_post(body, opts = {}) ⇒ nil

Stripe webhook receiver

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


440
441
442
443
 
# File 'lib/openapi_client/api/billing_api.rb', line 440

def billing_webhook_post(body, opts = {})
  billing_webhook_post_with_http_info(body, opts)
  nil
end

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

Stripe webhook receiver

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/openapi_client/api/billing_api.rb', line 449

def billing_webhook_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.billing_webhook_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.billing_webhook_post"
  end
  # resource path
  local_var_path = '/billing/webhook'

  # 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(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

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