Class: SmartRecruiters::ApplicationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smart_recruiters/api/application_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApplicationApi

Returns a new instance of ApplicationApi.



5
6
7
 
# File 'lib/smart_recruiters/api/application_api.rb', line 5

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



3
4
5
 
# File 'lib/smart_recruiters/api/application_api.rb', line 3

def api_client
  @api_client
end

Instance Method Details

#create_candidate(body, uuid, opts = {}) ⇒ ApplyApiResponse

Create candidate. Operation is done on behalf of candidate. It means that candidate can later on see and edit this data - that includes attachments.

Parameters:

  • body —

    New candidate data

  • uuid —

    Posting UUID

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

    the optional parameters

Returns:



13
14
15
16
 
# File 'lib/smart_recruiters/api/application_api.rb', line 13

def create_candidate(body, uuid, opts = {})
  data, _status_code, _headers = create_candidate_with_http_info(body, uuid, opts)
  data
end

#create_candidate_with_http_info(body, uuid, opts = {}) ⇒ Array<(ApplyApiResponse, Integer, Hash)>

Create candidate. Operation is done on behalf of candidate. It means that candidate can later on see and edit this data - that includes attachments.

Parameters:

  • body —

    New candidate data

  • uuid —

    Posting UUID

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

    the optional parameters

Returns:

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

    ApplyApiResponse data, response status code and response headers



23
24
25
26
27
28
29
30
31
32
33
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
 
# File 'lib/smart_recruiters/api/application_api.rb', line 23

def create_candidate_with_http_info(body, uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationApi.create_candidate ...'
  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 ApplicationApi.create_candidate"
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling ApplicationApi.create_candidate"
  end
  # resource path
  local_var_path = '/postings/{uuid}/candidates'.sub('{' + 'uuid' + '}', uuid.to_s)

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'ApplyApiResponse' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationApi#create_candidate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_status(uuid, candidate_id, opts = {}) ⇒ ApplicationStatusInfo

Get candidate status

Parameters:

  • uuid —

    Posting UUID

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

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/smart_recruiters/api/application_api.rb', line 75

def get_application_status(uuid, candidate_id, opts = {})
  data, _status_code, _headers = get_application_status_with_http_info(uuid, candidate_id, opts)
  data
end

#get_application_status_with_http_info(uuid, candidate_id, opts = {}) ⇒ Array<(ApplicationStatusInfo, Integer, Hash)>

Get candidate status

Parameters:

  • uuid —

    Posting UUID

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

    the optional parameters

Returns:

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

    ApplicationStatusInfo data, response status code and response headers



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/smart_recruiters/api/application_api.rb', line 85

def get_application_status_with_http_info(uuid, candidate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationApi.get_application_status ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling ApplicationApi.get_application_status"
  end
  # verify the required parameter 'candidate_id' is set
  if @api_client.config.client_side_validation && candidate_id.nil?
    fail ArgumentError, "Missing the required parameter 'candidate_id' when calling ApplicationApi.get_application_status"
  end
  # resource path
  local_var_path = '/postings/{uuid}/candidates/{candidateId}/status'.sub('{' + 'uuid' + '}', uuid.to_s).sub('{' + 'candidateId' + '}', candidate_id.to_s)

  # 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'])

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

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

  return_type = opts[:return_type] || 'ApplicationStatusInfo' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationApi#get_application_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_apply_configuration_for_posting(uuid, opts = {}) ⇒ ApplyConfiguration

Get screening question for posting

Parameters:

  • uuid —

    Posting UUID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language for screening questions. By default &#x27;en&#x27;.

Returns:



135
136
137
138
 
# File 'lib/smart_recruiters/api/application_api.rb', line 135

def get_apply_configuration_for_posting(uuid, opts = {})
  data, _status_code, _headers = get_apply_configuration_for_posting_with_http_info(uuid, opts)
  data
end

#get_apply_configuration_for_posting_with_http_info(uuid, opts = {}) ⇒ Array<(ApplyConfiguration, Integer, Hash)>

Get screening question for posting

Parameters:

  • uuid —

    Posting UUID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language for screening questions. By default &#x27;en&#x27;.

Returns:

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

    ApplyConfiguration data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/smart_recruiters/api/application_api.rb', line 145

def get_apply_configuration_for_posting_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationApi.get_apply_configuration_for_posting ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling ApplicationApi.get_apply_configuration_for_posting"
  end
  # resource path
  local_var_path = '/postings/{uuid}/configuration'.sub('{' + 'uuid' + '}', uuid.to_s)

  # 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'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?

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

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

  return_type = opts[:return_type] || 'ApplyConfiguration' 

  auth_names = opts[:auth_names] || ['key', 'oauth']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationApi#get_apply_configuration_for_posting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end