Class: SignRequestClient::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



19
20
21
 
# File 'lib/signrequest_client/api/events_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/signrequest_client/api/events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#events_list(opts = {}) ⇒ InlineResponse2004

Retrieve a list of Events

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :document__uuid (String)
  • :document__external_id (String)
  • :document__signrequest__who (String)
  • :document__signrequest__from_email (String)
  • :document__status (String)
  • :document__user__email (String)
  • :document__user__first_name (String)
  • :document__user__last_name (String)
  • :delivered (String)
  • :delivered_on (String)
  • :timestamp (String)
  • :status (String)
  • :event_type (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:



41
42
43
44
 
# File 'lib/signrequest_client/api/events_api.rb', line 41

def events_list(opts = {})
  data, _status_code, _headers = events_list_with_http_info(opts)
  data
end

#events_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2004, Fixnum, Hash)>

Retrieve a list of Events

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :document__uuid (String)
  • :document__external_id (String)
  • :document__signrequest__who (String)
  • :document__signrequest__from_email (String)
  • :document__status (String)
  • :document__user__email (String)
  • :document__user__first_name (String)
  • :document__user__last_name (String)
  • :delivered (String)
  • :delivered_on (String)
  • :timestamp (String)
  • :status (String)
  • :event_type (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.

Returns:

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

    InlineResponse2004 data, response status code and response headers



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
 
# File 'lib/signrequest_client/api/events_api.rb', line 65

def events_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_list ...'
  end
  # resource path
  local_var_path = '/events/'

  # query parameters
  query_params = {}
  query_params[:'document__uuid'] = opts[:'document__uuid'] if !opts[:'document__uuid'].nil?
  query_params[:'document__external_id'] = opts[:'document__external_id'] if !opts[:'document__external_id'].nil?
  query_params[:'document__signrequest__who'] = opts[:'document__signrequest__who'] if !opts[:'document__signrequest__who'].nil?
  query_params[:'document__signrequest__from_email'] = opts[:'document__signrequest__from_email'] if !opts[:'document__signrequest__from_email'].nil?
  query_params[:'document__status'] = opts[:'document__status'] if !opts[:'document__status'].nil?
  query_params[:'document__user__email'] = opts[:'document__user__email'] if !opts[:'document__user__email'].nil?
  query_params[:'document__user__first_name'] = opts[:'document__user__first_name'] if !opts[:'document__user__first_name'].nil?
  query_params[:'document__user__last_name'] = opts[:'document__user__last_name'] if !opts[:'document__user__last_name'].nil?
  query_params[:'delivered'] = opts[:'delivered'] if !opts[:'delivered'].nil?
  query_params[:'delivered_on'] = opts[:'delivered_on'] if !opts[:'delivered_on'].nil?
  query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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 = ['Token']
  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 => 'InlineResponse2004')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#events_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#events_read(id, opts = {}) ⇒ Event

Retrieve an Event

Parameters:

  • id —

    A unique integer value identifying this event.

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

    the optional parameters

Returns:



120
121
122
123
 
# File 'lib/signrequest_client/api/events_api.rb', line 120

def events_read(id, opts = {})
  data, _status_code, _headers = events_read_with_http_info(id, opts)
  data
end

#events_read_with_http_info(id, opts = {}) ⇒ Array<(Event, Fixnum, Hash)>

Retrieve an Event

Parameters:

  • id —

    A unique integer value identifying this event.

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

    the optional parameters

Returns:

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

    Event data, response status code and response headers



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/signrequest_client/api/events_api.rb', line 130

def events_read_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_read ...'
  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 EventsApi.events_read"
  end
  # resource path
  local_var_path = '/events/{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 = ['Token']
  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 => 'Event')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#events_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end