doorflow 1.0.0

data/lib/doorflow-api/api/credential_types_api.rb

@@ -0,0 +1,88 @@
+=begin
+#DoorFlow API
+
+#Access control and door management API for DoorFlow
+
+The version of the OpenAPI document: 3.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module DoorFlow
+  class CredentialTypesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List credential types
+    # Returns a paginated list of credential types configured for the authenticated user's account. Credential types define the formats and types of credentials (cards, PINs, mobile access, etc.) that can be used. Each credential type is based on a global credential type and can be customized per account. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<CredentialType>]
+    def list_credential_types(opts = {})
+      data, _status_code, _headers = list_credential_types_with_http_info(opts)
+      data
+    end
+
+    # List credential types
+    # Returns a paginated list of credential types configured for the authenticated user&#39;s account. Credential types define the formats and types of credentials (cards, PINs, mobile access, etc.) that can be used. Each credential type is based on a global credential type and can be customized per account. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<(Array<CredentialType>, Integer, Hash)>] Array<CredentialType> data, response status code and response headers
+    def list_credential_types_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialTypesApi.list_credential_types ...'
+      end
+      # resource path
+      local_var_path = '/api/3/credential_types'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'skip_pagination'] = opts[:'skip_pagination'] if !opts[:'skip_pagination'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CredentialType>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialTypesApi.list_credential_types",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialTypesApi#list_credential_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/doorflow-api/api/credentials_api.rb

@@ -0,0 +1,458 @@
+=begin
+#DoorFlow API
+
+#Access control and door management API for DoorFlow
+
+The version of the OpenAPI document: 3.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module DoorFlow
+  class CredentialsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create credential
+    # Creates a new credential for a person. For HID Mobile Access and PassFlow credentials, this initiates an invitation process.
+    # @param person_id [Integer] Person ID
+    # @param credential_input [CredentialInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Credential]
+    def create_credential(person_id, credential_input, opts = {})
+      data, _status_code, _headers = create_credential_with_http_info(person_id, credential_input, opts)
+      data
+    end
+
+    # Create credential
+    # Creates a new credential for a person. For HID Mobile Access and PassFlow credentials, this initiates an invitation process.
+    # @param person_id [Integer] Person ID
+    # @param credential_input [CredentialInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Credential, Integer, Hash)>] Credential data, response status code and response headers
+    def create_credential_with_http_info(person_id, credential_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.create_credential ...'
+      end
+      # verify the required parameter 'person_id' is set
+      if @api_client.config.client_side_validation && person_id.nil?
+        fail ArgumentError, "Missing the required parameter 'person_id' when calling CredentialsApi.create_credential"
+      end
+      # verify the required parameter 'credential_input' is set
+      if @api_client.config.client_side_validation && credential_input.nil?
+        fail ArgumentError, "Missing the required parameter 'credential_input' when calling CredentialsApi.create_credential"
+      end
+      # resource path
+      local_var_path = '/api/3/people/{person_id}/credentials'.sub('{' + 'person_id' + '}', CGI.escape(person_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(credential_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Credential'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.create_credential",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#create_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete credential
+    # Deletes a credential. For HID Mobile Access credentials, this deactivates the mobile credential.
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid) or HID invitation ID (format 99xxxxxxxx)
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def delete_credential(person_id, id, opts = {})
+      data, _status_code, _headers = delete_credential_with_http_info(person_id, id, opts)
+      data
+    end
+
+    # Delete credential
+    # Deletes a credential. For HID Mobile Access credentials, this deactivates the mobile credential.
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid) or HID invitation ID (format 99xxxxxxxx)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def delete_credential_with_http_info(person_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.delete_credential ...'
+      end
+      # verify the required parameter 'person_id' is set
+      if @api_client.config.client_side_validation && person_id.nil?
+        fail ArgumentError, "Missing the required parameter 'person_id' when calling CredentialsApi.delete_credential"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CredentialsApi.delete_credential"
+      end
+      # resource path
+      local_var_path = '/api/3/people/{person_id}/credentials/{id}'.sub('{' + 'person_id' + '}', CGI.escape(person_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.delete_credential",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#delete_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get credential details
+    # Returns details for a specific credential
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid) or HID invitation ID (format 99xxxxxxxx)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :callback Webhook callback ID for acknowledgment
+    # @option opts [String] :ack_token Webhook acknowledgment token
+    # @return [Credential]
+    def get_credential(person_id, id, opts = {})
+      data, _status_code, _headers = get_credential_with_http_info(person_id, id, opts)
+      data
+    end
+
+    # Get credential details
+    # Returns details for a specific credential
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid) or HID invitation ID (format 99xxxxxxxx)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :callback Webhook callback ID for acknowledgment
+    # @option opts [String] :ack_token Webhook acknowledgment token
+    # @return [Array<(Credential, Integer, Hash)>] Credential data, response status code and response headers
+    def get_credential_with_http_info(person_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.get_credential ...'
+      end
+      # verify the required parameter 'person_id' is set
+      if @api_client.config.client_side_validation && person_id.nil?
+        fail ArgumentError, "Missing the required parameter 'person_id' when calling CredentialsApi.get_credential"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CredentialsApi.get_credential"
+      end
+      # resource path
+      local_var_path = '/api/3/people/{person_id}/credentials/{id}'.sub('{' + 'person_id' + '}', CGI.escape(person_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'callback'] = opts[:'callback'] if !opts[:'callback'].nil?
+      query_params[:'ack_token'] = opts[:'ack_token'] if !opts[:'ack_token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Credential'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.get_credential",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#get_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all credentials
+    # Returns a paginated list of all credentials accessible to the authenticated user
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<Credential>]
+    def list_all_credentials(opts = {})
+      data, _status_code, _headers = list_all_credentials_with_http_info(opts)
+      data
+    end
+
+    # List all credentials
+    # Returns a paginated list of all credentials accessible to the authenticated user
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<(Array<Credential>, Integer, Hash)>] Array<Credential> data, response status code and response headers
+    def list_all_credentials_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.list_all_credentials ...'
+      end
+      # resource path
+      local_var_path = '/api/3/credentials'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'skip_pagination'] = opts[:'skip_pagination'] if !opts[:'skip_pagination'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Credential>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.list_all_credentials",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#list_all_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List person credentials
+    # Returns a paginated list of credentials for a specific person, or all credentials if no person_id is provided
+    # @param person_id [Integer] Person ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<Credential>]
+    def list_person_credentials(person_id, opts = {})
+      data, _status_code, _headers = list_person_credentials_with_http_info(person_id, opts)
+      data
+    end
+
+    # List person credentials
+    # Returns a paginated list of credentials for a specific person, or all credentials if no person_id is provided
+    # @param person_id [Integer] Person ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page Number of results per page (default to 500)
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Boolean] :skip_pagination Skip pagination and return all results
+    # @return [Array<(Array<Credential>, Integer, Hash)>] Array<Credential> data, response status code and response headers
+    def list_person_credentials_with_http_info(person_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.list_person_credentials ...'
+      end
+      # verify the required parameter 'person_id' is set
+      if @api_client.config.client_side_validation && person_id.nil?
+        fail ArgumentError, "Missing the required parameter 'person_id' when calling CredentialsApi.list_person_credentials"
+      end
+      # resource path
+      local_var_path = '/api/3/people/{person_id}/credentials'.sub('{' + 'person_id' + '}', CGI.escape(person_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'skip_pagination'] = opts[:'skip_pagination'] if !opts[:'skip_pagination'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Credential>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.list_person_credentials",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#list_person_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update credential
+    # Updates the value of an existing credential
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid)
+    # @param credential_update_input [CredentialUpdateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Credential]
+    def update_credential(person_id, id, credential_update_input, opts = {})
+      data, _status_code, _headers = update_credential_with_http_info(person_id, id, credential_update_input, opts)
+      data
+    end
+
+    # Update credential
+    # Updates the value of an existing credential
+    # @param person_id [Integer] Person ID
+    # @param id [String] Credential ID (hashid)
+    # @param credential_update_input [CredentialUpdateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Credential, Integer, Hash)>] Credential data, response status code and response headers
+    def update_credential_with_http_info(person_id, id, credential_update_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CredentialsApi.update_credential ...'
+      end
+      # verify the required parameter 'person_id' is set
+      if @api_client.config.client_side_validation && person_id.nil?
+        fail ArgumentError, "Missing the required parameter 'person_id' when calling CredentialsApi.update_credential"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CredentialsApi.update_credential"
+      end
+      # verify the required parameter 'credential_update_input' is set
+      if @api_client.config.client_side_validation && credential_update_input.nil?
+        fail ArgumentError, "Missing the required parameter 'credential_update_input' when calling CredentialsApi.update_credential"
+      end
+      # resource path
+      local_var_path = '/api/3/people/{person_id}/credentials/{id}'.sub('{' + 'person_id' + '}', CGI.escape(person_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(credential_update_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Credential'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CredentialsApi.update_credential",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CredentialsApi#update_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end