class DocuSign_eSign::OrganizationsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = OrganizationsApi.default) click to toggle source

# File lib/docusign_esign/api/organizations_api.rb, line 20
def initialize(api_client = OrganizationsApi.default)
  @api_client = api_client
end

Public Instance Methods

get_report_v2(organization_id, report_correlation_id) click to toggle source

Retrieves org level report by correlation id and site.

@param organization_id @param report_correlation_id @return [nil]

# File lib/docusign_esign/api/organizations_api.rb, line 29
def get_report_v2(organization_id, report_correlation_id)
  get_report_v2_with_http_info(organization_id, report_correlation_id)
  return nil
end

get_report_v2_with_http_info(organization_id, report_correlation_id) click to toggle source

Retrieves org level report by correlation id and site.

@param organization_id @param report_correlation_id @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/docusign_esign/api/organizations_api.rb, line 39
def get_report_v2_with_http_info(organization_id, report_correlation_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationsApi.get_report_v2 ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report_v2" if organization_id.nil?
  # verify the required parameter 'report_correlation_id' is set
  fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.get_report_v2" if report_correlation_id.nil?
  # resource path
  local_var_path = "/v2.1/organization_reporting/{organizationId}/reportsv2/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_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: OrganizationsApi#get_report_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end