whitelabelmachinename-ruby-sdk 3.0.6

data/lib/whitelabelmachinename-ruby-sdk/api/payment_processor_service_api.rb

@@ -0,0 +1,139 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module WhiteLabelMachineName
+  class PaymentProcessorService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # All
+    # This operation returns all entities which are available.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<PaymentProcessor>]
+    def all(opts = {})
+      data, _status_code, _headers = all_with_http_info(opts)
+      return data
+    end
+
+    # All
+    # This operation returns all entities which are available.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<PaymentProcessor>, Fixnum, Hash)>] Array<PaymentProcessor> data, response status code and response headers
+    def all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentProcessorService.all ..."
+      end
+      # resource path
+      local_var_path = "/payment-processor/all".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<PaymentProcessor>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentProcessorService#all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read
+    # Reads the entity with the given 'id' and returns it.
+    # @param id The id of the processor which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentProcessor]
+    def read(id, opts = {})
+      data, _status_code, _headers = read_with_http_info(id, opts)
+      return data
+    end
+
+    # Read
+    # Reads the entity with the given &#39;id&#39; and returns it.
+    # @param id The id of the processor which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentProcessor, Fixnum, Hash)>] PaymentProcessor data, response status code and response headers
+    def read_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentProcessorService.read ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling PaymentProcessorService.read" if id.nil?
+      # resource path
+      local_var_path = "/payment-processor/read".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PaymentProcessor')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentProcessorService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb

