Class: Aimastering::SubscriptionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aimastering/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/aimastering/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/aimastering/api/subscription_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_subscription(id, opts = {}) ⇒ Subscription

Cancel a subscription by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/aimastering/api/subscription_api.rb', line 28

def cancel_subscription(id, opts = {})
  data, _status_code, _headers = cancel_subscription_with_http_info(id, opts)
  return data
end

#cancel_subscription_cancellation(id, opts = {}) ⇒ Subscription

Cancel the subscription cancellation by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/aimastering/api/subscription_api.rb', line 87

def cancel_subscription_cancellation(id, opts = {})
  data, _status_code, _headers = cancel_subscription_cancellation_with_http_info(id, opts)
  return data
end

#cancel_subscription_cancellation_with_http_info(id, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Cancel the subscription cancellation by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



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
131
132
133
134
135
136
137
138
139
 
# File 'lib/aimastering/api/subscription_api.rb', line 97

def cancel_subscription_cancellation_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionApi.cancel_subscription_cancellation ..."
  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 SubscriptionApi.cancel_subscription_cancellation"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling SubscriptionApi.cancel_subscription_cancellation, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/subscriptions/{id}/cancel_cancellation".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionApi#cancel_subscription_cancellation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_subscription_with_http_info(id, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Cancel a subscription by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



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
 
# File 'lib/aimastering/api/subscription_api.rb', line 38

def cancel_subscription_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionApi.cancel_subscription ..."
  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 SubscriptionApi.cancel_subscription"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling SubscriptionApi.cancel_subscription, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/subscriptions/{id}/cancel".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionApi#cancel_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_subscription(service, opts = {}) ⇒ Subscription

Create a new subscription.

Parameters:

  • service —

    This parameter represents the payment message.

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

    the optional parameters

Options Hash (opts):

  • :stripe_plan_id (String) —

    The Stripe plan id. This parameter is effective only when the service is &quot;stripe&quot;.

  • :token (String) —

    This parameter represents the card token. This parameter is effective only when the service is &quot;stripe&quot;.

  • :affiliate_id (String) —

    Affiliate id of inviter user.

Returns:



149
150
151
152
 
# File 'lib/aimastering/api/subscription_api.rb', line 149

def create_subscription(service, opts = {})
  data, _status_code, _headers = create_subscription_with_http_info(service, opts)
  return data
end

#create_subscription_with_http_info(service, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Create a new subscription.

Parameters:

  • service —

    This parameter represents the payment message.

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

    the optional parameters

Options Hash (opts):

  • :stripe_plan_id (String) —

    The Stripe plan id. This parameter is effective only when the service is &quot;stripe&quot;.

  • :token (String) —

    This parameter represents the card token. This parameter is effective only when the service is &quot;stripe&quot;.

  • :affiliate_id (String) —

    Affiliate id of inviter user.

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



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
203
204
205
206
207
208
 
# File 'lib/aimastering/api/subscription_api.rb', line 162

def create_subscription_with_http_info(service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionApi.create_subscription ..."
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling SubscriptionApi.create_subscription"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['stripe'].include?(service)
    fail ArgumentError, "invalid value for 'service', must be one of stripe"
  end
  # resource path
  local_var_path = "/subscriptions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["service"] = service
  form_params["stripe_plan_id"] = opts[:'stripe_plan_id'] if !opts[:'stripe_plan_id'].nil?
  form_params["token"] = opts[:'token'] if !opts[:'token'].nil?
  form_params["affiliate_id"] = opts[:'affiliate_id'] if !opts[:'affiliate_id'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionApi#create_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_subscription(id, opts = {}) ⇒ Subscription

Get a subscription by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/aimastering/api/subscription_api.rb', line 215

def get_subscription(id, opts = {})
  data, _status_code, _headers = get_subscription_with_http_info(id, opts)
  return data
end

#get_subscription_with_http_info(id, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Get a subscription by id.

Parameters:

  • id —

    Subscription id

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

    the optional parameters

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



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
 
# File 'lib/aimastering/api/subscription_api.rb', line 225

def get_subscription_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionApi.get_subscription ..."
  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 SubscriptionApi.get_subscription"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling SubscriptionApi.get_subscription, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/subscriptions/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_subscriptions(opts = {}) ⇒ Array<Subscription>

Get all accessable subscriptions.

Parameters:

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

    the optional parameters

Returns:



271
272
273
274
 
# File 'lib/aimastering/api/subscription_api.rb', line 271

def list_subscriptions(opts = {})
  data, _status_code, _headers = list_subscriptions_with_http_info(opts)
  return data
end

#list_subscriptions_with_http_info(opts = {}) ⇒ Array<(Array<Subscription>, Fixnum, Hash)>

Get all accessable subscriptions.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Subscription>, Fixnum, Hash)>) —

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



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
307
308
309
310
311
312
 
# File 'lib/aimastering/api/subscription_api.rb', line 280

def list_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionApi.list_subscriptions ..."
  end
  # resource path
  local_var_path = "/subscriptions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  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 => 'Array<Subscription>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionApi#list_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end