aliseeks_api 1.0.4

data/docs/PromotionOption.md

@@ -0,0 +1,12 @@
+# AliseeksApi::PromotionOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**max_amount** | [**Amount**](Amount.md) |  | [optional] 
+**min_amount** | [**Amount**](Amount.md) |  | [optional] 
+**discount** | **Float** | The amount of the discount  | [optional] 
+**time_left** | [**TimeDuration**](TimeDuration.md) |  | [optional] 
+**stock** | **Integer** | The amount of stock left on an item  | [optional] 
+
+

data/docs/RealtimeCurrency.md

@@ -0,0 +1,7 @@
+# AliseeksApi::RealtimeCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RealtimeSearchAggregation.md

@@ -0,0 +1,9 @@
+# AliseeksApi::RealtimeSearchAggregation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **Integer** | The total number of items that matched the request  | [optional] 
+**ship_from_countries** | **Array<String>** | The countries that the items can ship from  | [optional] 
+
+

data/docs/RealtimeSearchItem.md

@@ -0,0 +1,14 @@
+# AliseeksApi::RealtimeSearchItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The AliExpress product ID  | [optional] 
+**image_url** | **String** | The image URL for the item  | [optional] 
+**title** | **String** | The subject / title of the item  | [optional] 
+**ratings** | **Float** | The ratings of the item  | [optional] 
+**orders** | **Integer** | The number of orders of the item  | [optional] 
+**freight** | [**SearchItemFreight**](SearchItemFreight.md) |  | [optional] 
+**price_options** | [**Array<SearchPriceOption>**](SearchPriceOption.md) | The price options for the item  | [optional] 
+
+

data/docs/RealtimeSearchRequest.md

@@ -0,0 +1,14 @@
+# AliseeksApi::RealtimeSearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **Integer** | The category to filter by  | [optional] 
+**text** | **String** | The text to filter by  | [optional] 
+**price_range** | [**DoubleRange**](DoubleRange.md) |  | [optional] 
+**ship_to_country** | **String** | The 2 character ISO code of the country where the item will be shipped to  | [optional] 
+**ship_from_country** | **String** | The 2 character ISO code of the country where the item is shipped from  | [optional] 
+**sort** | **String** | The sort order of the result  | [optional] [default to 'BEST_MATCH']
+**skip** | **Integer** | Number of items to skip, used for pagination  | [optional] 
+
+

data/docs/RealtimeSearchResponse.md

@@ -0,0 +1,9 @@
+# AliseeksApi::RealtimeSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation** | [**RealtimeSearchAggregation**](RealtimeSearchAggregation.md) |  | [optional] 
+**items** | [**Array<RealtimeSearchItem>**](RealtimeSearchItem.md) | The items from a realtime search  | [optional] 
+
+

data/docs/SearchAggregation.md

@@ -0,0 +1,11 @@
+# AliseeksApi::SearchAggregation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_count** | **Integer** | The total number of items that match the request  | [optional] 
+**skip** | **Integer** | The number of items that were skipped  | [optional] 
+**limit** | **Integer** | The number of items to return  | [optional] 
+**scroll_identifier** | **String** | The scroll identifier which can be used in a subsequent search request to fetch the next page. Expires in 60 seconds.  | [optional] 
+
+

data/docs/SearchApi.md

