aliseeks_api 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb5642fd7303fa57d7f3bc51105813f9a4dac231c778039ad47f9d6b1a070809
+  data.tar.gz: 88fd8646e0ef70f11b029f1c2e2ecfd9606e410e0043b01e3a375223fe47587e
+SHA512:
+  metadata.gz: f3aecbfcdf12476a5cb27ea7ccb08b551759780259dd9410c067e55dc7b94bea2b4247e1a3ff1ba31d58d44af2cf1ddbbe2e9f8b34cbda14c977f13b51673f56
+  data.tar.gz: 9c4f1464840fdb9c16085b23aee0fb9df378e1b5302d4a0ec22a0886eca9e2858cb4b698f779828564ccf059d8f948bcbdd93abd0d38569874e1d6cdb09a998b

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    aliseeks_api (1.0.4)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  aliseeks_api!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,171 @@
+# aliseeks_api
+
+AliseeksApi - the Ruby gem for the Aliseeks API
+
+AliExpress product searching and product details retrieval API.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.4
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build aliseeks_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./aliseeks_api-1.0.4.gem
+```
+(for development, run `gem install --dev ./aliseeks_api-1.0.4.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'aliseeks_api', '~> 1.0.4'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/aliseeks/connect-ruby-sdk, then add the following in the Gemfile:
+
+    gem 'aliseeks_api', :git => 'https://github.com/aliseeks/connect-ruby-sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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::ProductsApi.new
+opts = {
+  product_request: AliseeksApi::ProductRequest.new # ProductRequest | The request body of get product 
+}
+
+begin
+  #Get products details as an aggregated request from AliExpress in realtime. 
+  result = api_instance.get_product(opts)
+  p result
+rescue AliseeksApi::ApiError => e
+  puts "Exception when calling ProductsApi->get_product: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.aliseeks.com/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AliseeksApi::ProductsApi* | [**get_product**](docs/ProductsApi.md#get_product) | **POST** /products | Get products details as an aggregated request from AliExpress in realtime. 
+*AliseeksApi::ProductsApi* | [**get_product_details**](docs/ProductsApi.md#get_product_details) | **POST** /products/details | Gets product details from AliExpress in realtime. 
+*AliseeksApi::ProductsApi* | [**get_product_html_description**](docs/ProductsApi.md#get_product_html_description) | **POST** /products/description/html | Get product HTML description from AliExpress in realtime. 
+*AliseeksApi::ProductsApi* | [**get_product_reviews**](docs/ProductsApi.md#get_product_reviews) | **POST** /products/reviews | Get product reviews from AliExpress in realtime 
+*AliseeksApi::ProductsApi* | [**get_product_shipping**](docs/ProductsApi.md#get_product_shipping) | **POST** /products/shipping | Gets product shipping information AliExpress in realtime. 
+*AliseeksApi::ProductsApi* | [**get_product_skus**](docs/ProductsApi.md#get_product_skus) | **POST** /products/variations | Gets product skus / variation information from AliExpress in realtime. 
+*AliseeksApi::SearchApi* | [**realtime_search**](docs/SearchApi.md#realtime_search) | **POST** /search/realtime | Searches AliExpress in realtime 
+*AliseeksApi::SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Searches AliExpress in non-realtime. Uses the Aliseeks.com datasource which is continually updated from AliExpress. 
+*AliseeksApi::SearchApi* | [**search_best_selling**](docs/SearchApi.md#search_best_selling) | **POST** /search/bestSelling | Retrieves best selling products from AliExpress in realtime. 
+*AliseeksApi::SearchApi* | [**search_by_image**](docs/SearchApi.md#search_by_image) | **POST** /search/image | Searches AliExpress by image in realtime. 
+*AliseeksApi::SearchApi* | [**upload_image_by_url**](docs/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 
+
+
+## Documentation for Models
+
+ - [AliseeksApi::Amount](docs/Amount.md)
+ - [AliseeksApi::BestSellingSearchItem](docs/BestSellingSearchItem.md)
+ - [AliseeksApi::BestSellingSearchRequest](docs/BestSellingSearchRequest.md)
+ - [AliseeksApi::BestSellingSearchResponse](docs/BestSellingSearchResponse.md)
+ - [AliseeksApi::DoubleRange](docs/DoubleRange.md)
+ - [AliseeksApi::ImageSearchCategory](docs/ImageSearchCategory.md)
+ - [AliseeksApi::ImageSearchItem](docs/ImageSearchItem.md)
+ - [AliseeksApi::ImageSearchRequest](docs/ImageSearchRequest.md)
+ - [AliseeksApi::ImageSearchResponse](docs/ImageSearchResponse.md)
+ - [AliseeksApi::IntegerRange](docs/IntegerRange.md)
+ - [AliseeksApi::NonRealtimeCurrency](docs/NonRealtimeCurrency.md)
+ - [AliseeksApi::PriceRange](docs/PriceRange.md)
+ - [AliseeksApi::PriceSummary](docs/PriceSummary.md)
+ - [AliseeksApi::Product](docs/Product.md)
+ - [AliseeksApi::ProductAttribute](docs/ProductAttribute.md)
+ - [AliseeksApi::ProductBulkOption](docs/ProductBulkOption.md)
+ - [AliseeksApi::ProductDetail](docs/ProductDetail.md)
+ - [AliseeksApi::ProductDetailsRequest](docs/ProductDetailsRequest.md)
+ - [AliseeksApi::ProductHtmlDescription](docs/ProductHtmlDescription.md)
+ - [AliseeksApi::ProductHtmlDescriptionRequest](docs/ProductHtmlDescriptionRequest.md)
+ - [AliseeksApi::ProductPriceOption](docs/ProductPriceOption.md)
+ - [AliseeksApi::ProductPromotion](docs/ProductPromotion.md)
+ - [AliseeksApi::ProductPropertyVariationIdentifier](docs/ProductPropertyVariationIdentifier.md)
+ - [AliseeksApi::ProductRequest](docs/ProductRequest.md)
+ - [AliseeksApi::ProductRequestComponent](docs/ProductRequestComponent.md)
+ - [AliseeksApi::ProductReview](docs/ProductReview.md)
+ - [AliseeksApi::ProductReviews](docs/ProductReviews.md)
+ - [AliseeksApi::ProductReviewsRequest](docs/ProductReviewsRequest.md)
+ - [AliseeksApi::ProductSeller](docs/ProductSeller.md)
+ - [AliseeksApi::ProductShipping](docs/ProductShipping.md)
+ - [AliseeksApi::ProductShippingOptions](docs/ProductShippingOptions.md)
+ - [AliseeksApi::ProductShippingRequest](docs/ProductShippingRequest.md)
+ - [AliseeksApi::ProductSku](docs/ProductSku.md)
+ - [AliseeksApi::ProductSkus](docs/ProductSkus.md)
+ - [AliseeksApi::ProductSkusRequest](docs/ProductSkusRequest.md)
+ - [AliseeksApi::PromotionOption](docs/PromotionOption.md)
+ - [AliseeksApi::RealtimeCurrency](docs/RealtimeCurrency.md)
+ - [AliseeksApi::RealtimeSearchAggregation](docs/RealtimeSearchAggregation.md)
+ - [AliseeksApi::RealtimeSearchItem](docs/RealtimeSearchItem.md)
+ - [AliseeksApi::RealtimeSearchRequest](docs/RealtimeSearchRequest.md)
+ - [AliseeksApi::RealtimeSearchResponse](docs/RealtimeSearchResponse.md)
+ - [AliseeksApi::SearchAggregation](docs/SearchAggregation.md)
+ - [AliseeksApi::SearchItem](docs/SearchItem.md)
+ - [AliseeksApi::SearchItemFreight](docs/SearchItemFreight.md)
+ - [AliseeksApi::SearchItemFreightType](docs/SearchItemFreightType.md)
+ - [AliseeksApi::SearchItemSeller](docs/SearchItemSeller.md)
+ - [AliseeksApi::SearchPriceOption](docs/SearchPriceOption.md)
+ - [AliseeksApi::SearchRequest](docs/SearchRequest.md)
+ - [AliseeksApi::SearchResponse](docs/SearchResponse.md)
+ - [AliseeksApi::SkuPriceOption](docs/SkuPriceOption.md)
+ - [AliseeksApi::SkuPriceOptionProperty](docs/SkuPriceOptionProperty.md)
+ - [AliseeksApi::SkuProperty](docs/SkuProperty.md)
+ - [AliseeksApi::SkuPropertyValue](docs/SkuPropertyValue.md)
+ - [AliseeksApi::StringRange](docs/StringRange.md)
+ - [AliseeksApi::TimeDuration](docs/TimeDuration.md)
+ - [AliseeksApi::TradeInformation](docs/TradeInformation.md)
+ - [AliseeksApi::UploadImageByUrlRequest](docs/UploadImageByUrlRequest.md)
+ - [AliseeksApi::UploadImageResponse](docs/UploadImageResponse.md)
+ - [AliseeksApi::WebError](docs/WebError.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-CLIENT-ID
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/aliseeks_api.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Aliseeks API
+
+#AliExpress product searching and product details retrieval API. 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "aliseeks_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aliseeks_api"
+  s.version     = AliseeksApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aliseeks"]
+  s.email       = ["alex@aliseeks.com"]
+  s.homepage    = "https://gitlab.com/aliseeksapi/aliseeks-ruby-sdk"
+  s.summary     = "Aliseeks API Ruby Gem"
+  s.description = "Ruby client library for the Aliseeks API"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Amount.md

@@ -0,0 +1,9 @@
+# AliseeksApi::Amount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** | Currency of the amount  | [optional] 
+**value** | **Float** | Decimal amount  | [optional] 
+
+

data/docs/BestSellingSearchItem.md

@@ -0,0 +1,15 @@
+# AliseeksApi::BestSellingSearchItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the product  | [optional] 
+**title** | **String** | The title of the product  | [optional] 
+**image_url** | **String** | The url of the product image  | [optional] 
+**ratings** | **Float** | The product ratings  | [optional] 
+**orders** | **Integer** | The number of orders that the item has  | [optional] 
+**detail_url** | **String** | The detail URL of the item  | [optional] 
+**store_detail_url** | **String** | The store detail URL for the item  | [optional] 
+**price_options** | [**Array<SearchPriceOption>**](SearchPriceOption.md) | The price options of the item  | [optional] 
+
+

data/docs/BestSellingSearchRequest.md

@@ -0,0 +1,12 @@
+# AliseeksApi::BestSellingSearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**range** | **String** | The time range to look for best selling products. Can be Top best selling products or Weekly best selling products.  | [optional] [default to 'top']
+**category** | **String** | The category to look for best selling products. Only certain categories can be searched for depending on the `range`. When range is \"top\", only the categories [ \"all\", \"fashion\", \"electronics\", \"sports\", \"health_beauty\", \"kids_baby\", \"home_garden\", \"automotive\" ] are supported. When range is \"weekly\", only the categories [ \"woman\", \"men\", \"electronics\", \"sports\", \"health_beauty\", \"kids_baby\", \"automotive\" ] are supported.  | [optional] [default to 'electronics']
+**skip** | **Integer** | The number of results to skip. Allows for pagination.  | [optional] [default to 0]
+**locale** | **String** | AliExpress locale to use.  | [optional] [default to 'en_US']
+**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) |  | [optional] 
+
+

data/docs/BestSellingSearchResponse.md

@@ -0,0 +1,8 @@
+# AliseeksApi::BestSellingSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<BestSellingSearchItem>**](BestSellingSearchItem.md) | List of best selling products  | [optional] 
+
+

data/docs/DoubleRange.md

@@ -0,0 +1,9 @@
+# AliseeksApi::DoubleRange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **Float** |  | [optional] 
+**to** | **Float** |  | [optional] 
+
+

data/docs/ImageSearchCategory.md

@@ -0,0 +1,9 @@
+# AliseeksApi::ImageSearchCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The AliExpress item ID  | [optional] 
+**name** | **String** | The name of the category  | [optional] 
+
+

data/docs/ImageSearchItem.md

@@ -0,0 +1,12 @@
+# AliseeksApi::ImageSearchItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | AliExpress product ID  | [optional] 
+**title** | **String** | The title / subject of the AliExpress product  | [optional] 
+**image_url** | **String** | The image of the item  | [optional] 
+**price** | [**Amount**](Amount.md) |  | [optional] 
+**orders** | **Integer** | The orders of the item  | [optional] 
+
+

data/docs/ImageSearchRequest.md

@@ -0,0 +1,12 @@
+# AliseeksApi::ImageSearchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upload_key** | **String** |  | [optional] 
+**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) |  | [optional] 
+**language** | **String** | AliExpress language to retrieve content in. Use locale.  | [optional] [default to 'en_US']
+**ship_to_country** | **String** | Two character iso country code  | [optional] 
+**category** | **Integer** | AliExpress category to search in | [optional] 
+
+

data/docs/ImageSearchResponse.md

@@ -0,0 +1,10 @@
+# AliseeksApi::ImageSearchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**Array<ImageSearchCategory>**](ImageSearchCategory.md) | The eligible categories that apply to this image search response  | [optional] 
+**items** | [**Array<ImageSearchItem>**](ImageSearchItem.md) | The items that match the image  | [optional] 
+**selected_category_id** | **Integer** | The category ID which is selected  | [optional] 
+
+

data/docs/IntegerRange.md

@@ -0,0 +1,9 @@
+# AliseeksApi::IntegerRange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **Integer** |  | [optional] 
+**to** | **Integer** |  | [optional] 
+
+