Class: BillingApi::ProductsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_billing_api/api/products_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductsApi

Returns a new instance of ProductsApi.



19
20
21
 
# File 'lib/pnap_billing_api/api/products_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/pnap_billing_api/api/products_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#product_availability_get(opts = {}) ⇒ Array<ProductAvailability>

List all Product availabilities. Retrieves the list of product availability details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_category (Array<String>) —

    Product category. Currently only SERVER category is supported.

  • :product_code (Array<String>)
  • :show_only_min_quantity_available (Boolean) —

    Show only locations where product with requested quantity is available or all locations where product is offered. (default to true)

  • :location (Array<LocationEnum>)
  • :solution (Array<String>)
  • :min_quantity (Float) —

    Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively.

Returns:



32
33
34
35
 
# File 'lib/pnap_billing_api/api/products_api.rb', line 32

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

#product_availability_get_with_http_info(opts = {}) ⇒ Array<(Array<ProductAvailability>, Integer, Hash)>

List all Product availabilities. Retrieves the list of product availability details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_category (Array<String>) —

    Product category. Currently only SERVER category is supported.

  • :product_code (Array<String>)
  • :show_only_min_quantity_available (Boolean) —

    Show only locations where product with requested quantity is available or all locations where product is offered. (default to true)

  • :location (Array<LocationEnum>)
  • :solution (Array<String>)
  • :min_quantity (Float) —

    Minimal quantity of product needed. Minimum, maximum and default values might differ for different products. For servers, they are 1, 10 and 1 respectively.

Returns:

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

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



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
95
96
97
98
99
100
101
102
103
 
# File 'lib/pnap_billing_api/api/products_api.rb', line 47

def product_availability_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.product_availability_get ...'
  end
  allowable_values = ["SERVER"]
  if @api_client.config.client_side_validation && opts[:'product_category'] && !opts[:'product_category'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"product_category\", must include one of #{allowable_values}"
  end
  allowable_values = ["SERVER_RANCHER"]
  if @api_client.config.client_side_validation && opts[:'solution'] && !opts[:'solution'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"solution\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/product-availability'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'productCategory'] = @api_client.build_collection_param(opts[:'product_category'], :multi) if !opts[:'product_category'].nil?
  query_params[:'productCode'] = @api_client.build_collection_param(opts[:'product_code'], :multi) if !opts[:'product_code'].nil?
  query_params[:'showOnlyMinQuantityAvailable'] = opts[:'show_only_min_quantity_available'] if !opts[:'show_only_min_quantity_available'].nil?
  query_params[:'location'] = @api_client.build_collection_param(opts[:'location'], :multi) if !opts[:'location'].nil?
  query_params[:'solution'] = @api_client.build_collection_param(opts[:'solution'], :multi) if !opts[:'solution'].nil?
  query_params[:'minQuantity'] = opts[:'min_quantity'] if !opts[:'min_quantity'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ProductAvailability>'

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

  new_options = opts.merge(
    :operation => :"ProductsApi.product_availability_get",
    :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: ProductsApi#product_availability_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_get(opts = {}) ⇒ Array<ProductsGet200ResponseInner>

List all Products. Retrieves all Products.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_code (String)
  • :product_category (String)
  • :sku_code (String)
  • :location (String)

Returns:



113
114
115
116
 
# File 'lib/pnap_billing_api/api/products_api.rb', line 113

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

#products_get_with_http_info(opts = {}) ⇒ Array<(Array<ProductsGet200ResponseInner>, Integer, Hash)>

List all Products. Retrieves all Products.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_code (String)
  • :product_category (String)
  • :sku_code (String)
  • :location (String)

Returns:

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

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



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/pnap_billing_api/api/products_api.rb', line 126

def products_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.products_get ...'
  end
  # resource path
  local_var_path = '/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'productCode'] = opts[:'product_code'] if !opts[:'product_code'].nil?
  query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].nil?
  query_params[:'skuCode'] = opts[:'sku_code'] if !opts[:'sku_code'].nil?
  query_params[:'location'] = opts[:'location'] if !opts[:'location'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ProductsGet200ResponseInner>'

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

  new_options = opts.merge(
    :operation => :"ProductsApi.products_get",
    :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: ProductsApi#products_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end