bamboohr.com 1.3.2 → 1.3.3
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.
- package/dist/interfaces/Employee.d.ts +2 -2
- package/dist/interfaces/Fields.d.ts +18 -18
- package/package.json +8 -8
- package/CHANGELOG.md +0 -87
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Fields } from './Fields';
|
|
2
|
-
|
|
2
|
+
type PartialNull<T> = {
|
|
3
3
|
[P in keyof T]?: T[P] | null;
|
|
4
4
|
};
|
|
5
5
|
interface BaseEmployee {
|
|
@@ -7,7 +7,7 @@ interface BaseEmployee {
|
|
|
7
7
|
id: string;
|
|
8
8
|
lastName: string;
|
|
9
9
|
}
|
|
10
|
-
export
|
|
10
|
+
export type Employee = BaseEmployee & PartialNull<Fields>;
|
|
11
11
|
export interface EmployeeDirectory {
|
|
12
12
|
employees: Employee[];
|
|
13
13
|
fields: {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type Writeable<T> = {
|
|
2
2
|
-readonly [P in keyof T]: T[P];
|
|
3
3
|
};
|
|
4
4
|
/**
|
|
@@ -8,25 +8,25 @@ export declare type Writeable<T> = {
|
|
|
8
8
|
*
|
|
9
9
|
* Example: "2010-03-19"
|
|
10
10
|
*/
|
|
11
|
-
export
|
|
11
|
+
export type DateField = string;
|
|
12
12
|
/**
|
|
13
13
|
* A standard United States Social Security number, with dashes.
|
|
14
14
|
*
|
|
15
15
|
* Example: "123-45-6789"
|
|
16
16
|
*/
|
|
17
|
-
export
|
|
17
|
+
export type SSNField = string;
|
|
18
18
|
/**
|
|
19
19
|
* A plain text string with a phone number, no formatting is enforced.
|
|
20
20
|
*
|
|
21
21
|
* Example: "1-866-387-9595"
|
|
22
22
|
*/
|
|
23
|
-
export
|
|
23
|
+
export type PhoneField = string;
|
|
24
24
|
/**
|
|
25
25
|
* The plain text name of the gender.
|
|
26
26
|
*
|
|
27
27
|
* Example: "Male" or "Female"
|
|
28
28
|
*/
|
|
29
|
-
export
|
|
29
|
+
export type GenderField = string;
|
|
30
30
|
/**
|
|
31
31
|
* A simple quantity value without thousands separators or currency signs using a period as a decimal point.
|
|
32
32
|
* Example: "27000.00"
|
|
@@ -35,7 +35,7 @@ export declare type GenderField = string;
|
|
|
35
35
|
*
|
|
36
36
|
* Example: `“payRate”: { “value”: “27000.00”, “currency”: “EUR”}`
|
|
37
37
|
*/
|
|
38
|
-
export
|
|
38
|
+
export type CurrencyField = string | {
|
|
39
39
|
currency: string;
|
|
40
40
|
value: string;
|
|
41
41
|
};
|
|
@@ -44,43 +44,43 @@ export declare type CurrencyField = string | {
|
|
|
44
44
|
*
|
|
45
45
|
* Example: "yes", "checkbox", "no"
|
|
46
46
|
*/
|
|
47
|
-
export
|
|
47
|
+
export type CheckboxField = 'yes' | 'checkbox' | 'no';
|
|
48
48
|
/**
|
|
49
49
|
* The name of the country. Must exist in the BambooHR country list.
|
|
50
50
|
*
|
|
51
51
|
* Example: "Australia", "United States", etc.
|
|
52
52
|
*/
|
|
53
|
-
export
|
|
53
|
+
export type CountryField = string;
|
|
54
54
|
/**
|
|
55
55
|
* The full name of the state/province.
|
|
56
56
|
*
|
|
57
57
|
* Example: "Florida"
|
|
58
58
|
*/
|
|
59
|
-
export
|
|
59
|
+
export type StateField = string;
|
|
60
60
|
/**
|
|
61
61
|
* Plain text status of marriage.
|
|
62
62
|
*
|
|
63
63
|
* Example: "Single" or "Married"
|
|
64
64
|
*/
|
|
65
|
-
export
|
|
65
|
+
export type MaritalStatusField = string;
|
|
66
66
|
/**
|
|
67
67
|
* The employee's employment status as used to filter employees in BambooHR.
|
|
68
68
|
*
|
|
69
69
|
* Example: "Active" or "Inactive"
|
|
70
70
|
*/
|
|
71
|
-
export
|
|
71
|
+
export type StatusField = 'Active' | 'Inactive';
|
|
72
72
|
/**
|
|
73
73
|
* One of several predefined options for the unit of pay.
|
|
74
74
|
*
|
|
75
75
|
* Example: "Hourly", "Salary", "Commission", "Exception Hourly", "Monthly", "Piece Rate", "Contract" or "Daily"
|
|
76
76
|
*/
|
|
77
|
-
export
|
|
77
|
+
export type PayTypeField = string;
|
|
78
78
|
/**
|
|
79
79
|
* A reference to another employee expressed as preferred name-space-last name.
|
|
80
80
|
*
|
|
81
81
|
* Example: "Robert Smith"
|
|
82
82
|
*/
|
|
83
|
-
export
|
|
83
|
+
export type EmployeeField = string;
|
|
84
84
|
/**
|
|
85
85
|
* The UTC time that an event occurred.
|
|
86
86
|
*
|
|
@@ -88,23 +88,23 @@ export declare type EmployeeField = string;
|
|
|
88
88
|
*
|
|
89
89
|
* Example: "2012-10-17T20:27:17+00:00"
|
|
90
90
|
*/
|
|
91
|
-
export
|
|
91
|
+
export type TimestampField = string;
|
|
92
92
|
/**
|
|
93
93
|
* A larger section of text that can include line feed characters.
|
|
94
94
|
*/
|
|
95
|
-
export
|
|
95
|
+
export type TextareaField = string;
|
|
96
96
|
/**
|
|
97
97
|
* The exact text for an option from a list.
|
|
98
98
|
*
|
|
99
99
|
* Example: "Marketing"
|
|
100
100
|
*/
|
|
101
|
-
export
|
|
101
|
+
export type ListField = string;
|
|
102
102
|
/**
|
|
103
103
|
* An email address.
|
|
104
104
|
*
|
|
105
105
|
* Example: "support@bamboohr.com"
|
|
106
106
|
*/
|
|
107
|
-
export
|
|
107
|
+
export type EmailField = string;
|
|
108
108
|
export interface Fields {
|
|
109
109
|
/** @deprecated please use ‘acaStatusCategory’ */
|
|
110
110
|
acaStatus: string;
|
|
@@ -267,4 +267,4 @@ export interface Fields {
|
|
|
267
267
|
/** The employee's ZIP code. */
|
|
268
268
|
zipcode: string;
|
|
269
269
|
}
|
|
270
|
-
export
|
|
270
|
+
export type WritableFields = Partial<Writeable<Fields>>;
|
package/package.json
CHANGED
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
"author": "Florian Imdahl <git@ffflorian.de>",
|
|
3
3
|
"dependencies": {
|
|
4
4
|
"@hapi/hawk": "8.0.0",
|
|
5
|
-
"axios": "
|
|
5
|
+
"axios": "1.3.3",
|
|
6
6
|
"qs": "6.11.0"
|
|
7
7
|
},
|
|
8
8
|
"description": "An bamboohr.com API client",
|
|
9
9
|
"devDependencies": {
|
|
10
|
-
"@types/hapi__hawk": "8.0.
|
|
11
|
-
"@types/node": "~
|
|
12
|
-
"rimraf": "
|
|
13
|
-
"typedoc": "0.23.
|
|
14
|
-
"typescript": "4.
|
|
10
|
+
"@types/hapi__hawk": "8.0.3",
|
|
11
|
+
"@types/node": "~18",
|
|
12
|
+
"rimraf": "4.1.2",
|
|
13
|
+
"typedoc": "0.23.25",
|
|
14
|
+
"typescript": "4.9.5"
|
|
15
15
|
},
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">= 10.9"
|
|
@@ -35,6 +35,6 @@
|
|
|
35
35
|
"dist": "yarn clean && yarn build:ts",
|
|
36
36
|
"test": "exit 0"
|
|
37
37
|
},
|
|
38
|
-
"version": "1.3.
|
|
39
|
-
"gitHead": "
|
|
38
|
+
"version": "1.3.3",
|
|
39
|
+
"gitHead": "f839983cf7fb43815bf5ce9a0c627e1685c963c2"
|
|
40
40
|
}
|
package/CHANGELOG.md
DELETED
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
# Change Log
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file.
|
|
4
|
-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
-
|
|
6
|
-
## 1.3.2 (2022-07-12)
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
### Bug Fixes
|
|
10
|
-
|
|
11
|
-
* Dependency updates ([6083c2e](https://github.com/ffflorian/api-clients/commit/6083c2e66b4f4f3d47232fcff050565457ee8338))
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
## 1.3.1 (2022-04-08)
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
### Bug Fixes
|
|
21
|
-
|
|
22
|
-
* **npms.io:** Search query doesn't need to be encoded ([#959](https://github.com/ffflorian/api-clients/issues/959)) ([ea737a7](https://github.com/ffflorian/api-clients/commit/ea737a735f1c1bac5e5dd4dc1c02c860af0fb818))
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
# 1.3.0 (2022-03-14)
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
### Features
|
|
32
|
-
|
|
33
|
-
* **absence.io:** Update UserAPI.ts with retrieveUserByOption ([#937](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/issues/937)) ([72b2161](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/commit/72b216144d7d579d77150c6342364a0989ef1b6f))
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
## 1.2.1 (2021-12-22)
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
### Bug Fixes
|
|
43
|
-
|
|
44
|
-
* Upgrade yarn lock file ([91511d0](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/commit/91511d0f17882c1faedf55296ab11d9516a3d425))
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
# 1.2.0 (2021-07-30)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### Features
|
|
54
|
-
|
|
55
|
-
* **bamboohr.com:** Handle errors, add more TimeOff endpoints ([f9fd458](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/commit/f9fd458bf04253e01371e128d9ef06378700329c))
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
## [1.1.2](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/compare/bamboohr.com@1.1.1...bamboohr.com@1.1.2) (2021-05-17)
|
|
62
|
-
|
|
63
|
-
**Note:** Version bump only for package bamboohr.com
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
## [1.1.1](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/compare/bamboohr.com@1.1.0...bamboohr.com@1.1.1) (2021-04-14)
|
|
70
|
-
|
|
71
|
-
**Note:** Version bump only for package bamboohr.com
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
# 1.1.0 (2021-04-01)
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
### Bug Fixes
|
|
81
|
-
|
|
82
|
-
* Build docs ([a570982](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/commit/a570982a1df4b83b2a958c16bfecae7fb3af2ebe))
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
### Features
|
|
86
|
-
|
|
87
|
-
* **bamboohr.com:** Add bamboohr.com API ([#619](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/issues/619)) ([3e593ea](https://github.com/ffflorian/api-clients/tree/main/packages/bamboohr.com/commit/3e593eaf9425cb3435b39e2920d496bf51945f6a))
|