Class: StackOneHRIS::LocationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/stackone_hris_client/api/locations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationsApi

Returns a new instance of LocationsApi.



19
20
21
 
# File 'lib/stackone_hris_client/api/locations_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/stackone_hris_client/api/locations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#hris_locations_get(id, x_account_id, opts = {}) ⇒ LocationResult

Get location

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

Returns:



33
34
35
36
 
# File 'lib/stackone_hris_client/api/locations_api.rb', line 33

def hris_locations_get(id, , opts = {})
  data, _status_code, _headers = hris_locations_get_with_http_info(id, , opts)
  data
end

#hris_locations_get_with_http_info(id, x_account_id, opts = {}) ⇒ Array<(LocationResult, Integer, Hash)>

Get location

Parameters:

  • id (String)
  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

Returns:

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

    LocationResult data, response status code and response headers



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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/stackone_hris_client/api/locations_api.rb', line 49

def hris_locations_get_with_http_info(id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationsApi.hris_locations_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling LocationsApi.hris_locations_get"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling LocationsApi.hris_locations_get"
  end
  # resource path
  local_var_path = '/unified/hris/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
  query_params[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

  new_options = opts.merge(
    :operation => :"LocationsApi.hris_locations_get",
    :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: LocationsApi#hris_locations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#hris_locations_list(x_account_id, opts = {}) ⇒ LocationsPaginated

List locations

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

Returns:



118
119
120
121
 
# File 'lib/stackone_hris_client/api/locations_api.rb', line 118

def hris_locations_list(, opts = {})
  data, _status_code, _headers = hris_locations_list_with_http_info(, opts)
  data
end

#hris_locations_list_with_http_info(x_account_id, opts = {}) ⇒ Array<(LocationsPaginated, Integer, Hash)>

List locations

Parameters:

  • x_account_id (String) —

    The account identifier

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    The page number of the results to fetch

  • :page_size (String) —

    The number of results per page (default to ‘25’)

  • :raw (Boolean) —

    Indicates that the raw request result is returned (default to false)

  • :fields (String) —

    The comma separated list of fields to return in the response (if empty, all fields are returned) (default to ”)

  • :sync_token (String) —

    The sync token to select the only updated results

  • :updated_after (String) —

    Use a string with a date to only select results updated after that given date

Returns:

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

    LocationsPaginated data, response status code and response headers



133
134
135
136
137
138
139
140
141
142
143
144
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/stackone_hris_client/api/locations_api.rb', line 133

def hris_locations_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationsApi.hris_locations_list ...'
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling LocationsApi.hris_locations_list"
  end
  # resource path
  local_var_path = '/unified/hris/locations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'raw'] = opts[:'raw'] if !opts[:'raw'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'sync_token'] = opts[:'sync_token'] if !opts[:'sync_token'].nil?
  query_params[:'updated_after'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basic']

  new_options = opts.merge(
    :operation => :"LocationsApi.hris_locations_list",
    :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: LocationsApi#hris_locations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end