stackone_hris_client 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +40 -24
  3. data/docs/Account.md +2 -2
  4. data/docs/AccountsApi.md +82 -11
  5. data/docs/CompaniesApi.md +175 -0
  6. data/docs/CompaniesPaginated.md +22 -0
  7. data/docs/Company.md +22 -0
  8. data/docs/CompanyResult.md +20 -0
  9. data/docs/ConnectSession.md +2 -2
  10. data/docs/ConnectSessionAuthenticate.md +2 -2
  11. data/docs/ConnectSessionCreate.md +2 -2
  12. data/docs/ConnectSessionToken.md +2 -2
  13. data/docs/ConnectSessionsApi.md +15 -13
  14. data/docs/Employee.md +36 -12
  15. data/docs/EmployeeResult.md +2 -2
  16. data/docs/EmployeesApi.md +13 -11
  17. data/docs/EmployeesPaginated.md +2 -2
  18. data/docs/Employment.md +34 -0
  19. data/docs/EmploymentResult.md +20 -0
  20. data/docs/EmploymentsApi.md +175 -0
  21. data/docs/EmploymentsPaginated.md +22 -0
  22. data/docs/Location.md +38 -0
  23. data/docs/LocationResult.md +20 -0
  24. data/docs/LocationsApi.md +175 -0
  25. data/docs/LocationsPaginated.md +22 -0
  26. data/gem-config.yml +4 -4
  27. data/lib/stackone_hris_client/api/accounts_api.rb +65 -4
  28. data/lib/stackone_hris_client/api/companies_api.rb +188 -0
  29. data/lib/stackone_hris_client/api/connect_sessions_api.rb +5 -5
  30. data/lib/stackone_hris_client/api/employees_api.rb +4 -4
  31. data/lib/stackone_hris_client/api/employments_api.rb +188 -0
  32. data/lib/stackone_hris_client/api/locations_api.rb +188 -0
  33. data/lib/stackone_hris_client/api_client.rb +5 -5
  34. data/lib/stackone_hris_client/api_error.rb +4 -4
  35. data/lib/stackone_hris_client/configuration.rb +4 -4
  36. data/lib/stackone_hris_client/models/account.rb +9 -7
  37. data/lib/stackone_hris_client/models/companies_paginated.rb +249 -0
  38. data/lib/stackone_hris_client/models/company.rb +237 -0
  39. data/lib/stackone_hris_client/models/company_result.rb +233 -0
  40. data/lib/stackone_hris_client/models/connect_session.rb +9 -7
  41. data/lib/stackone_hris_client/models/connect_session_authenticate.rb +9 -7
  42. data/lib/stackone_hris_client/models/connect_session_create.rb +9 -7
  43. data/lib/stackone_hris_client/models/connect_session_token.rb +9 -7
  44. data/lib/stackone_hris_client/models/employee.rb +145 -60
  45. data/lib/stackone_hris_client/models/employee_result.rb +9 -7
  46. data/lib/stackone_hris_client/models/employees_paginated.rb +9 -7
  47. data/lib/stackone_hris_client/models/employment.rb +296 -0
  48. data/lib/stackone_hris_client/models/employment_result.rb +233 -0
  49. data/lib/stackone_hris_client/models/employments_paginated.rb +249 -0
  50. data/lib/stackone_hris_client/models/location.rb +314 -0
  51. data/lib/stackone_hris_client/models/location_result.rb +233 -0
  52. data/lib/stackone_hris_client/models/locations_paginated.rb +249 -0
  53. data/lib/stackone_hris_client/version.rb +5 -5
  54. data/lib/stackone_hris_client.rb +16 -4
  55. data/spec/api/companies_api_spec.rb +70 -0
  56. data/spec/api/employments_api_spec.rb +70 -0
  57. data/spec/api/locations_api_spec.rb +70 -0
  58. data/spec/api_client_spec.rb +32 -32
  59. data/spec/configuration_spec.rb +6 -6
  60. data/spec/models/companies_paginated_spec.rb +46 -0
  61. data/spec/models/company_result_spec.rb +40 -0
  62. data/spec/models/company_spec.rb +46 -0
  63. data/spec/models/employment_result_spec.rb +40 -0
  64. data/spec/models/employment_spec.rb +82 -0
  65. data/spec/models/employments_paginated_spec.rb +46 -0
  66. data/spec/models/location_result_spec.rb +40 -0
  67. data/spec/models/location_spec.rb +94 -0
  68. data/spec/models/locations_paginated_spec.rb +46 -0
  69. data/spec/spec_helper.rb +3 -3
  70. data/stackone_hris_client.gemspec +5 -5
  71. metadata +51 -3
