class HubriseClient::V1

Public Instance Methods

create_account_catalog(params) click to toggle source
# File lib/hubrise_client/v1.rb, line 132
def create_account_catalog(params)
  call_api("/account/catalogs", :post, data: params)
end
create_customer(params, customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 108
def create_customer(params, customer_list_id = nil)
  call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/customers", :post, data: params)
end
create_image(data, mime_type, catalog_id = nil) click to toggle source

Images


# File lib/hubrise_client/v1.rb, line 151
def create_image(data, mime_type, catalog_id = nil)
  call_api("/catalogs/#{catalog_id_fallback(catalog_id)}/images", :post, data: data,
                                                                          headers: { "Content-Type" => mime_type },
                                                                          json: false)
end
create_location_catalog(params, location_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 136
def create_location_catalog(params, location_id = nil)
  if location_id
    call_api("/locations/#{location_id}/catalogs", :post, data: params)
  else
    call_api("/location/catalogs", :post, data: params)
  end
end
create_order(location_id, params) click to toggle source
# File lib/hubrise_client/v1.rb, line 50
def create_order(location_id, params)
  call_api("/locations/#{location_id}/orders", :post, data: params)
end
delete_callback() click to toggle source
# File lib/hubrise_client/v1.rb, line 77
def delete_callback
  call_api("/callback", :delete)
end
delete_event(event_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 69
def delete_event(event_id)
  call_api("/callback/events/#{event_id}", :delete)
end
get_account(account_id = nil) click to toggle source

Accounts, locations, user


# File lib/hubrise_client/v1.rb, line 11
def get_account(account_id = nil)
  if account_id
    call_api("/accounts/#{account_id}")
  else
    call_api("/account")
  end
end
get_account_catalogs(account_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 124
def get_account_catalogs(account_id)
  call_api("/accounts/#{account_id}/catalogs")
end
get_account_customer_lists(account_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 88
def get_account_customer_lists(account_id)
  call_api("/accounts/#{account_id}/customer_lists")
end
get_accounts() click to toggle source
# File lib/hubrise_client/v1.rb, line 19
def get_accounts
  call_api("/accounts")
end
get_all_customers(customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 96
def get_all_customers(customer_list_id = nil)
  search_customers({}, customer_list_id)
end
get_callback() click to toggle source

Callback, events


# File lib/hubrise_client/v1.rb, line 61
def get_callback
  call_api("/callback")
end
get_callback_events() click to toggle source
# File lib/hubrise_client/v1.rb, line 65
def get_callback_events
  call_api("/callback/events")
end
get_catalog(catalog_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 128
def get_catalog(catalog_id = nil)
  call_api("/catalogs/#{catalog_id_fallback(catalog_id)}")
end
get_customer(customer_id, customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 104
def get_customer(customer_id, customer_list_id = nil)
  call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/customers/#{customer_id}")
end
get_customer_list(customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 92
def get_customer_list(customer_list_id = nil)
  call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}")
end
get_image(image_id, catalog_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 157
def get_image(image_id, catalog_id = nil)
  call_api("/catalogs/#{catalog_id_fallback(catalog_id)}/images/#{image_id}")
end
get_image_data(image_id, catalog_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 161
def get_image_data(image_id, catalog_id = nil)
  call_api("/catalogs/#{catalog_id_fallback(catalog_id)}/images/#{image_id}/data")
end
get_location(location_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 31
def get_location(location_id = nil)
  if location_id
    call_api("/locations/#{location_id}")
  else
    call_api("/location")
  end
end
get_location_catalogs(location_id) click to toggle source

Catalogs


# File lib/hubrise_client/v1.rb, line 120
def get_location_catalogs(location_id)
  call_api("/locations/#{location_id}/catalogs")
end
get_location_customer_lists(location_id) click to toggle source

Customer lists, customers


# File lib/hubrise_client/v1.rb, line 84
def get_location_customer_lists(location_id)
  call_api("/locations/#{location_id}/customer_lists")
end
get_locations() click to toggle source
# File lib/hubrise_client/v1.rb, line 27
def get_locations
  call_api("/locations")
end
get_order(location_id, order_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 46
def get_order(location_id, order_id)
  call_api("/locations/#{location_id}/orders/#{order_id}")
end
get_orders(location_id, search_params) click to toggle source

Orders


# File lib/hubrise_client/v1.rb, line 42
def get_orders(location_id, search_params)
  call_api("/locations/#{location_id}/orders", :get, data: search_params)
end
get_user() click to toggle source
# File lib/hubrise_client/v1.rb, line 23
def get_user
  call_api("/user")
end
search_customers(search_params, customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 100
def search_customers(search_params, customer_list_id = nil)
  call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/customers", :get, data: search_params)
end
update_callback(params) click to toggle source
# File lib/hubrise_client/v1.rb, line 73
def update_callback(params)
  call_api("/callback", :post, data: params)
end
update_catalog(params, catalog_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 144
def update_catalog(params, catalog_id = nil)
  call_api("/catalogs/#{catalog_id_fallback(catalog_id)}", :put, data: params)
end
update_customer(customer_id, params, customer_list_id = nil) click to toggle source
# File lib/hubrise_client/v1.rb, line 112
def update_customer(customer_id, params, customer_list_id = nil)
  call_api("/customer_lists/#{customer_list_id_fallback(customer_list_id)}/customers/#{customer_id}", :put,
            data: params)
end
update_order(location_id, order_id, params) click to toggle source
# File lib/hubrise_client/v1.rb, line 54
def update_order(location_id, order_id, params)
  call_api("/locations/#{location_id}/orders/#{order_id}", :put, data: params)
end
version() click to toggle source
# File lib/hubrise_client/v1.rb, line 4
def version
  :v1
end

Private Instance Methods

catalog_id_fallback(catalog_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 174
def catalog_id_fallback(catalog_id)
  catalog_id ||= @catalog_id
  raise("catalog_id required") if catalog_id.nil? || catalog_id.empty?

  catalog_id
end
customer_list_id_fallback(customer_list_id) click to toggle source
# File lib/hubrise_client/v1.rb, line 167
def customer_list_id_fallback(customer_list_id)
  customer_list_id ||= @customer_list_id
  raise("customer_list_id required") if customer_list_id.nil? || customer_list_id.empty?

  customer_list_id
end