Class: TrieveRubyClient::StripeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/api/stripe_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StripeApi

Returns a new instance of StripeApi.



19
20
21
 
# File 'lib/trieve_ruby_client/api/stripe_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/trieve_ruby_client/api/stripe_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_subscription(tr_organization, subscription_id, opts = {}) ⇒ nil

Cancel Subscription Cancel a subscription by its id

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • subscription_id (String) —

    id of the subscription you want to cancel

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 28

def cancel_subscription(tr_organization, subscription_id, opts = {})
  cancel_subscription_with_http_info(tr_organization, subscription_id, opts)
  nil
end

#cancel_subscription_with_http_info(tr_organization, subscription_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Cancel Subscription Cancel a subscription by its id

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • subscription_id (String) —

    id of the subscription you want to cancel

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
85
86
87
88
89
90
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 39

def cancel_subscription_with_http_info(tr_organization, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.cancel_subscription ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling StripeApi.cancel_subscription"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling StripeApi.cancel_subscription"
  end
  # resource path
  local_var_path = '/api/stripe/subscription/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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'])
  header_params[:'TR-Organization'] = tr_organization

  # 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] || ['ApiKey']

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

#create_setup_checkout_session(organization_id, opts = {}) ⇒ CreateSetupCheckoutSessionResPayload

Create checkout session setup Create a checkout session (setup)

Parameters:

  • organization_id (String) —

    The id of the organization to create setup checkout session for.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 97

def create_setup_checkout_session(organization_id, opts = {})
  data, _status_code, _headers = create_setup_checkout_session_with_http_info(organization_id, opts)
  data
end

#create_setup_checkout_session_with_http_info(organization_id, opts = {}) ⇒ Array<(CreateSetupCheckoutSessionResPayload, Integer, Hash)>

Create checkout session setup Create a checkout session (setup)

Parameters:

  • organization_id (String) —

    The id of the organization to create setup checkout session for.

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

    the optional parameters

Returns:



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
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 107

def create_setup_checkout_session_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.create_setup_checkout_session ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling StripeApi.create_setup_checkout_session"
  end
  # resource path
  local_var_path = '/api/stripe/checkout/setup/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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[:debug_body]

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

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

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

#direct_to_payment_link(plan_id, organization_id, opts = {}) ⇒ nil

Checkout Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization

Parameters:

  • plan_id (String) —

    id of the plan you want to subscribe to

  • organization_id (String) —

    id of the organization you want to subscribe to the plan

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

    the optional parameters

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 161

def direct_to_payment_link(plan_id, organization_id, opts = {})
  direct_to_payment_link_with_http_info(plan_id, organization_id, opts)
  nil
end

#direct_to_payment_link_with_http_info(plan_id, organization_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Checkout Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization

Parameters:

  • plan_id (String) —

    id of the plan you want to subscribe to

  • organization_id (String) —

    id of the organization you want to subscribe to the plan

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
214
215
216
217
218
219
220
221
222
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 172

def direct_to_payment_link_with_http_info(plan_id, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.direct_to_payment_link ...'
  end
  # verify the required parameter 'plan_id' is set
  if @api_client.config.client_side_validation && plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'plan_id' when calling StripeApi.direct_to_payment_link"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling StripeApi.direct_to_payment_link"
  end
  # resource path
  local_var_path = '/api/stripe/payment_link/{plan_id}/{organization_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'organization_id' + '}', CGI.escape(organization_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

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

#get_all_invoices(organization_id, opts = {}) ⇒ Array<StripeInvoice>

Get All Invoices Get a list of all invoices

Parameters:

  • organization_id (String) —

    The id of the organization to get invoices for.

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

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 229

def get_all_invoices(organization_id, opts = {})
  data, _status_code, _headers = get_all_invoices_with_http_info(organization_id, opts)
  data
end

#get_all_invoices_with_http_info(organization_id, opts = {}) ⇒ Array<(Array<StripeInvoice>, Integer, Hash)>

Get All Invoices Get a list of all invoices

Parameters:

  • organization_id (String) —

    The id of the organization to get invoices for.

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

    the optional parameters

Returns:

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

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



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
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 239

def get_all_invoices_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.get_all_invoices ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling StripeApi.get_all_invoices"
  end
  # resource path
  local_var_path = '/api/stripe/invoices/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_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[:debug_body]

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

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

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

#get_all_plans(opts = {}) ⇒ Array<StripePlan>

Get All Plans Get a list of all plans

Parameters:

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 291

def get_all_plans(opts = {})
  data, _status_code, _headers = get_all_plans_with_http_info(opts)
  data
end

#get_all_plans_with_http_info(opts = {}) ⇒ Array<(Array<StripePlan>, Integer, Hash)>

Get All Plans Get a list of all plans

Parameters:

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

    the optional parameters

Returns:

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

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 300

def get_all_plans_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.get_all_plans ...'
  end
  # resource path
  local_var_path = '/api/stripe/plans'

  # 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[:debug_body]

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

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

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

#update_subscription_plan(tr_organization, subscription_id, plan_id, opts = {}) ⇒ nil

Update Subscription Plan Update a subscription to a new plan

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • subscription_id (String) —

    id of the subscription you want to update

  • plan_id (String) —

    id of the plan you want to subscribe to

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

    the optional parameters

Returns:

  • (nil) 


351
352
353
354
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 351

def update_subscription_plan(tr_organization, subscription_id, plan_id, opts = {})
  update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id, opts)
  nil
end

#update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Subscription Plan Update a subscription to a new plan

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • subscription_id (String) —

    id of the subscription you want to update

  • plan_id (String) —

    id of the plan you want to subscribe to

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
 
# File 'lib/trieve_ruby_client/api/stripe_api.rb', line 363

def update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StripeApi.update_subscription_plan ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling StripeApi.update_subscription_plan"
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling StripeApi.update_subscription_plan"
  end
  # verify the required parameter 'plan_id' is set
  if @api_client.config.client_side_validation && plan_id.nil?
    fail ArgumentError, "Missing the required parameter 'plan_id' when calling StripeApi.update_subscription_plan"
  end
  # resource path
  local_var_path = '/api/stripe/subscription_plan/{subscription_id}/{plan_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_id.to_s)).sub('{' + 'plan_id' + '}', CGI.escape(plan_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'])
  header_params[:'TR-Organization'] = tr_organization

  # 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] || ['ApiKey']

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