Class: DocuSign_eSign::DataFeedApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/data_feed_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DataFeedApi.default) ⇒ DataFeedApi

Returns a new instance of DataFeedApi.


21
22
23
# File 'lib/docusign_esign/api/data_feed_api.rb', line 21

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


19
20
21
# File 'lib/docusign_esign/api/data_feed_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_data_feed_element(account_id, data_feed_element_id) ⇒ nil

Retrieves a Datafeed element by Id.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • data_feed_element_id

Returns:

  • (nil)

30
31
32
33
# File 'lib/docusign_esign/api/data_feed_api.rb', line 30

def get_data_feed_element(, data_feed_element_id)
  get_data_feed_element_with_http_info(, data_feed_element_id)
  return nil
end

#get_data_feed_element_with_http_info(account_id, data_feed_element_id) ⇒ Array<(nil, Fixnum, Hash)>

Retrieves a Datafeed element by Id.

Parameters:

  • account_id

    The external account number (int) or account ID Guid.

  • data_feed_element_id

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers


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
# File 'lib/docusign_esign/api/data_feed_api.rb', line 40

def get_data_feed_element_with_http_info(, data_feed_element_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataFeedApi.get_data_feed_element ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling DataFeedApi.get_data_feed_element" if .nil?
  # verify the required parameter 'data_feed_element_id' is set
  fail ArgumentError, "Missing the required parameter 'data_feed_element_id' when calling DataFeedApi.get_data_feed_element" if data_feed_element_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/data_feeds/data/{dataFeedElementId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'dataFeedElementId' + '}', data_feed_element_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'])

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataFeedApi#get_data_feed_element\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end