@@ -0,0 +1,213 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module WhiteLabelMachineName
+  class PaymentTerminalService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Count
+    # Counts the number of items in the database as restricted by the given filter.
+    # @param space_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count.
+    # @return [Integer]
+    def count(space_id, opts = {})
+      data, _status_code, _headers = count_with_http_info(space_id, opts)
+      return data
+    end
+
+    # Count
+    # Counts the number of items in the database as restricted by the given filter.
+    # @param space_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count.
+    # @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
+    def count_with_http_info(space_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentTerminalService.count ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.count" if space_id.nil?
+      # resource path
+      local_var_path = "/payment-terminal/count".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json;charset=utf-8']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'filter'])
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Integer')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTerminalService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read
+    # Reads the entity with the given 'id' and returns it.
+    # @param space_id 
+    # @param id The id of the payment terminal which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentTerminal]
+    def read(space_id, id, opts = {})
+      data, _status_code, _headers = read_with_http_info(space_id, id, opts)
+      return data
+    end
+
+    # Read
+    # Reads the entity with the given &#39;id&#39; and returns it.
+    # @param space_id 
+    # @param id The id of the payment terminal which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentTerminal, Fixnum, Hash)>] PaymentTerminal data, response status code and response headers
+    def read_with_http_info(space_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentTerminalService.read ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.read" if space_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling PaymentTerminalService.read" if id.nil?
+      # resource path
+      local_var_path = "/payment-terminal/read".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PaymentTerminal')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTerminalService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search
+    # Searches for the entities as specified by the given query.
+    # @param space_id 
+    # @param query The query restricts the payment terminals which are returned by the search.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<PaymentTerminal>]
+    def search(space_id, query, opts = {})
+      data, _status_code, _headers = search_with_http_info(space_id, query, opts)
+      return data
+    end
+
+    # Search
+    # Searches for the entities as specified by the given query.
+    # @param space_id 
+    # @param query The query restricts the payment terminals which are returned by the search.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<PaymentTerminal>, Fixnum, Hash)>] Array<PaymentTerminal> data, response status code and response headers
+    def search_with_http_info(space_id, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentTerminalService.search ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.search" if space_id.nil?
+      # verify the required parameter 'query' is set
+      fail ArgumentError, "Missing the required parameter 'query' when calling PaymentTerminalService.search" if query.nil?
+      # resource path
+      local_var_path = "/payment-terminal/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json;charset=utf-8']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(query)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<PaymentTerminal>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTerminalService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_till_service_api.rb

@@ -0,0 +1,170 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module WhiteLabelMachineName
+  class PaymentTerminalTillService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Perform Payment Terminal Transaction
+    # Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.
+    # @param space_id 
+    # @param transaction_id The ID of the transaction which is used to process with the terminal.
+    # @param terminal_id The ID of the terminal which should be used to process the transaction.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :language The language in which the messages should be rendered in.
+    # @return [Transaction]
+    def perform_transaction(space_id, transaction_id, terminal_id, opts = {})
+      data, _status_code, _headers = perform_transaction_with_http_info(space_id, transaction_id, terminal_id, opts)
+      return data
+    end
+
+    # Perform Payment Terminal Transaction
+    # Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.
+    # @param space_id 
+    # @param transaction_id The ID of the transaction which is used to process with the terminal.
+    # @param terminal_id The ID of the terminal which should be used to process the transaction.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :language The language in which the messages should be rendered in.
+    # @return [Array<(Transaction, Fixnum, Hash)>] Transaction data, response status code and response headers
+    def perform_transaction_with_http_info(space_id, transaction_id, terminal_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentTerminalTillService.perform_transaction ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalTillService.perform_transaction" if space_id.nil?
+      # verify the required parameter 'transaction_id' is set
+      fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentTerminalTillService.perform_transaction" if transaction_id.nil?
+      # verify the required parameter 'terminal_id' is set
+      fail ArgumentError, "Missing the required parameter 'terminal_id' when calling PaymentTerminalTillService.perform_transaction" if terminal_id.nil?
+      # resource path
+      local_var_path = "/payment-terminal-till/perform-transaction".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'transactionId'] = transaction_id
+      query_params[:'terminalId'] = terminal_id
+      query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json;charset=utf-8']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Transaction')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTerminalTillService#perform_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Perform Payment Terminal Transaction (using TID)
+    # Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.
+    # @param space_id 
+    # @param transaction_id The ID of the transaction which is used to process with the terminal.
+    # @param terminal_identifier The identifier (aka TID) of the terminal which should be used to process the transaction.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :language The language in which the messages should be rendered in.
+    # @return [Transaction]
+    def perform_transaction_by_identifier(space_id, transaction_id, terminal_identifier, opts = {})
+      data, _status_code, _headers = perform_transaction_by_identifier_with_http_info(space_id, transaction_id, terminal_identifier, opts)
+      return data
+    end
+
+    # Perform Payment Terminal Transaction (using TID)
+    # Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.
+    # @param space_id 
+    # @param transaction_id The ID of the transaction which is used to process with the terminal.
+    # @param terminal_identifier The identifier (aka TID) of the terminal which should be used to process the transaction.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :language The language in which the messages should be rendered in.
+    # @return [Array<(Transaction, Fixnum, Hash)>] Transaction data, response status code and response headers
+    def perform_transaction_by_identifier_with_http_info(space_id, transaction_id, terminal_identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PaymentTerminalTillService.perform_transaction_by_identifier ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if space_id.nil?
+      # verify the required parameter 'transaction_id' is set
+      fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if transaction_id.nil?
+      # verify the required parameter 'terminal_identifier' is set
+      fail ArgumentError, "Missing the required parameter 'terminal_identifier' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if terminal_identifier.nil?
+      # resource path
+      local_var_path = "/payment-terminal-till/perform-transaction-by-identifier".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'transactionId'] = transaction_id
+      query_params[:'terminalIdentifier'] = terminal_identifier
+      query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json;charset=utf-8']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Transaction')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentTerminalTillService#perform_transaction_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/whitelabelmachinename-ruby-sdk/api/permission_service_api.rb

@@ -0,0 +1,139 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module WhiteLabelMachineName
+  class PermissionService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # All
+    # This operation returns all entities which are available.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Permission>]
+    def all(opts = {})
+      data, _status_code, _headers = all_with_http_info(opts)
+      return data
+    end
+
+    # All
+    # This operation returns all entities which are available.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Permission>, Fixnum, Hash)>] Array<Permission> data, response status code and response headers
+    def all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PermissionService.all ..."
+      end
+      # resource path
+      local_var_path = "/permission/all".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Permission>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PermissionService#all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read
+    # Reads the entity with the given 'id' and returns it.
+    # @param id The id of the permission which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [Permission]
+    def read(id, opts = {})
+      data, _status_code, _headers = read_with_http_info(id, opts)
+      return data
+    end
+
+    # Read
+    # Reads the entity with the given &#39;id&#39; and returns it.
+    # @param id The id of the permission which should be returned.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Permission, Fixnum, Hash)>] Permission data, response status code and response headers
+    def read_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PermissionService.read ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling PermissionService.read" if id.nil?
+      # resource path
+      local_var_path = "/permission/read".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Permission')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PermissionService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end