aliseeks_api 1.0.4

data/docs/SkuPriceOption.md

@@ -0,0 +1,16 @@
+# AliseeksApi::SkuPriceOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**original_price** | [**Amount**](Amount.md) |  | [optional] 
+**discounted_price** | [**Amount**](Amount.md) |  | [optional] 
+**bulk_price** | [**Amount**](Amount.md) |  | [optional] 
+**bulk_quantity** | **Integer** | The quantity that needs to be ordered to qualify for the bulk discount  | [optional] 
+**sku_image** | **String** | The image associated with the sku  | [optional] 
+**discounted_stock** | **Integer** | The stock left at the discounted price  | [optional] 
+**stock** | **Integer** | The stock left for the sku  | [optional] 
+**sku_identifier** | **String** | The identifier of the sku  | [optional] 
+**properties** | [**Array<SkuPriceOptionProperty>**](SkuPriceOptionProperty.md) | The properties associated with this sku  | [optional] 
+
+

data/docs/SkuPriceOptionProperty.md

@@ -0,0 +1,13 @@
+# AliseeksApi::SkuPriceOptionProperty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_id** | **Integer** | The ID of the property  | [optional] 
+**property_name** | **String** | The name of the property  | [optional] 
+**value_id** | **Integer** | The ID of the property value  | [optional] 
+**value_name** | **String** | The name of the property value  | [optional] 
+**value_display_name** | **String** | The display name of the property value  | [optional] 
+**ship_from_country** | **String** | The country that the sku is shipped from  | [optional] 
+
+

data/docs/SkuProperty.md

@@ -0,0 +1,10 @@
+# AliseeksApi::SkuProperty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_id** | **Integer** | The ID of the SKU property  | [optional] 
+**property_name** | **String** | The name of the property  | [optional] 
+**values** | [**Array<SkuPropertyValue>**](SkuPropertyValue.md) | The values of this SKU property  | [optional] 
+
+

data/docs/SkuPropertyValue.md

@@ -0,0 +1,10 @@
+# AliseeksApi::SkuPropertyValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_value_name** | **String** | The name of a sku value  | [optional] 
+**property_value_id** | **Integer** | The ID of the sku value  | [optional] 
+**property_value_display_name** | **String** | The display name of the sku value  | [optional] 
+
+

data/docs/StringRange.md

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

data/docs/TimeDuration.md

@@ -0,0 +1,11 @@
+# AliseeksApi::TimeDuration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **Integer** |  | [optional] 
+**hours** | **Integer** |  | [optional] 
+**minutes** | **Integer** |  | [optional] 
+**seconds** | **Integer** |  | [optional] 
+
+

data/docs/TradeInformation.md

@@ -0,0 +1,9 @@
+# AliseeksApi::TradeInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stock** | **Integer** | The product stock  | [optional] 
+**sold** | **Integer** | The amount sold of the product | [optional] 
+
+

data/docs/UploadImageByUrlRequest.md

@@ -0,0 +1,8 @@
+# AliseeksApi::UploadImageByUrlRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The web address of the image. Make sure its accessible from the public internet.  | [optional] 
+
+

data/docs/UploadImageResponse.md

@@ -0,0 +1,8 @@
+# AliseeksApi::UploadImageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upload_key** | **String** | The upload key that should be used when performing an image search request  | [optional] 
+
+

data/docs/WebError.md

@@ -0,0 +1,11 @@
+# AliseeksApi::WebError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exception** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**cause** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="aliseeks"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="connect-ruby-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/aliseeks_api.rb

