doorflow-api

DoorFlow - the Ruby gem for the DoorFlow API

Access control and door management API for DoorFlow

This SDK is automatically generated by the OpenAPI Generator project:

API version: 3.0
Package version: 1.1.0
Generator version: 7.24.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://doorflow.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build doorflow-api.gemspec

Then either install the gem locally:

gem install ./doorflow-1.1.0.gem

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

Install from Git

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

gem 'doorflow-api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'doorflow-api'

# Setup authorization
DoorFlow.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = DoorFlow::AccountsApi.new

begin
  #Get current account details
  result = api_instance.get_account
  p result
rescue DoorFlow::ApiError => e
  puts "Exception when calling AccountsApi->get_account: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.doorflow.com

Class	Method	HTTP request	Description
DoorFlow::AccountsApi	get_account	GET /api/3/account	Get current account details
DoorFlow::AdmissionRequestsApi	get_admission_request	GET /api/3/admission_requests/{id}	Get admission request status
DoorFlow::CardDesignsApi	create_card_design	POST /api/3/card_designs	Create card design
DoorFlow::CardDesignsApi	delete_card_design	DELETE /api/3/card_designs/{id}	Delete card design
DoorFlow::CardDesignsApi	get_card_design	GET /api/3/card_designs/{id}	Get card design
DoorFlow::CardDesignsApi	list_card_designs	GET /api/3/card_designs	List card designs
DoorFlow::CardDesignsApi	update_card_design	PUT /api/3/card_designs/{id}	Update card design
DoorFlow::CardTemplateTypesApi	create_card_template_type	POST /api/3/card_template_types	Create card template type
DoorFlow::CardTemplateTypesApi	delete_card_template_type	DELETE /api/3/card_template_types/{code}	Delete card template type
DoorFlow::CardTemplateTypesApi	get_card_template_type	GET /api/3/card_template_types/{code}	Get card template type
DoorFlow::CardTemplateTypesApi	list_card_template_types	GET /api/3/card_template_types	List card template types
DoorFlow::CardTemplateTypesApi	update_card_template_type	PUT /api/3/card_template_types/{code}	Update card template type
DoorFlow::CardTemplatesApi	create_card_template	POST /api/3/card_templates	Create card template
DoorFlow::CardTemplatesApi	delete_card_template	DELETE /api/3/card_templates/{id}	Delete card template (hard-delete)
DoorFlow::CardTemplatesApi	delete_card_template_background_image	DELETE /api/3/card_templates/{id}/background_image/{side}	Delete background image
DoorFlow::CardTemplatesApi	delete_card_template_file	DELETE /api/3/card_templates/{id}/files/{file_uuid}	Delete linked file
DoorFlow::CardTemplatesApi	get_card_template	GET /api/3/card_templates/{id}	Get card template
DoorFlow::CardTemplatesApi	get_card_template_background_image	GET /api/3/card_templates/{id}/background_image/{side}	Get background image
DoorFlow::CardTemplatesApi	list_card_template_files	GET /api/3/card_templates/{id}/files	List linked files
DoorFlow::CardTemplatesApi	list_card_templates	GET /api/3/card_templates	List card templates
DoorFlow::CardTemplatesApi	update_card_template	PUT /api/3/card_templates/{id}	Update card template
DoorFlow::CardTemplatesApi	update_card_template_background_image	PUT /api/3/card_templates/{id}/background_image/{side}	Upload background image
DoorFlow::CardTemplatesApi	upload_card_template_file	PUT /api/3/card_templates/{id}/files/{file_uuid}	Upload or replace linked file
DoorFlow::ChannelsApi	admit_channel	POST /api/3/channels/{id}/admit	Admit through channel (any person)
DoorFlow::ChannelsApi	admit_person	POST /api/3/channels/{id}/admit_person	Admit specific person through channel
DoorFlow::ChannelsApi	auto_unlock_channel	POST /api/3/channels/{id}/auto_unlock	Set auto-unlock shift
DoorFlow::ChannelsApi	get_channel	GET /api/3/channels/{id}	Get channel details
DoorFlow::ChannelsApi	list_channels	GET /api/3/channels	List channels (door controllers)
DoorFlow::ChannelsApi	lockdown_channel	POST /api/3/channels/{id}/lockdown	Enable lockdown mode
DoorFlow::ChannelsApi	normal_channel	POST /api/3/channels/{id}/normal	Return channel to normal mode
DoorFlow::ChannelsApi	regenerate_encryption_key	POST /api/3/channels/{id}/regenerate_encryption_key	Regenerate encryption key
DoorFlow::ChannelsApi	remove_encryption_key	POST /api/3/channels/{id}/remove_encryption_key	Remove encryption key
DoorFlow::ChannelsApi	unlock_channel	POST /api/3/channels/{id}/unlock	Unlock channel (unlock mode)
DoorFlow::ChannelsApi	unlockdown_channel	POST /api/3/channels/{id}/unlockdown	Disable lockdown mode
DoorFlow::CredentialTypesApi	list_credential_types	GET /api/3/credential_types	List credential types
DoorFlow::CredentialsApi	create_credential	POST /api/3/people/{person_id}/credentials	Create credential
DoorFlow::CredentialsApi	delete_credential	DELETE /api/3/people/{person_id}/credentials/{id}	Delete credential
DoorFlow::CredentialsApi	get_credential	GET /api/3/people/{person_id}/credentials/{id}	Get credential details
DoorFlow::CredentialsApi	list_all_credentials	GET /api/3/credentials	List all credentials
DoorFlow::CredentialsApi	list_person_credentials	GET /api/3/people/{person_id}/credentials	List person credentials
DoorFlow::CredentialsApi	update_credential	PUT /api/3/people/{person_id}/credentials/{id}	Update credential
DoorFlow::ElementSessionsApi	create_element_session	POST /api/3/element_sessions	Create an Elements widget session
DoorFlow::EventsApi	get_event	GET /api/3/events/{id}	Get event details
DoorFlow::EventsApi	list_events	GET /api/3/events	List events
DoorFlow::GroupReservationsApi	create_group_reservation	POST /api/3/group_reservations	Create group reservation
DoorFlow::GroupReservationsApi	delete_group_reservation	DELETE /api/3/group_reservations/{id}	Delete group reservation
DoorFlow::GroupReservationsApi	get_group_reservation	GET /api/3/group_reservations/{id}	Get group reservation
DoorFlow::GroupReservationsApi	list_group_reservations	GET /api/3/group_reservations	List group reservations
DoorFlow::GroupsApi	list_groups	GET /api/3/groups	List groups
DoorFlow::NotificationRulesApi	create_notification_rule	POST /api/3/notification_rules	Create notification rule
DoorFlow::NotificationRulesApi	delete_notification_rule	DELETE /api/3/notification_rules/{id}	Delete notification rule
DoorFlow::NotificationRulesApi	get_notification_rule	GET /api/3/notification_rules/{id}	Get notification rule details
DoorFlow::NotificationRulesApi	list_notification_rules	GET /api/3/notification_rules	List notification rules
DoorFlow::NotificationRulesApi	update_notification_rule	PUT /api/3/notification_rules/{id}	Update notification rule
DoorFlow::OauthApi	authorize_o_auth	GET /oauth/authorize	Authorization endpoint
DoorFlow::OauthApi	get_access_token	POST /oauth/token	Obtain access token
DoorFlow::OauthApi	get_token_info	GET /oauth/token/info	Get token information
DoorFlow::OauthApi	revoke_token	POST /oauth/revoke	Revoke access token or refresh token
DoorFlow::PeopleApi	create_person	POST /api/3/people	Create person
DoorFlow::PeopleApi	delete_person	DELETE /api/3/people/{id}	Delete person
DoorFlow::PeopleApi	get_person	GET /api/3/people/{id}	Get person details
DoorFlow::PeopleApi	list_people	GET /api/3/people	List people
DoorFlow::PeopleApi	update_person	PUT /api/3/people/{id}	Update person
DoorFlow::ReservationsApi	create_reservation	POST /api/3/reservations	Create reservation
DoorFlow::ReservationsApi	delete_reservation	DELETE /api/3/reservations/{id}	Delete reservation
DoorFlow::ReservationsApi	list_reservations	GET /api/3/reservations	List reservations
DoorFlow::RolesApi	list_roles	GET /api/3/roles	List roles
DoorFlow::SitesApi	list_sites	GET /api/3/sites	List sites
DoorFlow::SyncApi	initiate_sync	POST /api/3/sync	Initiate sync

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

OAuth2

Type: OAuth
Flow: accessCode
Authorization URL: /oauth/authorize
Scopes: N/A

basicAuth

Type: HTTP basic authentication

doorflow

Development

Runtime