Class: YousignClient::OperationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/api/operations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OperationsApi

Returns a new instance of OperationsApi.



19
20
21
 
# File 'lib/yousign_client/api/operations_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/yousign_client/api/operations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#operations_id_get(id, authorization, opts = {}) ⇒ OperationOutput

Find an Operation by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/yousign_client/api/operations_api.rb', line 27

def operations_id_get(id, authorization, opts = {})
  data, _status_code, _headers = operations_id_get_with_http_info(id, authorization, opts)
  data
end

#operations_id_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(OperationOutput, Fixnum, Hash)>

Find an Operation by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OperationOutput, Fixnum, Hash)>) —

    OperationOutput data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/yousign_client/api/operations_api.rb', line 37

def operations_id_get_with_http_info(id, authorization, 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
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' 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'])
  header_params[:'Authorization'] = authorization

  # 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 => '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(authorization, content_type, body, opts = {}) ⇒ OperationOutput

Create a new Operation

Parameters:

  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/yousign_client/api/operations_api.rb', line 87

def operations_post(authorization, content_type, body, opts = {})
  data, _status_code, _headers = operations_post_with_http_info(authorization, content_type, body, opts)
  data
end

#operations_post_with_http_info(authorization, content_type, body, opts = {}) ⇒ Array<(OperationOutput, Fixnum, Hash)>

Create a new Operation

Parameters:

  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OperationOutput, Fixnum, Hash)>) —

    OperationOutput data, response status code and response headers



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/yousign_client/api/operations_api.rb', line 98

def operations_post_with_http_info(authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationsApi.operations_post ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling OperationsApi.operations_post"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling 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'])
  header_params[:'Authorization'] = authorization
  header_params[:'Content-Type'] = content_type

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  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 => '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