boxx_client 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdcc7974b8242f66a2184c6c48a555203bee419a
+  data.tar.gz: c8d814711f8377c2e7de5a6900d48634806416c4
+SHA512:
+  metadata.gz: 75ffd455f3a9c0f5651463c22558578d3e6f585baaa829fa3a18edcdb95ca5351ffcf351252d3eb16981bf884f71aa9b34d6e7764067f99c74043352962f8df3
+  data.tar.gz: 19e0fc246592625e5abfec4dc9a1762d4bac14c3a988afbfbbae48616a75628b96fbdf446ad4c7b9ed697c2ba77bbd168cc2edd479802a4c4012681713d91715

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,109 @@
+# 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](https://github.com/swagger-api/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:
+
+```shell
+gem build boxx_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# 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**](docs/DeleteAllApi.md#api_data_alldelete_delete) | **DELETE** /api/data/alldelete/ | Delete all documents
+*BoxxClient::DeleteSpecificApi* | [**api_data_delete_delete**](docs/DeleteSpecificApi.md#api_data_delete_delete) | **DELETE** /api/data/delete/ | Delete selected documents
+*BoxxClient::UploadDataApi* | [**api_upload_customer_put**](docs/UploadDataApi.md#api_upload_customer_put) | **PUT** /api/upload/customer/ |
+*BoxxClient::UploadDataApi* | [**api_upload_product_put**](docs/UploadDataApi.md#api_upload_product_put) | **PUT** /api/upload/product/ |
+*BoxxClient::UploadDataApi* | [**api_upload_transaction_put**](docs/UploadDataApi.md#api_upload_transaction_put) | **PUT** /api/upload/transaction/ |
+
+
+## Documentation for Models
+
+ - [BoxxClient::DeleteAll](docs/DeleteAll.md)
+ - [BoxxClient::DeleteSpecific](docs/DeleteSpecific.md)
+ - [BoxxClient::InlineResponse200](docs/InlineResponse200.md)
+ - [BoxxClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [BoxxClient::InlineResponse2001Response](docs/InlineResponse2001Response.md)
+ - [BoxxClient::InlineResponse200Response](docs/InlineResponse200Response.md)
+ - [BoxxClient::InlineResponse400](docs/InlineResponse400.md)
+ - [BoxxClient::InlineResponse4001](docs/InlineResponse4001.md)
+ - [BoxxClient::UploadCustomer](docs/UploadCustomer.md)
+ - [BoxxClient::UploadCustomerDeviceTokens](docs/UploadCustomerDeviceTokens.md)
+ - [BoxxClient::UploadCustomerMobileTokens](docs/UploadCustomerMobileTokens.md)
+ - [BoxxClient::UploadCustomerRequest](docs/UploadCustomerRequest.md)
+ - [BoxxClient::UploadOkResponse](docs/UploadOkResponse.md)
+ - [BoxxClient::UploadOkResponseResult](docs/UploadOkResponseResult.md)
+ - [BoxxClient::UploadProduct](docs/UploadProduct.md)
+ - [BoxxClient::UploadProductRequest](docs/UploadProductRequest.md)
+ - [BoxxClient::UploadTransaction](docs/UploadTransaction.md)
+ - [BoxxClient::UploadTransactionRequest](docs/UploadTransactionRequest.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/boxx_client.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+#
+=begin
+#Upload and Delete Data API
+
+#Boxx.ai's customer, product and interaction data ingestion sdk
+
+OpenAPI spec version: 1.4.1
+Contact: aida@boxx.ai
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "boxx_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "boxx_client"
+  s.version     = BoxxClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rajat Mhetre"]
+  s.email       = ["aida@boxx.ai"]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "Upload and Delete Data API Ruby Gem"
+  s.description = "Boxx.ai's customer, product and interaction data ingestion sdk"
+  # TODO uncommnet and update below with a proper license
+  #s.license     = "Apache 2.0"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/dist/examples/upload_customer.rb

@@ -0,0 +1,76 @@
+require "boxx_client"
+
+CLIENT_ID = "YOUR_CLIENT_ID"
+ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"
+
+
+
+api_instance = BoxxClient::UploadDataApi.new
+
+
+location = [
+  "25.23, 43.2", # longitude, latitude
+] # List of longitude and latitude pairs
+properties = {
+  "name"=> "some_customer",
+  "age"=> 234
+} # Its a key:value pair of customer attributes
+
+
+# Device tokens, optional
+# If you want to push notifications then this is required
+device_token = BoxxClient::UploadCustomerDeviceTokens.new({
+  "endpoint" => "some_endpoint",
+  "p256dh" => "some_valid_value",
+  "auth" => "some_valid_value_of_auth",
+  "browser" => "some_valid_browser_name"
+})
+device_tokens = [device_token] # List of device_token
+
+# Mobile tokens, optional
+# If you want to send app push notifications then this is required
+mobile_token = BoxxClient::UploadCustomerMobileTokens.new({
+    "device_registration" => "some_device_registration_value",
+    "device_platform" => "Android", # Android or iOS
+    "source" => "FCM" # FCM or APNS
+})
+mobile_tokens = [mobile_token] # List of mobile_token
+
+
+data_instance = BoxxClient::UploadCustomer.new({
+  "customerid"=> "some_customer_id", # customerid
+  "email"=> "hello@example.com", # Email address of the customer, optional
+  "phone"=> 8899776655, # mobile number of the customer, optional
+  "location"=> location, # locations of the customer, optional
+  "properties"=> properties, # customer properties, optional
+  "device_tokens" => device_tokens, # optional
+  "mobile_tokens" => mobile_tokens
+})
+
+# You can upload more than 1 customer in one request
+# Its recommended to upload atleast 50 customers in every request
+upload_data = [data_instance] # Its a list of data_instance
+
+
+# Its a key:value pair of customer attribute name and its datatype
+# datatype can be 'number', 'string', 'date', 'location', 'integer'
+data_format = {
+    'name'=> 'string',
+    'age'=> 'integer'
+}
+
+request_data = BoxxClient::UploadCustomerRequest.new({
+  "client_id"=> CLIENT_ID,
+  "access_token"=> ACCESS_TOKEN,
+  "data"=> upload_data,
+  "data_format"=> data_format
+})
+
+
+begin
+  result = api_instance.api_upload_customer_put(request_data)
+  p result.to_s
+rescue BoxxClient::ApiError => e
+  p e.response_body
+  puts "Exception when calling Boxx's API: #{e}"
+end

data/dist/examples/upload_product.rb

@@ -0,0 +1,54 @@
+require "boxx_client"
+
+CLIENT_ID = "YOUR_CLIENT_ID"
+ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"
+
+
+api_instance = BoxxClient::UploadDataApi.new
+
+
+start_date = Time.utc(2018, 1, 4) # utc time
+end_date = Time.utc(2019, 1, 4) # utc time
+location = [
+  "25.23, 43.2", # longitude, latitude
+] # List of longitude and latitude pairs
+properties = {
+  "name"=> "some_product",
+  "price"=> 234
+} # Its a key:value pair of product attributes
+data_instance = BoxxClient::UploadProduct.new({
+  "productid"=> "some_product_id", # productid
+  "active"=> TRUE, # Whether this product is available for sale right now, default is TRUE
+  "start_date"=> start_date, # optional
+  "end_date" => end_date, # start_date and end_date is the date range where product is available for sale, optional
+  "location"=> location, # location where this product is available, optional
+  "properties"=> properties # product properties, optional
+})
+
+# You can upload more than 1 product in one request
+# Its recommended to upload atleast 50 products in every request
+upload_data = [data_instance] # Its a list of data_instance
+
+
+# Its a key:value pair of product attribute name and its datatype
+# datatype can be 'number', 'string', 'date', 'location', 'integer'
+data_format = {
+    'name'=> 'string',
+    'price'=> 'integer'
+}
+
+request_data = BoxxClient::UploadProductRequest.new({
+  "client_id"=> CLIENT_ID,
+  "access_token"=> ACCESS_TOKEN,
+  "data"=> upload_data,
+  "data_format"=> data_format
+})
+
+
+begin
+  result = api_instance.api_upload_product_put(request_data)
+  p result.to_s
+rescue BoxxClient::ApiError => e
+  p e.response_body
+  puts "Exception when calling Boxx's API: #{e}"
+end

data/dist/examples/upload_transaction.rb

@@ -0,0 +1,56 @@
+require "boxx_client"
+
+CLIENT_ID = "YOUR_CLIENT_ID"
+ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"
+
+api_instance = BoxxClient::UploadDataApi.new
+
+
+location = [
+  "25.23, 43.2", # longitude, latitude
+] # List of longitude and latitude pairs
+properties = {
+  "some_attribute": "attributes_value"
+} # Its a key:value pair of attributes
+
+# datetime when transaction has been done. Value should be in UTC
+transactiondate = Time.new(2018, 4, 14)
+
+data_instance = BoxxClient::UploadTransaction.new({
+  "productid"=>"some_product_id", # product's id on which some transaction/interaction has been done
+  "customerid"=> "some_customer_id", # customerid
+  "type"=>"some_valid_action_type", # interaction type i.e ProductView, Buy, AddToCart etc
+  "cookieid" => "some_cookieid", # cookie id of the customer, optional
+  "boxx_token_id" => "some_token_id", # token_id of the device like mobile, tablets etc, optional
+  "location"=> location, # location where transaction has been done, optional
+  "properties"=> properties, # properties, optional
+  "transactiondate" => transactiondate, # datetime when transaction has been done, optional, default value is current time
+
+})
+
+# You can upload more than 1 transactions in one request
+# Its recommended to upload atleast 50 transactions in every request
+upload_data = [data_instance] # Its a list of data_instance
+
+
+# Its a key:value pair of properties' name and its datatype
+# datatype can be 'number', 'string', 'date', 'location', 'integer'
+data_format = {
+    'some_attribute'=> 'string'
+}
+
+request_data = BoxxClient::UploadTransactionRequest.new({
+  "client_id"=> CLIENT_ID,
+  "access_token"=> ACCESS_TOKEN,
+  "data"=> upload_data,
+  "data_format"=> data_format
+})
+
+
+begin
+  result = api_instance.api_upload_transaction_put(request_data)
+  p result.to_s
+rescue BoxxClient::ApiError => e
+  p e.response_body
+  puts "Exception when calling Boxx's API: #{e}"
+end

data/docs/DeleteAll.md

@@ -0,0 +1,10 @@
+# SwaggerClient::DeleteAll
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | client id of the user | 
+**access_token** | **String** | access token of the user | 
+**data_type** | **String** | Type of data. Possible values are ‘customer’, ‘product’ and ‘transaction’ | 
+
+

data/docs/DeleteAllApi.md

@@ -0,0 +1,56 @@
+# SwaggerClient::DeleteAllApi
+
+All URIs are relative to *http://data.boxx.ai*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**api_data_alldelete_delete**](DeleteAllApi.md#api_data_alldelete_delete) | **DELETE** /api/data/alldelete/ | Delete all documents
+
+
+# **api_data_alldelete_delete**
+> InlineResponse2001 api_data_alldelete_delete(request_data)
+
+Delete all documents
+
+It will delete all rows/documents according to the ‘data_type’ mentioned in request. 
+
+### Example
+```ruby
+# load the gem
+require 'boxx_client'
+
+api_instance = SwaggerClient::DeleteAllApi.new
+
+request_data = SwaggerClient::DeleteAll.new # DeleteAll | request data
+
+
+begin
+  #Delete all documents
+  result = api_instance.api_data_alldelete_delete(request_data)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling DeleteAllApi->api_data_alldelete_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_data** | [**DeleteAll**](DeleteAll.md)| request data | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DeleteSpecific.md

@@ -0,0 +1,11 @@
+# SwaggerClient::DeleteSpecific
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | client id of the user | 
+**access_token** | **String** | access token of the user | 
+**data_type** | **String** | Type of data. Possible values are ‘customer’, ‘product’ and ‘transaction’ | 
+**data** | **Array<String>** | list of id of documents/rows, you wish to delete | 
+
+