Class: DocuSign_eSign::OrganizationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = OrganizationsApi.default) ⇒ OrganizationsApi

Returns a new instance of OrganizationsApi.


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

def initialize(api_client = OrganizationsApi.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/organizations_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#delete_report(organization_id, report_correlation_id) ⇒ nil

Retrieves org level report by correlation id and site.

Parameters:

  • organization_id
  • report_correlation_id

Returns:

  • (nil)

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

def delete_report(organization_id, report_correlation_id)
  delete_report_with_http_info(organization_id, report_correlation_id)
  return nil
end

#delete_report_with_http_info(organization_id, report_correlation_id) ⇒ Array<(nil, Fixnum, Hash)>

Retrieves org level report by correlation id and site.

Parameters:

  • organization_id
  • report_correlation_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/organizations_api.rb', line 40

def delete_report_with_http_info(organization_id, report_correlation_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationsApi.delete_report ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.delete_report" 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.delete_report" if report_correlation_id.nil?
  # resource path
  local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{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(:DELETE, 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#delete_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report(organization_id, report_correlation_id) ⇒ nil

Retrieves org level report by correlation id and site.

Parameters:

  • organization_id
  • report_correlation_id

Returns:

  • (nil)

82
83
84
85
# File 'lib/docusign_esign/api/organizations_api.rb', line 82

def get_report(organization_id, report_correlation_id)
  get_report_with_http_info(organization_id, report_correlation_id)
  return nil
end

#get_report_with_http_info(organization_id, report_correlation_id) ⇒ Array<(nil, Fixnum, Hash)>

Retrieves org level report by correlation id and site.

Parameters:

  • organization_id
  • report_correlation_id

Returns:

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

    nil, response status code and response headers


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
124
125
126
127
# File 'lib/docusign_esign/api/organizations_api.rb', line 92

def get_report_with_http_info(organization_id, report_correlation_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OrganizationsApi.get_report ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report" 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" if report_correlation_id.nil?
  # resource path
  local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end