class Vecos::Releezme

• Vecos::Releezme
• PlaceOS::Driver
• Reference
• Object

Defined in:

vecos/releezme.cr

Class Method Summary

• .driver_interface : String

Instance Method Summary

• #bank(bank_id : String)
• #bank_group_lockers_available(bank_id : String, group_id : String)
• #bank_groups(bank_id : String)
• #bank_locker_allocations(bank_id : String)

  NOTE : Only accessible to System Control Clients

• #bank_lockers(bank_id : String)

  returns all the lockers in the bank without paging (but paging json is included)

• #banks
• #bearer_token : String
• #book_locker(starting : Int64, ending : Int64, user_id : String, locker_id : String | Nil = nil, group_id : String | Nil = nil, bank_id : String | Nil = nil, timezone : String = "UTC")
• #bookings(user_id : String)
• #bookings_availability(user_id : String, starting : Int64, ending : Int64, section_id : String | Nil = nil, location_id : String | Nil = nil, bank_id : String | Nil = nil, group_id : String | Nil = nil, locker_id : String | Nil = nil)
• #can_allocate_locker?(user_id : String) : String

  check if a user can be allocated a new locker

• #can_share_locker_with?(locker_id : String, owner_id : String, search : String)
• #companies
• #fetch_item(location : String) : String
• #fetch_pages(location : String) : Array(JSON::Any)
• #group(group_id : String)
• #group_locker_banks(group_id : String)
• #groups
• #location(location_id : String)
• #location_sections(location_id : String)

  typically these are floors in the building

• #locations

  typically these are buildings

• #locker_allocate(locker_id : String, user_id : String)
• #locker_allocate_random(bank_id : String, group_id : String, user_id : String)
• #locker_release(locker_id : String, user_id : String | Nil = nil) : Nil
• #locker_shared_with?(locker_id : String, owner_id : String)
• #locker_unlock(locker_id : String, pin_code : String | Nil = nil)
• #lockers_allocated_to(user_id : String)

  the lockers that are currently allocated to the specified user the user ID is typically email - defined by the client

• #on_update
• #section(section_id : String)
• #section_banks_allocatable(section_id : String, user_id : String)

  banks and groups in the banks that the user can allocate to themselves

• #section_locker_banks(section_id : String)
• #sections

  all floors from all buildings in one request

• #share_locker_with(locker_id : String, owner_id : String, user_id : String) : Bool
• #unshare_locker(locker_id : String, owner_id : String, shared_with_internal_id : String | Nil = nil) : Bool

Class Method Detail

Instance Method Detail