class Aimastering::SubscriptionApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/aimastering/api/subscription_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

cancel_subscription(id, opts = {}) click to toggle source

Cancel a subscription by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Subscription]

# 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 = {}) click to toggle source

Cancel the subscription cancellation by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Subscription]

# 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 = {}) click to toggle source

Cancel the subscription cancellation by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Array<(Subscription, Fixnum, Hash)>] Subscription data, response status code and response headers

# 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 = {}) click to toggle source

Cancel a subscription by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Array<(Subscription, Fixnum, Hash)>] Subscription data, response status code and response headers

# 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 = {}) click to toggle source

Create a new subscription.

@param service This parameter represents the payment message. @param [Hash] opts the optional parameters @option opts [String] :stripe_plan_id The Stripe plan id. This parameter is effective only when the service is "stripe&quot;. @option opts [String] :token This parameter represents the card token. This parameter is effective only when the service is "stripe&quot;. @option opts [String] :affiliate_id Affiliate id of inviter user. @return [Subscription]

# 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 = {}) click to toggle source

Create a new subscription.

@param service This parameter represents the payment message. @param [Hash] opts the optional parameters @option opts [String] :stripe_plan_id The Stripe plan id. This parameter is effective only when the service is "stripe&quot;. @option opts [String] :token This parameter represents the card token. This parameter is effective only when the service is "stripe&quot;. @option opts [String] :affiliate_id Affiliate id of inviter user. @return [Array<(Subscription, Fixnum, Hash)>] Subscription data, response status code and response headers

# 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 = {}) click to toggle source

Get a subscription by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Subscription]

# 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 = {}) click to toggle source

Get a subscription by id.

@param id Subscription id @param [Hash] opts the optional parameters @return [Array<(Subscription, Fixnum, Hash)>] Subscription data, response status code and response headers

# 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 = {}) click to toggle source

Get all accessable subscriptions.

@param [Hash] opts the optional parameters @return [Array<Subscription>]

# 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 = {}) click to toggle source

Get all accessable subscriptions.

@param [Hash] opts the optional parameters @return [Array<(Array<Subscription>, Fixnum, Hash)>] Array<Subscription> data, response status code and response headers

# 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