@@ -0,0 +1,263 @@
+# AliseeksApi::SearchApi
+
+All URIs are relative to *https://api.aliseeks.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**realtime_search**](SearchApi.md#realtime_search) | **POST** /search/realtime | Searches AliExpress in realtime 
+[**search**](SearchApi.md#search) | **POST** /search | Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress. 
+[**search_best_selling**](SearchApi.md#search_best_selling) | **POST** /search/bestSelling | Retrieves best selling products from AliExpress in realtime. 
+[**search_by_image**](SearchApi.md#search_by_image) | **POST** /search/image | Searches AliExpress by image in realtime. 
+[**upload_image_by_url**](SearchApi.md#upload_image_by_url) | **POST** /search/image/upload | Uploads an image to AliExpress to allow it to be used in the image search endpoint 
+
+
+# **realtime_search**
+> RealtimeSearchResponse realtime_search(realtime_search_request)
+
+Searches AliExpress in realtime 
+
+### Example
+```ruby
+# load the gem
+require 'aliseeks_api'
+# setup authorization
+AliseeksApi.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
+end
+
+api_instance = AliseeksApi::SearchApi.new
+realtime_search_request = AliseeksApi::RealtimeSearchRequest.new # RealtimeSearchRequest | Realtime search request body 
+
+begin
+  #Searches AliExpress in realtime 
+  result = api_instance.realtime_search(realtime_search_request)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling SearchApi->realtime_search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **realtime_search_request** | [**RealtimeSearchRequest**](RealtimeSearchRequest.md)| Realtime search request body  | 
+
+### Return type
+
+[**RealtimeSearchResponse**](RealtimeSearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search**
+> SearchResponse search(search_request)
+
+Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress. 
+
+### Example
+```ruby
+# load the gem
+require 'aliseeks_api'
+# setup authorization
+AliseeksApi.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
+end
+
+api_instance = AliseeksApi::SearchApi.new
+search_request = AliseeksApi::SearchRequest.new # SearchRequest | Search request body 
+
+begin
+  #Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress. 
+  result = api_instance.search(search_request)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling SearchApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search_request** | [**SearchRequest**](SearchRequest.md)| Search request body  | 
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search_best_selling**
+> BestSellingSearchResponse search_best_selling(best_selling_search_request)
+
+Retrieves best selling products from AliExpress in realtime. 
+
+### Example
+```ruby
+# load the gem
+require 'aliseeks_api'
+# setup authorization
+AliseeksApi.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
+end
+
+api_instance = AliseeksApi::SearchApi.new
+best_selling_search_request = AliseeksApi::BestSellingSearchRequest.new # BestSellingSearchRequest | Search best selling request body 
+
+begin
+  #Retrieves best selling products from AliExpress in realtime. 
+  result = api_instance.search_best_selling(best_selling_search_request)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling SearchApi->search_best_selling: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **best_selling_search_request** | [**BestSellingSearchRequest**](BestSellingSearchRequest.md)| Search best selling request body  | 
+
+### Return type
+
+[**BestSellingSearchResponse**](BestSellingSearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search_by_image**
+> ImageSearchResponse search_by_image(image_search_request)
+
+Searches AliExpress by image in realtime. 
+
+### Example
+```ruby
+# load the gem
+require 'aliseeks_api'
+# setup authorization
+AliseeksApi.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
+end
+
+api_instance = AliseeksApi::SearchApi.new
+image_search_request = AliseeksApi::ImageSearchRequest.new # ImageSearchRequest | The image search request body 
+
+begin
+  #Searches AliExpress by image in realtime. 
+  result = api_instance.search_by_image(image_search_request)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling SearchApi->search_by_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **image_search_request** | [**ImageSearchRequest**](ImageSearchRequest.md)| The image search request body  | 
+
+### Return type
+
+[**ImageSearchResponse**](ImageSearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upload_image_by_url**
+> UploadImageResponse upload_image_by_url(upload_image_by_url_request)
+
+Uploads an image to AliExpress to allow it to be used in the image search endpoint 
+
+### Example
+```ruby
+# load the gem
+require 'aliseeks_api'
+# setup authorization
+AliseeksApi.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
+end
+
+api_instance = AliseeksApi::SearchApi.new
+upload_image_by_url_request = AliseeksApi::UploadImageByUrlRequest.new # UploadImageByUrlRequest | The upload image by url request body 
+
+begin
+  #Uploads an image to AliExpress to allow it to be used in the image search endpoint 
+  result = api_instance.upload_image_by_url(upload_image_by_url_request)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling SearchApi->upload_image_by_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_image_by_url_request** | [**UploadImageByUrlRequest**](UploadImageByUrlRequest.md)| The upload image by url request body  | 
+
+### Return type
+
+[**UploadImageResponse**](UploadImageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SearchItem.md

@@ -0,0 +1,20 @@
+# AliseeksApi::SearchItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | AliExpress Product ID  | [optional] 
+**title** | **String** | The subject / title of the product  | [optional] 
+**category_id** | **Integer** | The category of the item  | [optional] 
+**image_url** | **String** | Image URL for the item  | [optional] 
+**detail_url** | **String** | The detail URL of the item  | [optional] 
+**lot_size** | **Integer** | The lot size that the item is sold in  | [optional] 
+**lot_unit** | **String** | The unit when describing a lot for this item  | [optional] 
+**price** | [**Amount**](Amount.md) |  | [optional] 
+**ratings** | **Float** | The ratings of this item  | [optional] 
+**orders** | **Float** | The number of orders of this item  | [optional] 
+**freight** | [**SearchItemFreight**](SearchItemFreight.md) |  | [optional] 
+**seller** | [**SearchItemSeller**](SearchItemSeller.md) |  | [optional] 
+**freight_types** | [**Array<SearchItemFreightType>**](SearchItemFreightType.md) | List of freight types available for this item  | [optional] 
+
+

data/docs/SearchItemFreight.md

@@ -0,0 +1,9 @@
+# AliseeksApi::SearchItemFreight
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | [**Amount**](Amount.md) |  | [optional] 
+**type** | **String** | The freight type  | [optional] 
+
+

data/docs/SearchItemFreightType.md

@@ -0,0 +1,8 @@
+# AliseeksApi::SearchItemFreightType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Freight type for the item  | [optional] 
+
+

data/docs/SearchItemSeller.md

@@ -0,0 +1,13 @@
+# AliseeksApi::SearchItemSeller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store_name** | **String** | The name of the seller store  | [optional] 
+**name** | **String** | The name of the seller  | [optional] 
+**positive_feedback** | **Integer** | The amount of positive feedback for the seller  | [optional] 
+**negative_feedback** | **Integer** | The amount of negative feedback for the seller  | [optional] 
+**seller_score** | **Integer** | The score of the seller  | [optional] 
+**total_feedback** | **Integer** | The total amount of feedback for the seller  | [optional] 
+
+

data/docs/SearchPriceOption.md

@@ -0,0 +1,10 @@
+# AliseeksApi::SearchPriceOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the price, either pc_price or app_price  | [optional] 
+**original_amount** | [**Amount**](Amount.md) |  | [optional] 
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+
+

data/docs/SearchRequest.md

@@ -0,0 +1,24 @@
+# AliseeksApi::SearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The search query  | [optional] 
+**sort** | **String** |  | [optional] [default to 'BEST_MATCH']
+**currency** | [**NonRealtimeCurrency**](NonRealtimeCurrency.md) |  | [optional] 
+**category** | **Integer** | The AliExpress category to search in  | [optional] 
+**include_subcategories** | **BOOLEAN** | When this flag is set to `true` the `category` field will be expanded so that all items in sub-categories will be included  | [optional] [default to false]
+**sort_direction** | **String** | The direction to sort the results by. Only valid for certain `sort` values  | [optional] [default to 'ASC']
+**ratings_range** | [**DoubleRange**](DoubleRange.md) |  | [optional] 
+**quantity_range** | [**IntegerRange**](IntegerRange.md) |  | [optional] 
+**price_range** | [**DoubleRange**](DoubleRange.md) |  | [optional] 
+**unit_price_range** | [**DoubleRange**](DoubleRange.md) |  | [optional] 
+**order_range** | [**IntegerRange**](IntegerRange.md) |  | [optional] 
+**item_id_range** | [**StringRange**](StringRange.md) |  | [optional] 
+**freight_types** | **Array<String>** | Filter by freight types  | [optional] 
+**skip** | **Integer** | Skip a number of items, if you need to skip more than 10000 items then use the scroll feature  | [optional] 
+**limit** | **Integer** | Limit the request to a number of items  | [optional] 
+**scroll_pagination** | **BOOLEAN** | When this value is `true` then you will receive a scroll identifier which you can use to request the next page of results. The scroll identifier is good for 60 seconds.  | [optional] [default to false]
+**scroll_identifier** | **String** | The scroll identifier which can be retrieved by sending an initial search request with `scrollPagination` set to `true`. Scroll identifiers are good for 60 seconds.  | [optional] 
+
+

data/docs/SearchResponse.md

@@ -0,0 +1,9 @@
+# AliseeksApi::SearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation** | [**SearchAggregation**](SearchAggregation.md) |  | [optional] 
+**items** | [**Array<SearchItem>**](SearchItem.md) | Search items that match the request  | [optional] 
+
+