Class: Aimastering::SpSubscriptionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aimastering/api/sp_subscription_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpSubscriptionApi

Returns a new instance of SpSubscriptionApi.



19
20
21
 
# File 'lib/aimastering/api/sp_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/sp_subscription_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_sp_subscription(service, opts = {}) ⇒ SpSubscription

Create a new smartphone subscription.

Parameters:

  • service —

    Service.

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

    the optional parameters

Options Hash (opts):

  • :receipt (String) —

    Base64 encoded app store receipt. This parameter is effective only when the service is "appstore".

Returns:



29
30
31
32
 
# File 'lib/aimastering/api/sp_subscription_api.rb', line 29

def create_sp_subscription(service, opts = {})
  data, _status_code, _headers = create_sp_subscription_with_http_info(service, opts)
  return data
end

#create_sp_subscription_with_http_info(service, opts = {}) ⇒ Array<(SpSubscription, Fixnum, Hash)>

Create a new smartphone subscription.

Parameters:

  • service —

    Service.

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

    the optional parameters

Options Hash (opts):

  • :receipt (String) —

    Base64 encoded app store receipt. This parameter is effective only when the service is &quot;appstore&quot;.

Returns:

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

    SpSubscription data, response status code and response headers



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

def create_sp_subscription_with_http_info(service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpSubscriptionApi.create_sp_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 SpSubscriptionApi.create_sp_subscription"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['appstore'].include?(service)
    fail ArgumentError, "invalid value for 'service', must be one of appstore"
  end
  # resource path
  local_var_path = "/sp_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["receipt"] = opts[:'receipt'] if !opts[:'receipt'].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 => 'SpSubscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpSubscriptionApi#create_sp_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_sp_subscriptions(opts = {}) ⇒ Array<SpSubscription>

Get all accessable smartphone subscriptions.

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/aimastering/api/sp_subscription_api.rb', line 90

def list_sp_subscriptions(opts = {})
  data, _status_code, _headers = list_sp_subscriptions_with_http_info(opts)
  return data
end

#list_sp_subscriptions_with_http_info(opts = {}) ⇒ Array<(Array<SpSubscription>, Fixnum, Hash)>

Get all accessable smartphone subscriptions.

Parameters:

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

    the optional parameters

Returns:

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

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



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

def list_sp_subscriptions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SpSubscriptionApi.list_sp_subscriptions ..."
  end
  # resource path
  local_var_path = "/sp_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<SpSubscription>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpSubscriptionApi#list_sp_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end