Class: SmplkitGeneratedClient::App::SubscriptionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionApi

Returns a new instance of SubscriptionApi.



19
20
21
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_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/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#admin_put_account_subscription(account_id, admin_subscription_request, opts = {}) ⇒ SubscriptionResponse

Replace Account Subscription (admin) Admin replacement of a specific account’s subscription. Accepts the same body shape as the customer endpoint plus “discount_override_pct“. Setting the override to 100 skips the billing provider entirely; lowering it below 100 requires a payment method on file for the target account.

Parameters:

  • account_id (String)
  • admin_subscription_request (AdminSubscriptionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 28

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

#admin_put_account_subscription_with_http_info(account_id, admin_subscription_request, opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Replace Account Subscription (admin) Admin replacement of a specific account&#39;s subscription. Accepts the same body shape as the customer endpoint plus &#x60;&#x60;discount_override_pct&#x60;&#x60;. Setting the override to 100 skips the billing provider entirely; lowering it below 100 requires a payment method on file for the target account.

Parameters:

  • account_id (String)
  • admin_subscription_request (AdminSubscriptionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SubscriptionResponse data, 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
91
92
93
94
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 39

def (, admin_subscription_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionApi.admin_put_account_subscription ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling SubscriptionApi.admin_put_account_subscription"
  end
  # verify the required parameter 'admin_subscription_request' is set
  if @api_client.config.client_side_validation && admin_subscription_request.nil?
    fail ArgumentError, "Missing the required parameter 'admin_subscription_request' when calling SubscriptionApi.admin_put_account_subscription"
  end
  # resource path
  local_var_path = '/api/v1/accounts/{account_id}/subscription'.sub('{account_id}', CGI.escape(.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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(admin_subscription_request)

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

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

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

#get_current_subscription(opts = {}) ⇒ SubscriptionResponse

Get Current Subscription Return the authenticated account’s subscription, or 404 if none exists.

Parameters:

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

    the optional parameters

Returns:



100
101
102
103
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 100

def get_current_subscription(opts = {})
  data, _status_code, _headers = get_current_subscription_with_http_info(opts)
  data
end

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

Get Current Subscription Return the authenticated account&#39;s subscription, or 404 if none exists.

Parameters:

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 109

def get_current_subscription_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionApi.get_current_subscription ...'
  end
  # resource path
  local_var_path = '/api/v1/accounts/current/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/vnd.api+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] || ['HTTPBearer']

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

#preview_current_subscription(subscription_request, opts = {}) ⇒ SubscriptionPreviewResponse

Preview Subscription Change Project the result of replacing the subscription with the desired state. No database or billing-provider changes are made; safe to call as the customer iterates on a plan picker.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 158

def preview_current_subscription(subscription_request, opts = {})
  data, _status_code, _headers = preview_current_subscription_with_http_info(subscription_request, opts)
  data
end

#preview_current_subscription_with_http_info(subscription_request, opts = {}) ⇒ Array<(SubscriptionPreviewResponse, Integer, Hash)>

Preview Subscription Change Project the result of replacing the subscription with the desired state. No database or billing-provider changes are made; safe to call as the customer iterates on a plan picker.

Parameters:

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

    the optional parameters

Returns:

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

    SubscriptionPreviewResponse data, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 168

def preview_current_subscription_with_http_info(subscription_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionApi.preview_current_subscription ...'
  end
  # verify the required parameter 'subscription_request' is set
  if @api_client.config.client_side_validation && subscription_request.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_request' when calling SubscriptionApi.preview_current_subscription"
  end
  # resource path
  local_var_path = '/api/v1/accounts/current/subscription/actions/preview'

  # 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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(subscription_request)

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

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

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

#put_current_subscription(subscription_request, opts = {}) ⇒ SubscriptionResponse

Replace Current Subscription Replace the authenticated account’s subscription with the desired state.

Parameters:

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 226

def put_current_subscription(subscription_request, opts = {})
  data, _status_code, _headers = put_current_subscription_with_http_info(subscription_request, opts)
  data
end

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

Replace Current Subscription Replace the authenticated account&#39;s subscription with the desired state.

Parameters:

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/api/subscription_api.rb', line 236

def put_current_subscription_with_http_info(subscription_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionApi.put_current_subscription ...'
  end
  # verify the required parameter 'subscription_request' is set
  if @api_client.config.client_side_validation && subscription_request.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_request' when calling SubscriptionApi.put_current_subscription"
  end
  # resource path
  local_var_path = '/api/v1/accounts/current/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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(subscription_request)

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

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

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