gooten_api_client

GootenApiClient - the Ruby gem for the Gooten API

Version: 1.0.0

Automatically generated by the Ruby Swagger Codegen project:

• Build date: 2016-03-28T15:29:43.427Z
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

You can build the generated client into a gem:

gem build gooten_api_client.gemspec

Then you can either install the gem:

gem install ./gooten_api_client-1.0.0.gem

or publish the gem to a gem server like RubyGems.

Finally add this to your Gemfile:

gem 'gooten_api_client', '~> 1.0.0'

Host as a git repository

You can also choose to host the generated client as a git repository, e.g. on github: https://github.com/YOUR_USERNAME/YOUR_REPO

Then you can reference it in Gemfile:

gem 'gooten_api_client', :git => 'https://github.com/YOUR_USERNAME/YOUR_REPO.git'

Use without installation

You can also use the client directly like this:

ruby -Ilib script.rb

Getting Started

require 'gooten_api_client'

GootenApiClient.configure do |config|
  # Use the line below to configure API key authorization if needed:
  #config.api_key['api_key'] = 'your api key'

  config.host = 'petstore.swagger.io'
  config.base_path = '/v2'
  # Enable debugging (default is disabled).
  config.debugging = true
end

# Assuming there's a `PetApi` containing a `get_pet_by_id` method
# which returns a model object:
pet_api = GootenApiClient::PetApi.new
pet = pet_api.get_pet_by_id(5)
puts pet.to_body

Documentation for API Endpoints

All URIs are relative to https://localhost/api

Class	Method	HTTP request	Description
GootenApiClient::AddressvalidationApi	addressvalidation	GET /addressvalidation/	Validates an address and returns a suggested address (if available) and a validation score.
GootenApiClient::CountriesApi	countries	GET /countries/	Get a list of supported countries. Output is in specified language.
GootenApiClient::ImagesApi	post_images	POST /images/	POSTs files to a temporary store
GootenApiClient::ImagevalidationApi	p_ost_imagevalidation	POST /imagevalidation/	Submit image validation
GootenApiClient::LanguagesApi	get_language_text	GET /languages/	Get text in a specified language
GootenApiClient::OrdersApi	g_et_orders	GET /v/{version}/source/{source}/orders/	Get an order
GootenApiClient::OrdersApi	p_ost_orders	POST /v/{version}/source/{source}/orders/	Submit an order
GootenApiClient::OrdersearchApi	g_et_ordersearch	GET /ordersearch/	Search an orders
GootenApiClient::OrderstatusApi	p_ost_orderstatus	POST /orderstatus/	Update an order status
GootenApiClient::PaymentvalidationApi	paymentvalidation	GET /paymentvalidation/	Submit payment validation for PayPal
GootenApiClient::PreconfiguredproductsApi	create_preconfiguredproducts	POST /v/{version}/source/{source}/preconfiguredproducts/	Insert a preconfigured product
GootenApiClient::PreconfiguredproductsApi	delete_preconfiguredproducts	DELETE /v/{version}/source/{source}/preconfiguredproducts/	Delete a preconfigured product
GootenApiClient::PreconfiguredproductsApi	get_preconfiguredproducts	GET /v/{version}/source/{source}/preconfiguredproducts/	Get a list of your preconfigured products
GootenApiClient::PreconfiguredproductsApi	update_preconfiguredproducts	PUT /v/{version}/source/{source}/preconfiguredproducts/	Update a preconfigured product
GootenApiClient::PriceestimateApi	p_ost_priceestimate	POST /v/{version}/source/{source}/priceestimate/	Get an order price
GootenApiClient::ProductpreviewApi	p_ost_productpreview	POST /productpreview/	Submit an image (or images) to be rendered into a product preview.
GootenApiClient::ProductsApi	get_products	GET /v/{version}/source/{source}/products/	Get a list of products
GootenApiClient::ProducttemplatesApi	get_producttemplates	GET /producttemplates/	Get a list of product templates
GootenApiClient::ProductvariantsApi	get_productvariants	GET /v/{version}/source/{source}/productvariants/	Get a list of available product variations. Includes pricing information
GootenApiClient::ShippingpricesApi	p_ost_shippingprices	POST /shippingprices/	Get a list of shipping options and prices for items
GootenApiClient::ShippriceestimateApi	get_shippriceestimate	GET /shippriceestimate/	Get a baseline ship price for an item
GootenApiClient::UserinfoApi	get_userinfo	GET /userinfo/	Get the user's language code and country based upon IP

Documentation for Models

• GootenApiClient::Address
• GootenApiClient::Category
• GootenApiClient::Country
• GootenApiClient::CountryList
• GootenApiClient::Currency
• GootenApiClient::FileResult
• GootenApiClient::Image
• GootenApiClient::ImageSizeVm
• GootenApiClient::ImageValidationVm
• GootenApiClient::ImageValidatorResult
• GootenApiClient::Item
• GootenApiClient::KeyValuePair
• GootenApiClient::LanguageDictionary
• GootenApiClient::Meta
• GootenApiClient::Order
• GootenApiClient::OrderItem
• GootenApiClient::OrderItemImage
• GootenApiClient::OrderPayment
• GootenApiClient::OrderPriceResult
• GootenApiClient::OrderResult
• GootenApiClient::OrderStatusUpdateResult
• GootenApiClient::Payment
• GootenApiClient::PaymentValidationRequest
• GootenApiClient::PaymentValidationResponse
• GootenApiClient::PostOrder
• GootenApiClient::PostOrderItem
• GootenApiClient::PostSubmittedItem
• GootenApiClient::PostSubmittedOrder
• GootenApiClient::Preconfiguration
• GootenApiClient::PreconfiguredItem
• GootenApiClient::PreconfiguredProduct
• GootenApiClient::PreconfiguredProductImage
• GootenApiClient::PreconfiguredProductInsert
• GootenApiClient::PreconfiguredProductsInsertResponse
• GootenApiClient::PreconfiguredProductsResponse
• GootenApiClient::PriceInfo
• GootenApiClient::Product
• GootenApiClient::ProductBuildInfo
• GootenApiClient::ProductBuildInfoResponse
• GootenApiClient::ProductBuildInfoSpace
• GootenApiClient::ProductBuildOption
• GootenApiClient::ProductImage
• GootenApiClient::ProductInfo
• GootenApiClient::ProductList
• GootenApiClient::ProductOption
• GootenApiClient::ProductOptionList
• GootenApiClient::ProductOptionValueSettings
• GootenApiClient::ProductPreviewImage
• GootenApiClient::ProductPreviewImageSpec
• GootenApiClient::ProductPreviewRequest
• GootenApiClient::ProductPreviewResponse
• GootenApiClient::ProductPriceInfo
• GootenApiClient::ProductVariant
• GootenApiClient::ProductVariantResponse
• GootenApiClient::Result
• GootenApiClient::SearchSubmittedOrder
• GootenApiClient::ShipEstimate
• GootenApiClient::ShipItem
• GootenApiClient::ShipOption
• GootenApiClient::ShipPrice
• GootenApiClient::ShipToAddress
• GootenApiClient::Shipment
• GootenApiClient::ShippingPricesRequest
• GootenApiClient::ShippingPricesResult
• GootenApiClient::SkuQuantityPair
• GootenApiClient::SubmittedOrder
• GootenApiClient::SubmittedOrderList
• GootenApiClient::UserInfo
• GootenApiClient::ValidationFailure

Documentation for Authorization

All endpoints do not require authorization.