Class: AliseeksApi::ProductsApi

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

def api_client
  @api_client
end

Instance Method Details

#get_product(opts = {}) ⇒ Product

Get products details as an aggregated request from AliExpress in realtime.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_request (ProductRequest) —

    The request body of get product

Returns:



26
27
28
29
 
# File 'lib/aliseeks_api/api/products_api.rb', line 26

def get_product(opts = {})
  data, _status_code, _headers = get_product_with_http_info(opts)
  data
end

#get_product_details(product_details_request, opts = {}) ⇒ ProductDetail

Gets product details from AliExpress in realtime.

Parameters:

  • product_details_request —

    The request body to get product details

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

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/aliseeks_api/api/products_api.rb', line 75

def get_product_details(product_details_request, opts = {})
  data, _status_code, _headers = get_product_details_with_http_info(product_details_request, opts)
  data
end

#get_product_details_with_http_info(product_details_request, opts = {}) ⇒ Array<(ProductDetail, Fixnum, Hash)>

Gets product details from AliExpress in realtime.

Parameters:

  • product_details_request —

    The request body to get product details

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

    the optional parameters

Returns:

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

    ProductDetail data, response status code and response headers



84
85
86
87
88
89
90
91
92
93
94
95
96
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
 
# File 'lib/aliseeks_api/api/products_api.rb', line 84

def get_product_details_with_http_info(product_details_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_details ...'
  end
  # verify the required parameter 'product_details_request' is set
  if @api_client.config.client_side_validation && product_details_request.nil?
    fail ArgumentError, "Missing the required parameter 'product_details_request' when calling ProductsApi.get_product_details"
  end
  # resource path
  local_var_path = '/products/details'

  # 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(['application/json'])

  # form parameters
  form_params = {}

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

#get_product_html_description(product_html_description_request, opts = {}) ⇒ ProductHtmlDescription

Get product HTML description from AliExpress in realtime.

Parameters:

  • product_html_description_request —

    The request body to get product html description

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/aliseeks_api/api/products_api.rb', line 128

def get_product_html_description(product_html_description_request, opts = {})
  data, _status_code, _headers = get_product_html_description_with_http_info(product_html_description_request, opts)
  data
end

#get_product_html_description_with_http_info(product_html_description_request, opts = {}) ⇒ Array<(ProductHtmlDescription, Fixnum, Hash)>

Get product HTML description from AliExpress in realtime.

Parameters:

  • product_html_description_request —

    The request body to get product html description

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

    the optional parameters

Returns:

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

    ProductHtmlDescription data, response status code and response headers



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
173
174
175
 
# File 'lib/aliseeks_api/api/products_api.rb', line 137

def get_product_html_description_with_http_info(product_html_description_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_html_description ...'
  end
  # verify the required parameter 'product_html_description_request' is set
  if @api_client.config.client_side_validation && product_html_description_request.nil?
    fail ArgumentError, "Missing the required parameter 'product_html_description_request' when calling ProductsApi.get_product_html_description"
  end
  # resource path
  local_var_path = '/products/description/html'

  # 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(['application/json'])

  # form parameters
  form_params = {}

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

#get_product_reviews(product_reviews_request, opts = {}) ⇒ ProductReviews

Get product reviews from AliExpress in realtime

Parameters:

  • product_reviews_request —

    The request body to get product reviews

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

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/aliseeks_api/api/products_api.rb', line 181

def get_product_reviews(product_reviews_request, opts = {})
  data, _status_code, _headers = get_product_reviews_with_http_info(product_reviews_request, opts)
  data
end

#get_product_reviews_with_http_info(product_reviews_request, opts = {}) ⇒ Array<(ProductReviews, Fixnum, Hash)>

Get product reviews from AliExpress in realtime

Parameters:

  • product_reviews_request —

    The request body to get product reviews

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

    the optional parameters

Returns:

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

    ProductReviews data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/aliseeks_api/api/products_api.rb', line 190

def get_product_reviews_with_http_info(product_reviews_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_reviews ...'
  end
  # verify the required parameter 'product_reviews_request' is set
  if @api_client.config.client_side_validation && product_reviews_request.nil?
    fail ArgumentError, "Missing the required parameter 'product_reviews_request' when calling ProductsApi.get_product_reviews"
  end
  # resource path
  local_var_path = '/products/reviews'

  # 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(['application/json'])

  # form parameters
  form_params = {}

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

#get_product_shipping(product_shipping_request, opts = {}) ⇒ ProductShipping

Gets product shipping information AliExpress in realtime.

Parameters:

  • product_shipping_request —

    The request body to get product shipping

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/aliseeks_api/api/products_api.rb', line 234

def get_product_shipping(product_shipping_request, opts = {})
  data, _status_code, _headers = get_product_shipping_with_http_info(product_shipping_request, opts)
  data
end

#get_product_shipping_with_http_info(product_shipping_request, opts = {}) ⇒ Array<(ProductShipping, Fixnum, Hash)>

Gets product shipping information AliExpress in realtime.

Parameters:

  • product_shipping_request —

    The request body to get product shipping

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

    the optional parameters

Returns:

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

    ProductShipping data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/aliseeks_api/api/products_api.rb', line 243

def get_product_shipping_with_http_info(product_shipping_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_shipping ...'
  end
  # verify the required parameter 'product_shipping_request' is set
  if @api_client.config.client_side_validation && product_shipping_request.nil?
    fail ArgumentError, "Missing the required parameter 'product_shipping_request' when calling ProductsApi.get_product_shipping"
  end
  # resource path
  local_var_path = '/products/shipping'

  # 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(['application/json'])

  # form parameters
  form_params = {}

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

#get_product_skus(product_skus_request, opts = {}) ⇒ ProductSkus

Gets product skus / variation information from AliExpress in realtime.

Parameters:

  • product_skus_request —

    The request body to get product skus / variations

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/aliseeks_api/api/products_api.rb', line 287

def get_product_skus(product_skus_request, opts = {})
  data, _status_code, _headers = get_product_skus_with_http_info(product_skus_request, opts)
  data
end

#get_product_skus_with_http_info(product_skus_request, opts = {}) ⇒ Array<(ProductSkus, Fixnum, Hash)>

Gets product skus / variation information from AliExpress in realtime.

Parameters:

  • product_skus_request —

    The request body to get product skus / variations

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

    the optional parameters

Returns:

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

    ProductSkus data, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/aliseeks_api/api/products_api.rb', line 296

def get_product_skus_with_http_info(product_skus_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_skus ...'
  end
  # verify the required parameter 'product_skus_request' is set
  if @api_client.config.client_side_validation && product_skus_request.nil?
    fail ArgumentError, "Missing the required parameter 'product_skus_request' when calling ProductsApi.get_product_skus"
  end
  # resource path
  local_var_path = '/products/variations'

  # 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(['application/json'])

  # form parameters
  form_params = {}

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

#get_product_with_http_info(opts = {}) ⇒ Array<(Product, Fixnum, Hash)>

Get products details as an aggregated request from AliExpress in realtime.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :product_request (ProductRequest) —

    The request body of get product

Returns:

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

    Product data, response status code and response headers



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
 
# File 'lib/aliseeks_api/api/products_api.rb', line 35

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

  # 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(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'product_request'])
  auth_names = ['ApiKeyAuth']
  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 => 'Product')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end