swagger_client

SwaggerClient - the Ruby gem for the

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/facestorept/api-sdk-ruby, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/facestorept/api-sdk-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

# Setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: APIKeyHeader
  config.api_key['APIToken'] = '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['APIToken'] = 'Bearer'
end

api_instance = SwaggerClient::BrandsApi.new

brand = SwaggerClient::Brand.new # Brand | Brand to add to the store


begin
  result = api_instance.add_brands(brand)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling BrandsApi->add_brands: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.facestore.local/v1

Class	Method	HTTP request	Description
SwaggerClient::BrandsApi	add_brands	POST /brands
SwaggerClient::BrandsApi	delete_brand_by_id	DELETE /brands/{id}/
SwaggerClient::BrandsApi	get_brand_by_id	GET /brands/{id}/
SwaggerClient::BrandsApi	get_brands	GET /brands
SwaggerClient::BrandsApi	update_category_by_id	PUT /brands/{id}/
SwaggerClient::BrandsApi	update_category_by_id_0	PATCH /brands/{id}/
SwaggerClient::CategoriesApi	add_categories	POST /categories
SwaggerClient::CategoriesApi	delete_category_by_id	DELETE /categories/{id}/
SwaggerClient::CategoriesApi	get_categories	GET /categories
SwaggerClient::CategoriesApi	get_category_by_id	GET /categories/{id}/
SwaggerClient::CategoriesApi	update_category_by_id	PUT /categories/{id}/
SwaggerClient::CustomersApi	get_customer_by_id	GET /customers/{id}/
SwaggerClient::CustomersApi	get_customers	GET /customers
SwaggerClient::OrdersApi	get_order_by_id	GET /orders/{id}/
SwaggerClient::OrdersApi	get_orders	GET /orders
SwaggerClient::PaymentsApi	get_payment_by_id	GET /payments/{id}/
SwaggerClient::PaymentsApi	get_payments	GET /payments
SwaggerClient::ProductsApi	add_product	POST /products
SwaggerClient::ProductsApi	delete_product_by_id	DELETE /products/{id}/
SwaggerClient::ProductsApi	get_product_by_id	GET /products/{id}/
SwaggerClient::ProductsApi	get_products	GET /products
SwaggerClient::ProductsApi	update_product_by_id	PUT /products/{id}/
SwaggerClient::ProductsApi	update_product_by_id_0	PATCH /products/{id}/
SwaggerClient::ProductsAttributesApi	add_products_attributes	POST /attributes
SwaggerClient::ProductsAttributesApi	delete_product_attribute_by_id	DELETE /attributes/{id}/
SwaggerClient::ProductsAttributesApi	get_product_attribute_by_id	GET /attributes/{id}/
SwaggerClient::ProductsAttributesApi	get_products_attributes	GET /attributes
SwaggerClient::ProductsAttributesApi	update_product_attribute_by_id	PUT /attributes/{id}/
SwaggerClient::ShippingsApi	add_shipping	POST /shippings
SwaggerClient::ShippingsApi	delete_shipping_by_id	DELETE /shippings/{id}/
SwaggerClient::ShippingsApi	get_shipping_by_id	GET /shippings/{id}/
SwaggerClient::ShippingsApi	get_shippings	GET /shippings
SwaggerClient::ShippingsApi	update_shipping_by_id	PUT /shippings/{id}/
SwaggerClient::ShippingsApi	update_shipping_by_id_0	PATCH /shippings/{id}/
SwaggerClient::TaxesApi	add_taxes	POST /taxes
SwaggerClient::TaxesApi	delete_tax_by_id	DELETE /taxes/{id}/
SwaggerClient::TaxesApi	get_tax_by_id	GET /taxes/{id}/
SwaggerClient::TaxesApi	get_taxes	GET /taxes
SwaggerClient::TaxesApi	update_tax_by_id	PUT /taxes/{id}/
SwaggerClient::TaxesApi	update_tax_by_id_0	PATCH /taxes/{id}/

Documentation for Models

• SwaggerClient::Attribute
• SwaggerClient::AttributeOptions
• SwaggerClient::Brand
• SwaggerClient::Category
• SwaggerClient::Customer
• SwaggerClient::DefaultResponse
• SwaggerClient::I18n
• SwaggerClient::I18nProduct
• SwaggerClient::I18nProductSeo
• SwaggerClient::InlineResponse200
• SwaggerClient::InlineResponse2001
• SwaggerClient::InlineResponse2001Meta
• SwaggerClient::InlineResponse2002
• SwaggerClient::InlineResponse2003
• SwaggerClient::InlineResponse2004
• SwaggerClient::InlineResponse2005
• SwaggerClient::InlineResponse2006
• SwaggerClient::InlineResponse201
• SwaggerClient::InlineResponse2011
• SwaggerClient::InlineResponse2012
• SwaggerClient::InlineResponse2013
• SwaggerClient::InlineResponse2014
• SwaggerClient::MetaPartialResponse
• SwaggerClient::NotFoundResponse
• SwaggerClient::Options
• SwaggerClient::Order
• SwaggerClient::Payment
• SwaggerClient::Product
• SwaggerClient::Shipping
• SwaggerClient::Tax

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: APIToken
• Location: HTTP header