OpenapiClient - the Ruby gem for the Stateset

This is the Stateset One API based on The OpenAPI Specification.

This API definition is intended to to be a good starting point for describing your API in OpenAPI/Swagger format.

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit http:https://stateset.com/support

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_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 'openapi_client', '~> 1.0.0'

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

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

# Load the gem
require 'openapi_client'

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

  # Configure OAuth2 access token for authorization: main_auth
  config.access_token = 'YOUR ACCESS TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = OpenapiClient::AccountsApi.new
limit = 8.14 # Float | The number of items to return
offset = 8.14 # Float | Filter users without email
order_direction = 'order_direction_example' # String | Direction to return accounts

begin
  #Get account by account name
  result = api_instance.get_account_by_name(limit, offset, order_direction)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling AccountsApi->get_account_by_name: #{e}"
end

All URIs are relative to https://api.stateset.com/v1

• OpenapiClient::Accounts
• OpenapiClient::BillOfMaterials
• OpenapiClient::BillOfMaterialsLineItem
• OpenapiClient::Customers
• OpenapiClient::InventoryItems
• OpenapiClient::ManufactureOrder
• OpenapiClient::ManufactureOrderLineItem
• OpenapiClient::Messages
• OpenapiClient::ModelReturn
• OpenapiClient::Notes
• OpenapiClient::Problem
• OpenapiClient::ReturnItem
• OpenapiClient::Warranty
• OpenapiClient::WarrantyItem
• OpenapiClient::WorkOrder
• OpenapiClient::WorkOrderLineItems

Authentication schemes defined for the API:

• Type: OAuth
• Flow: implicit
• Authorization URL: https://api.stateset.com/v1/oauth/dialog
• Scopes:
  • read:users: read users info
  • write:users: modify or remove users

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

• Type: HTTP basic authentication