-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodel_employment_history_no_non_null_request.go
293 lines (248 loc) · 18 KB
/
model_employment_history_no_non_null_request.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
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
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
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
* Affix API
*
* The affixapi.com API documentation. # Introduction Affix API is an OAuth 2.1 application that allows developers to access customer data, without developers needing to manage or maintain integrations; or collect login credentials or API keys from users for these third party systems. # OAuth 2.1 Affix API follows the [OAuth 2.1 spec](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-08). As an OAuth application, Affix API handles not only both the collection of sensitive user credentials or API keys, but also builds and maintains the integrations with the providers, so you don't have to. # How to obtain an access token in order to get started, you must: - register a `client_id` - direct your user to the sign in flow (`https://connect.affixapi.com` [with the appropriate query parameters](https://github.com/affixapi/starter-kit/tree/master/connect)) - capture `authorization_code` we will send to your redirect URI after the sign in flow is complete and exchange that `authorization_code` for a Bearer token # Sandbox keys (xhr mode) ### dev ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzODIzNTNlMi05N2ZiLTRmMWEtOTYxYy0zZDI5OTViNzYxMTUiLCJpYXQiOjE3MTE4MTA3MTQsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUuZGV2LmVuZ2luZWVyaW5nLmFmZml4YXBpLmNvbSIsInN1YiI6InhociIsImF1ZCI6IjNGREFFREY5LTFEQ0E0RjU0LTg3OTQ5RjZBLTQxMDI3NjQzIn0.zUJPaT6IxcIdr8b9iO6u-Rr5I-ohTHPYTrQGrgOFghbEbovItiwr9Wk479GnJVJc3WR8bxAwUMAE4Ul6Okdk6Q' \\ 'https://dev.api.affixapi.com/2023-03-01/xhr/employees' ``` ### prod ``` eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg ``` #### `employees` endpoint sample: ``` curl --fail \\ -X GET \\ -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6Ims5RmxwSFR1YklmZWNsUU5QRVZzeFcxazFZZ0Zfbk1BWllOSGVuOFQxdGciLCJ0eXAiOiJKV1MifQ.eyJwcm92aWRlciI6InNhbmRib3giLCJzY29wZXMiOlsiLzIwMjMtMDMtMDEveGhyL2NvbXBhbnkiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWUiLCIvMjAyMy0wMy0wMS94aHIvZW1wbG95ZWVzIiwiLzIwMjMtMDMtMDEveGhyL2dyb3VwcyIsIi8yMDIzLTAzLTAxL3hoci9pZGVudGl0eSIsIi8yMDIzLTAzLTAxL3hoci9wYXlydW5zIiwiLzIwMjMtMDMtMDEveGhyL3BheXJ1bnMvOnBheXJ1bl9pZCIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1iYWxhbmNlcyIsIi8yMDIzLTAzLTAxL3hoci90aW1lLW9mZi1lbnRyaWVzIiwiLzIwMjMtMDMtMDEveGhyL3RpbWVzaGVldHMiLCIvMjAyMy0wMy0wMS94aHIvd29yay1sb2NhdGlvbnMiXSwidG9rZW4iOiIzYjg4MDc2NC1kMGFmLTQ5ZDAtOGM5OS00YzIwYjE2MTJjOTMiLCJpYXQiOjE3MTE4MTA4NTgsImlzcyI6InB1YmxpY2FwaS1pbnRlcm1lZGlhdGUucHJvZC5lbmdpbmVlcmluZy5hZmZpeGFwaS5jb20iLCJzdWIiOiJ4aHIiLCJhdWQiOiIwOEJCMDgxRS1EOUFCNEQxNC04REY5OTIzMy02NjYxNUNFOSJ9.n3pJmmfegU21Tko_TyUyCHi4ITvfd75T8NFFTHmf1r8AI8yCUYTWdfNjyZZWcZD6z50I3Wsk2rAd8GDWXn4vlg' \\ 'https://api.affixapi.com/2023-03-01/xhr/employees' ``` # Compression We support `brotli`, `gzip`, and `deflate` compression algorithms. To enable, pass the `Accept-Encoding` header with one or all of the values: `br`, `gzip`, `deflate`, or `identity` (no compression) In the response, you will receive the `Content-Encoding` response header indicating the compression algorithm used in the data payload to enable you to decompress the result. If the `Accept-Encoding: identity` header was passed, no `Content-Encoding` response header is sent back, as no compression algorithm was used. # Webhooks An exciting feature for HR/Payroll modes are webhooks. If enabled, your `webhook_uri` is set on your `client_id` for the respective environment: `dev | prod` Webhooks are configured to make live requests to the underlying integration 1x/hr, and if a difference is detected since the last request, we will send a request to your `webhook_uri` with this shape: ``` { added: <api.v20230301.Employees>[ <api.v20230301.Employee>{ ..., date_of_birth: '2010-08-06', display_full_name: 'Daija Rogahn', employee_number: '57993', employment_status: 'pending', employment_type: 'other', employments: [ { currency: 'eur', effective_date: '2022-02-25', employment_type: 'other', job_title: 'Dynamic Implementation Manager', pay_frequency: 'semimonthly', pay_period: 'YEAR', pay_rate: 96000, }, ], first_name: 'Daija', ... } ], removed: [], updated: [ <api.v20230301.Employee>{ ..., date_of_birth: '2009-11-09', display_full_name: 'Lourdes Stiedemann', employee_number: '63189', employment_status: 'leave', employment_type: 'full_time', employments: [ { currency: 'gbp', effective_date: '2023-01-16', employment_type: 'full_time', job_title: 'Forward Brand Planner', pay_frequency: 'semimonthly', pay_period: 'YEAR', pay_rate: 86000, }, ], first_name: 'Lourdes', } ] } ``` the following headers will be sent with webhook requests: ``` x-affix-api-signature: ab8474e609db95d5df3adc39ea3add7a7544bd215c5c520a30a650ae93a2fba7 x-affix-api-origin: webhooks-employees-webhook user-agent: affixapi.com ``` Before trusting the payload, you should sign the payload and verify the signature matches the signature sent by the `affixapi.com` service. This secures that the data sent to your `webhook_uri` is from the `affixapi.com` server. The signature is created by combining the signing secret (your `client_secret`) with the body of the request sent using a standard HMAC-SHA256 keyed hash. The signature can be created via: - create an `HMAC` with your `client_secret` - update the `HMAC` with the payload - get the hex digest -> this is the signature Sample `typescript` code that follows this recipe: ``` import { createHmac } from 'crypto'; export const computeSignature = ({ str, signingSecret, }: { signingSecret: string; str: string; }): string => { const hmac = createHmac('sha256', signingSecret); hmac.update(str); const signature = hmac.digest('hex'); return signature; }; ``` While verifying the Affix API signature header should be your primary method of confirming validity, you can also whitelist our outbound webhook static IP addresses. ``` dev: - 52.210.169.82 - 52.210.38.77 - 3.248.135.204 prod: - 52.51.160.102 - 54.220.83.244 - 3.254.213.171 ``` ## Rate limits Open endpoints (not gated by an API key) (applied at endpoint level): - 15 requests every 1 minute (by IP address) - 25 requests every 5 minutes (by IP address) Gated endpoints (require an API key) (applied at endpoint level): - 40 requests every 1 minute (by IP address) - 40 requests every 5 minutes (by `client_id`) Things to keep in mind: - Open endpoints (not gated by an API key) will likely be called by your users, not you, so rate limits generally would not apply to you. - As a developer, rate limits are applied at the endpoint granularity. - For example, say the rate limits below are 10 requests per minute by ip. from that same ip, within 1 minute, you get: - 10 requests per minute on `/orders`, - another 10 requests per minute on `/items`, - and another 10 requests per minute on `/identity`, - for a total of 30 requests per minute.
*
* API version: 2023-03-01
* Contact: [email protected]
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
)
// EmploymentHistoryNoNonNullRequest struct for EmploymentHistoryNoNonNullRequest
type EmploymentHistoryNoNonNullRequest struct {
JobTitle string `json:"job_title"`
EffectiveDate string `json:"effective_date"`
GroupId NullableString `json:"group_id"`
GroupRemoteId NullableString `json:"group_remote_id"`
GroupName NullableString `json:"group_name"`
ManagerId NullableString `json:"manager_id"`
ManagerRemoteId NullableString `json:"manager_remote_id"`
}
// NewEmploymentHistoryNoNonNullRequest instantiates a new EmploymentHistoryNoNonNullRequest object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewEmploymentHistoryNoNonNullRequest(jobTitle string, effectiveDate string, groupId NullableString, groupRemoteId NullableString, groupName NullableString, managerId NullableString, managerRemoteId NullableString) *EmploymentHistoryNoNonNullRequest {
this := EmploymentHistoryNoNonNullRequest{}
this.JobTitle = jobTitle
this.EffectiveDate = effectiveDate
this.GroupId = groupId
this.GroupRemoteId = groupRemoteId
this.GroupName = groupName
this.ManagerId = managerId
this.ManagerRemoteId = managerRemoteId
return &this
}
// NewEmploymentHistoryNoNonNullRequestWithDefaults instantiates a new EmploymentHistoryNoNonNullRequest object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewEmploymentHistoryNoNonNullRequestWithDefaults() *EmploymentHistoryNoNonNullRequest {
this := EmploymentHistoryNoNonNullRequest{}
return &this
}
// GetJobTitle returns the JobTitle field value
func (o *EmploymentHistoryNoNonNullRequest) GetJobTitle() string {
if o == nil {
var ret string
return ret
}
return o.JobTitle
}
// GetJobTitleOk returns a tuple with the JobTitle field value
// and a boolean to check if the value has been set.
func (o *EmploymentHistoryNoNonNullRequest) GetJobTitleOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.JobTitle, true
}
// SetJobTitle sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetJobTitle(v string) {
o.JobTitle = v
}
// GetEffectiveDate returns the EffectiveDate field value
func (o *EmploymentHistoryNoNonNullRequest) GetEffectiveDate() string {
if o == nil {
var ret string
return ret
}
return o.EffectiveDate
}
// GetEffectiveDateOk returns a tuple with the EffectiveDate field value
// and a boolean to check if the value has been set.
func (o *EmploymentHistoryNoNonNullRequest) GetEffectiveDateOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.EffectiveDate, true
}
// SetEffectiveDate sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetEffectiveDate(v string) {
o.EffectiveDate = v
}
// GetGroupId returns the GroupId field value
// If the value is explicit nil, the zero value for string will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupId() string {
if o == nil || o.GroupId.Get() == nil {
var ret string
return ret
}
return *o.GroupId.Get()
}
// GetGroupIdOk returns a tuple with the GroupId field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return o.GroupId.Get(), o.GroupId.IsSet()
}
// SetGroupId sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetGroupId(v string) {
o.GroupId.Set(&v)
}
// GetGroupRemoteId returns the GroupRemoteId field value
// If the value is explicit nil, the zero value for string will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupRemoteId() string {
if o == nil || o.GroupRemoteId.Get() == nil {
var ret string
return ret
}
return *o.GroupRemoteId.Get()
}
// GetGroupRemoteIdOk returns a tuple with the GroupRemoteId field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupRemoteIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return o.GroupRemoteId.Get(), o.GroupRemoteId.IsSet()
}
// SetGroupRemoteId sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetGroupRemoteId(v string) {
o.GroupRemoteId.Set(&v)
}
// GetGroupName returns the GroupName field value
// If the value is explicit nil, the zero value for string will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupName() string {
if o == nil || o.GroupName.Get() == nil {
var ret string
return ret
}
return *o.GroupName.Get()
}
// GetGroupNameOk returns a tuple with the GroupName field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetGroupNameOk() (*string, bool) {
if o == nil {
return nil, false
}
return o.GroupName.Get(), o.GroupName.IsSet()
}
// SetGroupName sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetGroupName(v string) {
o.GroupName.Set(&v)
}
// GetManagerId returns the ManagerId field value
// If the value is explicit nil, the zero value for string will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetManagerId() string {
if o == nil || o.ManagerId.Get() == nil {
var ret string
return ret
}
return *o.ManagerId.Get()
}
// GetManagerIdOk returns a tuple with the ManagerId field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetManagerIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return o.ManagerId.Get(), o.ManagerId.IsSet()
}
// SetManagerId sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetManagerId(v string) {
o.ManagerId.Set(&v)
}
// GetManagerRemoteId returns the ManagerRemoteId field value
// If the value is explicit nil, the zero value for string will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetManagerRemoteId() string {
if o == nil || o.ManagerRemoteId.Get() == nil {
var ret string
return ret
}
return *o.ManagerRemoteId.Get()
}
// GetManagerRemoteIdOk returns a tuple with the ManagerRemoteId field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *EmploymentHistoryNoNonNullRequest) GetManagerRemoteIdOk() (*string, bool) {
if o == nil {
return nil, false
}
return o.ManagerRemoteId.Get(), o.ManagerRemoteId.IsSet()
}
// SetManagerRemoteId sets field value
func (o *EmploymentHistoryNoNonNullRequest) SetManagerRemoteId(v string) {
o.ManagerRemoteId.Set(&v)
}
func (o EmploymentHistoryNoNonNullRequest) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if true {
toSerialize["job_title"] = o.JobTitle
}
if true {
toSerialize["effective_date"] = o.EffectiveDate
}
if true {
toSerialize["group_id"] = o.GroupId.Get()
}
if true {
toSerialize["group_remote_id"] = o.GroupRemoteId.Get()
}
if true {
toSerialize["group_name"] = o.GroupName.Get()
}
if true {
toSerialize["manager_id"] = o.ManagerId.Get()
}
if true {
toSerialize["manager_remote_id"] = o.ManagerRemoteId.Get()
}
return json.Marshal(toSerialize)
}
type NullableEmploymentHistoryNoNonNullRequest struct {
value *EmploymentHistoryNoNonNullRequest
isSet bool
}
func (v NullableEmploymentHistoryNoNonNullRequest) Get() *EmploymentHistoryNoNonNullRequest {
return v.value
}
func (v *NullableEmploymentHistoryNoNonNullRequest) Set(val *EmploymentHistoryNoNonNullRequest) {
v.value = val
v.isSet = true
}
func (v NullableEmploymentHistoryNoNonNullRequest) IsSet() bool {
return v.isSet
}
func (v *NullableEmploymentHistoryNoNonNullRequest) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableEmploymentHistoryNoNonNullRequest(val *EmploymentHistoryNoNonNullRequest) *NullableEmploymentHistoryNoNonNullRequest {
return &NullableEmploymentHistoryNoNonNullRequest{value: val, isSet: true}
}
func (v NullableEmploymentHistoryNoNonNullRequest) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableEmploymentHistoryNoNonNullRequest) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}