boxx_client

BoxxClient - the Ruby gem for the Upload and Delete Data API

Boxx.ai's customer, product and interaction data ingestion sdk

This SDK is automatically generated by the Swagger Codegen project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build boxx_client.gemspec

Then either install the gem locally:

gem install ./boxx_client-1.4.1.gem

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

Install from Git

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

gem 'boxx_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.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 'boxx_client'

api_instance = BoxxClient::DeleteAllApi.new

request_data = BoxxClient::DeleteAll.new # DeleteAll | request data


begin
  #Delete all documents
  result = api_instance.api_data_alldelete_delete(request_data)
  p result
rescue BoxxClient::ApiError => e
  puts "Exception when calling DeleteAllApi->api_data_alldelete_delete: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://data.boxx.ai

Class	Method	HTTP request	Description
BoxxClient::DeleteAllApi	api_data_alldelete_delete	DELETE /api/data/alldelete/	Delete all documents
BoxxClient::DeleteSpecificApi	api_data_delete_delete	DELETE /api/data/delete/	Delete selected documents
BoxxClient::UploadDataApi	api_upload_customer_put	PUT /api/upload/customer/
BoxxClient::UploadDataApi	api_upload_product_put	PUT /api/upload/product/
BoxxClient::UploadDataApi	api_upload_transaction_put	PUT /api/upload/transaction/

Documentation for Models

• BoxxClient::DeleteAll
• BoxxClient::DeleteSpecific
• BoxxClient::InlineResponse200
• BoxxClient::InlineResponse2001
• BoxxClient::InlineResponse2001Response
• BoxxClient::InlineResponse200Response
• BoxxClient::InlineResponse400
• BoxxClient::InlineResponse4001
• BoxxClient::UploadCustomer
• BoxxClient::UploadCustomerDeviceTokens
• BoxxClient::UploadCustomerMobileTokens
• BoxxClient::UploadCustomerRequest
• BoxxClient::UploadOkResponse
• BoxxClient::UploadOkResponseResult
• BoxxClient::UploadProduct
• BoxxClient::UploadProductRequest
• BoxxClient::UploadTransaction
• BoxxClient::UploadTransactionRequest

Documentation for Authorization

All endpoints do not require authorization.