@@ -0,0 +1,249 @@
1
+ =begin
2
+ #StackOne Unified API - HRIS
3
+
4
+ #The documentation for the StackOne Unified API - HRIS
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module StackOneHRIS
17
+ class EmploymentsPaginated
18
+ attr_accessor :next_page
19
+
20
+ attr_accessor :data
21
+
22
+ attr_accessor :raw
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'next_page' => :'next_page',
28
+ :'data' => :'data',
29
+ :'raw' => :'raw'
30
+ }
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'next_page' => :'String',
42
+ :'data' => :'Array<Employment>',
43
+ :'raw' => :'String'
44
+ }
45
+ end
46
+
47
+ # List of attributes with nullable: true
48
+ def self.openapi_nullable
49
+ Set.new([
50
+ ])
51
+ end
52
+
53
+ # Initializes the object
54
+ # @param [Hash] attributes Model attributes in the form of hash
55
+ def initialize(attributes = {})
56
+ if (!attributes.is_a?(Hash))
57
+ fail ArgumentError, "The input argument (attributes) must be a hash in `StackOneHRIS::EmploymentsPaginated` initialize method"
58
+ end
59
+
60
+ # check to see if the attribute exists and convert string to symbol for hash key
61
+ attributes = attributes.each_with_object({}) { |(k, v), h|
62
+ if (!self.class.attribute_map.key?(k.to_sym))
63
+ fail ArgumentError, "`#{k}` is not a valid attribute in `StackOneHRIS::EmploymentsPaginated`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
64
+ end
65
+ h[k.to_sym] = v
66
+ }
67
+
68
+ if attributes.key?(:'next_page')
69
+ self.next_page = attributes[:'next_page']
70
+ end
71
+
72
+ if attributes.key?(:'data')
73
+ if (value = attributes[:'data']).is_a?(Array)
74
+ self.data = value
75
+ end
76
+ end
77
+
78
+ if attributes.key?(:'raw')
79
+ self.raw = attributes[:'raw']
80
+ end
81
+ end
82
+
83
+ # Show invalid properties with the reasons. Usually used together with valid?
84
+ # @return Array for valid properties with the reasons
85
+ def list_invalid_properties
86
+ invalid_properties = Array.new
87
+ if @next_page.nil?
88
+ invalid_properties.push('invalid value for "next_page", next_page cannot be nil.')
89
+ end
90
+
91
+ if @data.nil?
92
+ invalid_properties.push('invalid value for "data", data cannot be nil.')
93
+ end
94
+
95
+ invalid_properties
96
+ end
97
+
98
+ # Check to see if the all the properties in the model are valid
99
+ # @return true if the model is valid
100
+ def valid?
101
+ return false if @next_page.nil?
102
+ return false if @data.nil?
103
+ true
104
+ end
105
+
106
+ # Checks equality by comparing each attribute.
107
+ # @param [Object] Object to be compared
108
+ def ==(o)
109
+ return true if self.equal?(o)
110
+ self.class == o.class &&
111
+ next_page == o.next_page &&
112
+ data == o.data &&
113
+ raw == o.raw
114
+ end
115
+
116
+ # @see the `==` method
117
+ # @param [Object] Object to be compared
118
+ def eql?(o)
119
+ self == o
120
+ end
121
+
122
+ # Calculates hash code according to all attributes.
123
+ # @return [Integer] Hash code
124
+ def hash
125
+ [next_page, data, raw].hash
126
+ end
127
+
128
+ # Builds the object from hash
129
+ # @param [Hash] attributes Model attributes in the form of hash
130
+ # @return [Object] Returns the model itself
131
+ def self.build_from_hash(attributes)
132
+ new.build_from_hash(attributes)
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ self.class.openapi_types.each_pair do |key, type|
142
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
143
+ self.send("#{key}=", nil)
144
+ elsif type =~ /\AArray<(.*)>/i
145
+ # check to ensure the input is an array given that the attribute
146
+ # is documented as an array but the input is not
147
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
148
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
149
+ end
150
+ elsif !attributes[self.class.attribute_map[key]].nil?
151
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
152
+ end
153
+ end
154
+
155
+ self
156
+ end
157
+
158
+ # Deserializes the data based on type
159
+ # @param string type Data type
160
+ # @param string value Value to be deserialized
161
+ # @return [Object] Deserialized data
162
+ def _deserialize(type, value)
163
+ case type.to_sym
164
+ when :Time
165
+ Time.parse(value)
166
+ when :Date
167
+ Date.parse(value)
168
+ when :String
169
+ value.to_s
170
+ when :Integer
171
+ value.to_i
172
+ when :Float
173
+ value.to_f
174
+ when :Boolean
175
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
176
+ true
177
+ else
178
+ false
179
+ end
180
+ when :Object
181
+ # generic object (usually a Hash), return directly
182
+ value
183
+ when /\AArray<(?<inner_type>.+)>\z/
184
+ inner_type = Regexp.last_match[:inner_type]
185
+ value.map { |v| _deserialize(inner_type, v) }
186
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
187
+ k_type = Regexp.last_match[:k_type]
188
+ v_type = Regexp.last_match[:v_type]
189
+ {}.tap do |hash|
190
+ value.each do |k, v|
191
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
192
+ end
193
+ end
194
+ else # model
195
+ # models (e.g. Pet) or oneOf
196
+ klass = StackOneHRIS.const_get(type)
197
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
198
+ end
199
+ end
200
+
201
+ # Returns the string representation of the object
202
+ # @return [String] String presentation of the object
203
+ def to_s
204
+ to_hash.to_s
205
+ end
206
+
207
+ # to_body is an alias to to_hash (backward compatibility)
208
+ # @return [Hash] Returns the object in the form of hash
209
+ def to_body
210
+ to_hash
211
+ end
212
+
213
+ # Returns the object in the form of hash
214
+ # @return [Hash] Returns the object in the form of hash
215
+ def to_hash
216
+ hash = {}
217
+ self.class.attribute_map.each_pair do |attr, param|
218
+ value = self.send(attr)
219
+ if value.nil?
220
+ is_nullable = self.class.openapi_nullable.include?(attr)
221
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
222
+ end
223
+
224
+ hash[param] = _to_hash(value)
225
+ end
226
+ hash
227
+ end
228
+
229
+ # Outputs non-array value in the form of hash
230
+ # For object, use to_hash. Otherwise, just return the value
231
+ # @param [Object] value Any valid value
232
+ # @return [Hash] Returns the value in the form of hash
233
+ def _to_hash(value)
234
+ if value.is_a?(Array)
235
+ value.compact.map { |v| _to_hash(v) }
236
+ elsif value.is_a?(Hash)
237
+ {}.tap do |hash|
238
+ value.each { |k, v| hash[k] = _to_hash(v) }
239
+ end
240
+ elsif value.respond_to? :to_hash
241
+ value.to_hash
242
+ else
243
+ value
244
+ end
245
+ end
246
+
247
+ end
248
+
249
+ end
@@ -0,0 +1,314 @@
1
+ =begin
2
+ #StackOne Unified API - HRIS
3
+
4
+ #The documentation for the StackOne Unified API - HRIS
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module StackOneHRIS
17
+ class Location
18
+ attr_accessor :id
19
+
20
+ attr_accessor :employee_id
21
+
22
+ attr_accessor :name
23
+
24
+ attr_accessor :phone_number
25
+
26
+ attr_accessor :street_1
27
+
28
+ attr_accessor :street_2
29
+
30
+ attr_accessor :city
31
+
32
+ attr_accessor :state
33
+
34
+ attr_accessor :zip_code
35
+
36
+ attr_accessor :country
37
+
38
+ attr_accessor :location_type
39
+
40
+ # Attribute mapping from ruby-style variable name to JSON key.
41
+ def self.attribute_map
42
+ {
43
+ :'id' => :'id',
44
+ :'employee_id' => :'employee_id',
45
+ :'name' => :'name',
46
+ :'phone_number' => :'phone_number',
47
+ :'street_1' => :'street_1',
48
+ :'street_2' => :'street_2',
49
+ :'city' => :'city',
50
+ :'state' => :'state',
51
+ :'zip_code' => :'zip_code',
52
+ :'country' => :'country',
53
+ :'location_type' => :'location_type'
54
+ }
55
+ end
56
+
57
+ # Returns all the JSON keys this model knows about
58
+ def self.acceptable_attributes
59
+ attribute_map.values
60
+ end
61
+
62
+ # Attribute type mapping.
63
+ def self.openapi_types
64
+ {
65
+ :'id' => :'String',
66
+ :'employee_id' => :'String',
67
+ :'name' => :'String',
68
+ :'phone_number' => :'String',
69
+ :'street_1' => :'String',
70
+ :'street_2' => :'String',
71
+ :'city' => :'String',
72
+ :'state' => :'String',
73
+ :'zip_code' => :'String',
74
+ :'country' => :'String',
75
+ :'location_type' => :'String'
76
+ }
77
+ end
78
+
79
+ # List of attributes with nullable: true
80
+ def self.openapi_nullable
81
+ Set.new([
82
+ ])
83
+ end
84
+
85
+ # Initializes the object
86
+ # @param [Hash] attributes Model attributes in the form of hash
87
+ def initialize(attributes = {})
88
+ if (!attributes.is_a?(Hash))
89
+ fail ArgumentError, "The input argument (attributes) must be a hash in `StackOneHRIS::Location` initialize method"
90
+ end
91
+
92
+ # check to see if the attribute exists and convert string to symbol for hash key
93
+ attributes = attributes.each_with_object({}) { |(k, v), h|
94
+ if (!self.class.attribute_map.key?(k.to_sym))
95
+ fail ArgumentError, "`#{k}` is not a valid attribute in `StackOneHRIS::Location`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
96
+ end
97
+ h[k.to_sym] = v
98
+ }
99
+
100
+ if attributes.key?(:'id')
101
+ self.id = attributes[:'id']
102
+ end
103
+
104
+ if attributes.key?(:'employee_id')
105
+ self.employee_id = attributes[:'employee_id']
106
+ end
107
+
108
+ if attributes.key?(:'name')
109
+ self.name = attributes[:'name']
110
+ end
111
+
112
+ if attributes.key?(:'phone_number')
113
+ self.phone_number = attributes[:'phone_number']
114
+ end
115
+
116
+ if attributes.key?(:'street_1')
117
+ self.street_1 = attributes[:'street_1']
118
+ end
119
+
120
+ if attributes.key?(:'street_2')
121
+ self.street_2 = attributes[:'street_2']
122
+ end
123
+
124
+ if attributes.key?(:'city')
125
+ self.city = attributes[:'city']
126
+ end
127
+
128
+ if attributes.key?(:'state')
129
+ self.state = attributes[:'state']
130
+ end
131
+
132
+ if attributes.key?(:'zip_code')
133
+ self.zip_code = attributes[:'zip_code']
134
+ end
135
+
136
+ if attributes.key?(:'country')
137
+ self.country = attributes[:'country']
138
+ end
139
+
140
+ if attributes.key?(:'location_type')
141
+ self.location_type = attributes[:'location_type']
142
+ end
143
+ end
144
+
145
+ # Show invalid properties with the reasons. Usually used together with valid?
146
+ # @return Array for valid properties with the reasons
147
+ def list_invalid_properties
148
+ invalid_properties = Array.new
149
+ if @employee_id.nil?
150
+ invalid_properties.push('invalid value for "employee_id", employee_id cannot be nil.')
151
+ end
152
+
153
+ invalid_properties
154
+ end
155
+
156
+ # Check to see if the all the properties in the model are valid
157
+ # @return true if the model is valid
158
+ def valid?
159
+ return false if @employee_id.nil?
160
+ true
161
+ end
162
+
163
+ # Checks equality by comparing each attribute.
164
+ # @param [Object] Object to be compared
165
+ def ==(o)
166
+ return true if self.equal?(o)
167
+ self.class == o.class &&
168
+ id == o.id &&
169
+ employee_id == o.employee_id &&
170
+ name == o.name &&
171
+ phone_number == o.phone_number &&
172
+ street_1 == o.street_1 &&
173
+ street_2 == o.street_2 &&
174
+ city == o.city &&
175
+ state == o.state &&
176
+ zip_code == o.zip_code &&
177
+ country == o.country &&
178
+ location_type == o.location_type
179
+ end
180
+
181
+ # @see the `==` method
182
+ # @param [Object] Object to be compared
183
+ def eql?(o)
184
+ self == o
185
+ end
186
+
187
+ # Calculates hash code according to all attributes.
188
+ # @return [Integer] Hash code
189
+ def hash
190
+ [id, employee_id, name, phone_number, street_1, street_2, city, state, zip_code, country, location_type].hash
191
+ end
192
+
193
+ # Builds the object from hash
194
+ # @param [Hash] attributes Model attributes in the form of hash
195
+ # @return [Object] Returns the model itself
196
+ def self.build_from_hash(attributes)
197
+ new.build_from_hash(attributes)
198
+ end
199
+
200
+ # Builds the object from hash
201
+ # @param [Hash] attributes Model attributes in the form of hash
202
+ # @return [Object] Returns the model itself
203
+ def build_from_hash(attributes)
204
+ return nil unless attributes.is_a?(Hash)
205
+ attributes = attributes.transform_keys(&:to_sym)
206
+ self.class.openapi_types.each_pair do |key, type|
207
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
208
+ self.send("#{key}=", nil)
209
+ elsif type =~ /\AArray<(.*)>/i
210
+ # check to ensure the input is an array given that the attribute
211
+ # is documented as an array but the input is not
212
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
213
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
214
+ end
215
+ elsif !attributes[self.class.attribute_map[key]].nil?
216
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
217
+ end
218
+ end
219
+
220
+ self
221
+ end
222
+
223
+ # Deserializes the data based on type
224
+ # @param string type Data type
225
+ # @param string value Value to be deserialized
226
+ # @return [Object] Deserialized data
227
+ def _deserialize(type, value)
228
+ case type.to_sym
229
+ when :Time
230
+ Time.parse(value)
231
+ when :Date
232
+ Date.parse(value)
233
+ when :String
234
+ value.to_s
235
+ when :Integer
236
+ value.to_i
237
+ when :Float
238
+ value.to_f
239
+ when :Boolean
240
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
241
+ true
242
+ else
243
+ false
244
+ end
245
+ when :Object
246
+ # generic object (usually a Hash), return directly
247
+ value
248
+ when /\AArray<(?<inner_type>.+)>\z/
249
+ inner_type = Regexp.last_match[:inner_type]
250
+ value.map { |v| _deserialize(inner_type, v) }
251
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
252
+ k_type = Regexp.last_match[:k_type]
253
+ v_type = Regexp.last_match[:v_type]
254
+ {}.tap do |hash|
255
+ value.each do |k, v|
256
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
257
+ end
258
+ end
259
+ else # model
260
+ # models (e.g. Pet) or oneOf
261
+ klass = StackOneHRIS.const_get(type)
262
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
263
+ end
264
+ end
265
+
266
+ # Returns the string representation of the object
267
+ # @return [String] String presentation of the object
268
+ def to_s
269
+ to_hash.to_s
270
+ end
271
+
272
+ # to_body is an alias to to_hash (backward compatibility)
273
+ # @return [Hash] Returns the object in the form of hash
274
+ def to_body
275
+ to_hash
276
+ end
277
+
278
+ # Returns the object in the form of hash
279
+ # @return [Hash] Returns the object in the form of hash
280
+ def to_hash
281
+ hash = {}
282
+ self.class.attribute_map.each_pair do |attr, param|
283
+ value = self.send(attr)
284
+ if value.nil?
285
+ is_nullable = self.class.openapi_nullable.include?(attr)
286
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
287
+ end
288
+
289
+ hash[param] = _to_hash(value)
290
+ end
291
+ hash
292
+ end
293
+
294
+ # Outputs non-array value in the form of hash
295
+ # For object, use to_hash. Otherwise, just return the value
296
+ # @param [Object] value Any valid value
297
+ # @return [Hash] Returns the value in the form of hash
298
+ def _to_hash(value)
299
+ if value.is_a?(Array)
300
+ value.compact.map { |v| _to_hash(v) }
301
+ elsif value.is_a?(Hash)
302
+ {}.tap do |hash|
303
+ value.each { |k, v| hash[k] = _to_hash(v) }
304
+ end
305
+ elsif value.respond_to? :to_hash
306
+ value.to_hash
307
+ else
308
+ value
309
+ end
310
+ end
311
+
312
+ end
313
+
314
+ end