Class: YousignClient::ServerStampsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServerStampsApi

Returns a new instance of ServerStampsApi.



19
20
21
 
# File 'lib/yousign_client/api/server_stamps_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/server_stamps_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#server_stamps_id_get(id, opts = {}) ⇒ ServerStampOutput

Find a Server Stamp by ID

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/yousign_client/api/server_stamps_api.rb', line 26

def server_stamps_id_get(id, opts = {})
  data, _status_code, _headers = server_stamps_id_get_with_http_info(id, opts)
  data
end

#server_stamps_id_get_with_http_info(id, opts = {}) ⇒ Array<(ServerStampOutput, Fixnum, Hash)>

Find a Server Stamp by ID

Parameters:

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

    the optional parameters

Returns:

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

    ServerStampOutput data, response status code and response headers



35
36
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
 
# File 'lib/yousign_client/api/server_stamps_api.rb', line 35

def server_stamps_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServerStampsApi.server_stamps_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 ServerStampsApi.server_stamps_id_get"
  end
  # resource path
  local_var_path = '/server_stamps/{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 => 'ServerStampOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServerStampsApi#server_stamps_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#server_stamps_post(body, opts = {}) ⇒ ServerStampOutput

Create a Server Stamp

Parameters:

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/yousign_client/api/server_stamps_api.rb', line 78

def server_stamps_post(body, opts = {})
  data, _status_code, _headers = server_stamps_post_with_http_info(body, opts)
  data
end

#server_stamps_post_with_http_info(body, opts = {}) ⇒ Array<(ServerStampOutput, Fixnum, Hash)>

Create a Server Stamp

Parameters:

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

    the optional parameters

Returns:

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

    ServerStampOutput data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/yousign_client/api/server_stamps_api.rb', line 87

def server_stamps_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServerStampsApi.server_stamps_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 ServerStampsApi.server_stamps_post"
  end
  # resource path
  local_var_path = '/server_stamps'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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 => 'ServerStampOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServerStampsApi#server_stamps_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end