Class: XeroRuby::AppStoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/api/app_store_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.new) ⇒ AppStoreApi

Returns a new instance of AppStoreApi.



16
17
18
 
# File 'lib/xero-ruby/api/app_store_api.rb', line 16

def initialize(api_client = ApiClient.new)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/xero-ruby/api/app_store_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

Retrieves a subscription for a given subscriptionId

Parameters:

  • subscription_id (String) —

    Unique identifier for Subscription object

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

    the optional parameters

Returns:

  • (Subscription) 


23
24
25
26
 
# File 'lib/xero-ruby/api/app_store_api.rb', line 23

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

#get_subscription_with_http_info(subscription_id, options = {}) ⇒ Array<(Subscription, Integer, Hash)>

Retrieves a subscription for a given subscriptionId

Parameters:

  • subscription_id (String) —

    Unique identifier for Subscription object

  • opts (Hash) —

    the optional parameters

Returns:

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

    Subscription data, response status code and response headers



32
33
34
35
36
37
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
81
82
83
84
85
 
# File 'lib/xero-ruby/api/app_store_api.rb', line 32

def get_subscription_with_http_info(subscription_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppStoreApi.get_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 AppStoreApi.get_subscription"
  end
  # resource path
  local_var_path = '/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

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

  # return_type
  return_type = opts[:return_type] || 'Subscription' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

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