Class: Athenian::IntegrationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/api/integrations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi

Returns a new instance of IntegrationsApi.



16
17
18
 
# File 'lib/athenian/api/integrations_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/athenian/api/integrations_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_everything(opts = {}) ⇒ File

Download all the data collected by Athenian for custom analysis.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account (Integer) —

    Numeric identifier of the account. Raises HTTP 400 if the user belongs to more than one account.

  • :format (String) —

    Output file format. The default is `parquet`.

Returns:

  • (File) 


24
25
26
27
 
# File 'lib/athenian/api/integrations_api.rb', line 24

def get_everything(opts = {})
  data, _status_code, _headers = get_everything_with_http_info(opts)
  data
end

#get_everything_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Download all the data collected by Athenian for custom analysis.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account (Integer) —

    Numeric identifier of the account. Raises HTTP 400 if the user belongs to more than one account.

  • :format (String) —

    Output file format. The default is &#x60;parquet&#x60;.

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



34
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
74
75
76
77
78
79
80
81
82
 
# File 'lib/athenian/api/integrations_api.rb', line 34

def get_everything_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_everything ...'
  end
  allowable_values = ['parquet']
  if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
    fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/get/export'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"IntegrationsApi.get_everything",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_everything\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#match_identities(body, opts = {}) ⇒ Array<MatchedIdentity>

Match provided people names/logins/emails to the account’s GitHub organization members.

Parameters:

Returns:



88
89
90
91
 
# File 'lib/athenian/api/integrations_api.rb', line 88

def match_identities(body, opts = {})
  data, _status_code, _headers = match_identities_with_http_info(body, opts)
  data
end

#match_identities_with_http_info(body, opts = {}) ⇒ Array<(Array<MatchedIdentity>, Integer, Hash)>

Match provided people names/logins/emails to the account&#39;s GitHub organization members.

Parameters:

Returns:

  • (Array<(Array<MatchedIdentity>, Integer, Hash)>) —

    Array<MatchedIdentity> data, response status code and response headers



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/athenian/api/integrations_api.rb', line 97

def match_identities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.match_identities ...'
  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 IntegrationsApi.match_identities"
  end
  # resource path
  local_var_path = '/match/identities'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<MatchedIdentity>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"IntegrationsApi.match_identities",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#match_identities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end