Skip to content

Latest commit

 

History

History
595 lines (409 loc) · 12.6 KB

HostApi.md

File metadata and controls

595 lines (409 loc) · 12.6 KB
Raw

BmxApiRuby::HostApi

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

Method HTTP request Description
get_host_counts GET /host/counts counts
get_host_info GET /host/info get host info
get_host_next_week_ends GET /host/next_week_ends next week-ends
get_host_ping GET /host/ping check server access
post_host_rebuild POST /host/rebuild rebuild
put_host_go_past_end_of_day PUT /host/go_past_end_of_day go past end-of-day
put_host_go_past_end_of_month PUT /host/go_past_end_of_month go past end-of-month
put_host_go_past_end_of_week PUT /host/go_past_end_of_week go past end-of-week
put_host_increment_day_offset PUT /host/increment_day_offset increment day offset
put_host_increment_hour_offset PUT /host/increment_hour_offset increment hour offset
put_host_set_current_time PUT /host/set_current_time set current time

get_host_counts

HostCount get_host_counts

counts

Show host object counts: number of users, offers, contracts, etc.

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

begin
  #counts
  result = api_instance.get_host_counts
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->get_host_counts: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

HostCount

Authorization

base

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_host_info

HostInfo get_host_info(opts)

get host info

Show host info: host-time, day offset, datastore type, etc.

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  strftime: "strftime_example" # String | STRFTIME string for host_time
}

begin
  #get host info
  result = api_instance.get_host_info(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->get_host_info: #{e}"
end

Parameters

Name Type Description Notes
strftime String STRFTIME string for host_time [optional]

Return type

HostInfo

Authorization

base

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_host_next_week_ends

NextWeekEnds get_host_next_week_ends(opts)

next week-ends

next week-ends

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 4)
}

begin
  #next week-ends
  result = api_instance.get_host_next_week_ends(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->get_host_next_week_ends: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 4) [optional]

Return type

NextWeekEnds

Authorization

base

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_host_ping

Status get_host_ping

check server access

check server access

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

begin
  #check server access
  result = api_instance.get_host_ping
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->get_host_ping: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

post_host_rebuild

Status post_host_rebuild(affirm, opts)

rebuild

Destroy all data and rebuild the system. The rebuilt system will have one user: user/pass = [email protected]/bugmark. To run this command, you must post a confirmation parameter: /host/rebuild?confirm=destroy_all_data Optionally, you can use the 'with_day_offset' param to set the start date for your system. This can be used for simulations where you want to use historical data: host/rebuild?confirm=destroy_all_data&with_day_offset=-90 The rebuild command is intended for use on hosts dedicated for research and testing. (and not production!) The rebuild command will work for hosts with mutable datastores, and will fail for hosts with permanent datastores. View the datastore setting with the /hosts/info command.

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

affirm = "affirm_example" # String | confirmation

opts = { 
  with_day_offset: 56 # Integer | initial day offset
}

begin
  #rebuild
  result = api_instance.post_host_rebuild(affirm, opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->post_host_rebuild: #{e}"
end

Parameters

Name Type Description Notes
affirm String confirmation
with_day_offset Integer initial day offset [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_go_past_end_of_day

Status put_host_go_past_end_of_day(opts)

go past end-of-day

go past end-of-day

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 1)
}

begin
  #go past end-of-day
  result = api_instance.put_host_go_past_end_of_day(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_go_past_end_of_day: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 1) [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_go_past_end_of_month

Status put_host_go_past_end_of_month(opts)

go past end-of-month

go past end-of-month

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 1)
}

begin
  #go past end-of-month
  result = api_instance.put_host_go_past_end_of_month(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_go_past_end_of_month: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 1) [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_go_past_end_of_week

Status put_host_go_past_end_of_week(opts)

go past end-of-week

go past end-of-week

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 1)
}

begin
  #go past end-of-week
  result = api_instance.put_host_go_past_end_of_week(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_go_past_end_of_week: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 1) [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_increment_day_offset

Status put_host_increment_day_offset(opts)

increment day offset

increment day offset

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 1)
}

begin
  #increment day offset
  result = api_instance.put_host_increment_day_offset(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_increment_day_offset: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 1) [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_increment_hour_offset

Status put_host_increment_hour_offset(opts)

increment hour offset

increment hour offset

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

opts = { 
  count: 56 # Integer | count (default 1)
}

begin
  #increment hour offset
  result = api_instance.put_host_increment_hour_offset(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_increment_hour_offset: #{e}"
end

Parameters

Name Type Description Notes
count Integer count (default 1) [optional]

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

put_host_set_current_time

Status put_host_set_current_time

set current time

set current time

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::HostApi.new

begin
  #set current time
  result = api_instance.put_host_set_current_time
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling HostApi->put_host_set_current_time: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Status

Authorization

base

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json