@@ -0,0 +1,100 @@
+=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
+
+# Common files
+require 'aliseeks_api/api_client'
+require 'aliseeks_api/api_error'
+require 'aliseeks_api/version'
+require 'aliseeks_api/configuration'
+
+# Models
+require 'aliseeks_api/models/amount'
+require 'aliseeks_api/models/best_selling_search_item'
+require 'aliseeks_api/models/best_selling_search_request'
+require 'aliseeks_api/models/best_selling_search_response'
+require 'aliseeks_api/models/double_range'
+require 'aliseeks_api/models/image_search_category'
+require 'aliseeks_api/models/image_search_item'
+require 'aliseeks_api/models/image_search_request'
+require 'aliseeks_api/models/image_search_response'
+require 'aliseeks_api/models/integer_range'
+require 'aliseeks_api/models/non_realtime_currency'
+require 'aliseeks_api/models/price_range'
+require 'aliseeks_api/models/price_summary'
+require 'aliseeks_api/models/product'
+require 'aliseeks_api/models/product_attribute'
+require 'aliseeks_api/models/product_bulk_option'
+require 'aliseeks_api/models/product_detail'
+require 'aliseeks_api/models/product_details_request'
+require 'aliseeks_api/models/product_html_description'
+require 'aliseeks_api/models/product_html_description_request'
+require 'aliseeks_api/models/product_price_option'
+require 'aliseeks_api/models/product_promotion'
+require 'aliseeks_api/models/product_property_variation_identifier'
+require 'aliseeks_api/models/product_request'
+require 'aliseeks_api/models/product_request_component'
+require 'aliseeks_api/models/product_review'
+require 'aliseeks_api/models/product_reviews'
+require 'aliseeks_api/models/product_reviews_request'
+require 'aliseeks_api/models/product_seller'
+require 'aliseeks_api/models/product_shipping'
+require 'aliseeks_api/models/product_shipping_options'
+require 'aliseeks_api/models/product_shipping_request'
+require 'aliseeks_api/models/product_sku'
+require 'aliseeks_api/models/product_skus'
+require 'aliseeks_api/models/product_skus_request'
+require 'aliseeks_api/models/promotion_option'
+require 'aliseeks_api/models/realtime_currency'
+require 'aliseeks_api/models/realtime_search_aggregation'
+require 'aliseeks_api/models/realtime_search_item'
+require 'aliseeks_api/models/realtime_search_request'
+require 'aliseeks_api/models/realtime_search_response'
+require 'aliseeks_api/models/search_aggregation'
+require 'aliseeks_api/models/search_item'
+require 'aliseeks_api/models/search_item_freight'
+require 'aliseeks_api/models/search_item_freight_type'
+require 'aliseeks_api/models/search_item_seller'
+require 'aliseeks_api/models/search_price_option'
+require 'aliseeks_api/models/search_request'
+require 'aliseeks_api/models/search_response'
+require 'aliseeks_api/models/sku_price_option'
+require 'aliseeks_api/models/sku_price_option_property'
+require 'aliseeks_api/models/sku_property'
+require 'aliseeks_api/models/sku_property_value'
+require 'aliseeks_api/models/string_range'
+require 'aliseeks_api/models/time_duration'
+require 'aliseeks_api/models/trade_information'
+require 'aliseeks_api/models/upload_image_by_url_request'
+require 'aliseeks_api/models/upload_image_response'
+require 'aliseeks_api/models/web_error'
+
+# APIs
+require 'aliseeks_api/api/products_api'
+require 'aliseeks_api/api/search_api'
+
+module AliseeksApi
+  class << self
+    # Customize default settings for the SDK using block.
+    #   AliseeksApi.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/aliseeks_api/api/products_api.rb

@@ -0,0 +1,337 @@
+=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
+
+require 'uri'
+
+module AliseeksApi
+  class ProductsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get products details as an aggregated request from AliExpress in realtime. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductRequest] :product_request The request body of get product 
+    # @return [Product]
+    def get_product(opts = {})
+      data, _status_code, _headers = get_product_with_http_info(opts)
+      data
+    end
+
+    # Get products details as an aggregated request from AliExpress in realtime. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProductRequest] :product_request The request body of get product 
+    # @return [Array<(Product, Fixnum, Hash)>] Product data, response status code and response headers
+    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
+
+    # Gets product details from AliExpress in realtime. 
+    # @param product_details_request The request body to get product details 
+    # @param [Hash] opts the optional parameters
+    # @return [ProductDetail]
+    def get_product_details(product_details_request, opts = {})
+      data, _status_code, _headers = get_product_details_with_http_info(product_details_request, opts)
+      data
+    end
+
+    # Gets product details from AliExpress in realtime. 
+    # @param product_details_request The request body to get product details 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProductDetail, Fixnum, Hash)>] ProductDetail data, response status code and response headers
+    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 from AliExpress in realtime. 
+    # @param product_html_description_request The request body to get product html description 
+    # @param [Hash] opts the optional parameters
+    # @return [ProductHtmlDescription]
+    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 from AliExpress in realtime. 
+    # @param product_html_description_request The request body to get product html description 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProductHtmlDescription, Fixnum, Hash)>] ProductHtmlDescription data, response status code and response headers
+    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 from AliExpress in realtime 
+    # @param product_reviews_request The request body to get product reviews 
+    # @param [Hash] opts the optional parameters
+    # @return [ProductReviews]
+    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 from AliExpress in realtime 
+    # @param product_reviews_request The request body to get product reviews 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProductReviews, Fixnum, Hash)>] ProductReviews data, response status code and response headers
+    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
+
+    # Gets product shipping information AliExpress in realtime. 
+    # @param product_shipping_request The request body to get product shipping 
+    # @param [Hash] opts the optional parameters
+    # @return [ProductShipping]
+    def get_product_shipping(product_shipping_request, opts = {})
+      data, _status_code, _headers = get_product_shipping_with_http_info(product_shipping_request, opts)
+      data
+    end
+
+    # Gets product shipping information AliExpress in realtime. 
+    # @param product_shipping_request The request body to get product shipping 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProductShipping, Fixnum, Hash)>] ProductShipping data, response status code and response headers
+    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
+
+    # Gets product skus / variation information from AliExpress in realtime. 
+    # @param product_skus_request The request body to get product skus / variations 
+    # @param [Hash] opts the optional parameters
+    # @return [ProductSkus]
+    def get_product_skus(product_skus_request, opts = {})
+      data, _status_code, _headers = get_product_skus_with_http_info(product_skus_request, opts)
+      data
+    end
+
+    # Gets product skus / variation information from AliExpress in realtime. 
+    # @param product_skus_request The request body to get product skus / variations 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProductSkus, Fixnum, Hash)>] ProductSkus data, response status code and response headers
+    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
+
+  end
+end