class YousignClient::OperationsApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/yousign_client/api/operations_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
operations_id_get(id, opts = {})
click to toggle source
Find an Operation by ID @param id @param [Hash] opts the optional parameters @return [OperationOutput]
# File lib/yousign_client/api/operations_api.rb, line 26 def operations_id_get(id, opts = {}) data, _status_code, _headers = operations_id_get_with_http_info(id, opts) data end
operations_id_get_with_http_info(id, opts = {})
click to toggle source
Find an Operation by ID @param id @param [Hash] opts the optional parameters @return [Array<(OperationOutput
, Fixnum, Hash)>] OperationOutput
data, response status code and response headers
# File lib/yousign_client/api/operations_api.rb, line 35 def operations_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OperationsApi.operations_id_get ...' 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 OperationsApi.operations_id_get" end # resource path local_var_path = '/operations/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'OperationOutput') if @api_client.config.debugging @api_client.config.logger.debug "API called: OperationsApi#operations_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
operations_post(body, opts = {})
click to toggle source
Create a new Operation @param body @param [Hash] opts the optional parameters @return [OperationOutput]
# File lib/yousign_client/api/operations_api.rb, line 78 def operations_post(body, opts = {}) data, _status_code, _headers = operations_post_with_http_info(body, opts) data end
operations_post_with_http_info(body, opts = {})
click to toggle source
Create a new Operation @param body @param [Hash] opts the optional parameters @return [Array<(OperationOutput
, Fixnum, Hash)>] OperationOutput
data, response status code and response headers
# File lib/yousign_client/api/operations_api.rb, line 87 def operations_post_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OperationsApi.operations_post ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling OperationsApi.operations_post" end # resource path local_var_path = '/operations' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api_key'] 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 => 'OperationOutput') if @api_client.config.debugging @api_client.config.logger.debug "API called: OperationsApi#operations_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end