cityworks 0.0.18 → 0.0.22
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/README.md +73 -0
- package/dist/case.d.ts +84 -0
- package/dist/case_admin.d.ts +371 -0
- package/dist/case_financial.d.ts +24 -0
- package/dist/case_workflow.d.ts +154 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.m.js +1 -1
- package/dist/index.m.js.map +1 -1
- package/dist/index.modern.js +1 -1
- package/dist/index.modern.js.map +1 -1
- package/dist/index.umd.js +1 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/inspection.d.ts +13 -5
- package/dist/inspection_admin.d.ts +10 -0
- package/dist/request.d.ts +11 -3
- package/dist/request_admin.d.ts +10 -0
- package/dist/workorder.d.ts +4 -0
- package/dist/workorder_admin.d.ts +10 -0
- package/package.json +1 -1
- package/src/case.ts +195 -0
- package/src/case_admin.ts +883 -0
- package/src/case_financial.ts +58 -0
- package/src/case_workflow.ts +377 -0
- package/src/inspection.ts +21 -20
- package/src/inspection_admin.ts +17 -0
- package/src/request.ts +13 -3
- package/src/request_admin.ts +17 -0
- package/src/workorder.ts +10 -0
- package/src/workorder_admin.ts +17 -0
package/README.md
CHANGED
|
@@ -26,3 +26,76 @@ Get the currently valid token in order to store it in a session or cookie:
|
|
|
26
26
|
Provide a saved token instead of the standard u/p auth:
|
|
27
27
|
|
|
28
28
|
cityworks.setToken('mytoken');
|
|
29
|
+
|
|
30
|
+
Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [{Service} Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Case.html) object libraries like so:
|
|
31
|
+
|
|
32
|
+
cityworks.inspection.methodHere().then(resp => {
|
|
33
|
+
|
|
34
|
+
})
|
|
35
|
+
cityworks.workorder.methodHere().then(resp => {
|
|
36
|
+
|
|
37
|
+
})
|
|
38
|
+
cityworks.request.methodHere().then(resp => {
|
|
39
|
+
|
|
40
|
+
})
|
|
41
|
+
cityworks.case.methodHere().then(resp => {
|
|
42
|
+
|
|
43
|
+
})
|
|
44
|
+
|
|
45
|
+
Some of the methods are general or top-level, and so, are accessed separately are at the same level of reference from the cityworks object:
|
|
46
|
+
|
|
47
|
+
[General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
|
|
48
|
+
|
|
49
|
+
cityworks.general.methodHere().then(resp => {
|
|
50
|
+
|
|
51
|
+
})
|
|
52
|
+
|
|
53
|
+
[Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
|
|
54
|
+
|
|
55
|
+
cityworks.message_queue.methodHere().then(resp => {
|
|
56
|
+
|
|
57
|
+
})
|
|
58
|
+
|
|
59
|
+
[Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
|
|
60
|
+
|
|
61
|
+
cityworks.activity_link.methodHere().then(resp => {
|
|
62
|
+
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
[Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
|
|
66
|
+
|
|
67
|
+
cityworks.gis.methodHere().then(resp => {
|
|
68
|
+
|
|
69
|
+
})
|
|
70
|
+
|
|
71
|
+
[General search methods](https://walker.github.io/cityworks/classes/search.Search.html):
|
|
72
|
+
|
|
73
|
+
cityworks.search.methodHere().then(resp => {
|
|
74
|
+
|
|
75
|
+
})
|
|
76
|
+
|
|
77
|
+
For the sake of organizing some of the other methods needed by the primary and secondary libraries, there are also objects and methods accessed within those main libraries:
|
|
78
|
+
|
|
79
|
+
For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
|
|
80
|
+
|
|
81
|
+
cityworks.case.financial.methodHere().then(resp => {
|
|
82
|
+
|
|
83
|
+
})
|
|
84
|
+
|
|
85
|
+
For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
|
|
86
|
+
|
|
87
|
+
cityworks.case.data.methodHere().then(resp => {
|
|
88
|
+
|
|
89
|
+
})
|
|
90
|
+
|
|
91
|
+
For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
|
|
92
|
+
|
|
93
|
+
cityworks.case.workflow.methodHere().then(resp => {
|
|
94
|
+
|
|
95
|
+
})
|
|
96
|
+
|
|
97
|
+
For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
|
|
98
|
+
|
|
99
|
+
cityworks.case.admin.methodHere().then(resp => {
|
|
100
|
+
|
|
101
|
+
})
|
package/dist/case.d.ts
CHANGED
|
@@ -15,8 +15,92 @@ export declare class Case {
|
|
|
15
15
|
* Payment, Receipt, & Fee methods
|
|
16
16
|
*/
|
|
17
17
|
financial?: Object;
|
|
18
|
+
/**
|
|
19
|
+
* PLL Administration methods
|
|
20
|
+
*/
|
|
21
|
+
admin?: Object;
|
|
18
22
|
/**
|
|
19
23
|
* @hidden
|
|
20
24
|
*/
|
|
21
25
|
constructor(cw: any);
|
|
26
|
+
/**
|
|
27
|
+
* Create new case
|
|
28
|
+
*
|
|
29
|
+
* @category Cases
|
|
30
|
+
* @param {number} caseTypeId - The case Type ID
|
|
31
|
+
* @param {number} subTypeId - The case subType ID
|
|
32
|
+
* @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
|
|
33
|
+
* @return {Object} Returns Promise that represents an object describing the newly-created case
|
|
34
|
+
*/
|
|
35
|
+
create(caseTypeId: number, subTypeId: number, options?: Object): Promise<unknown>;
|
|
36
|
+
/**
|
|
37
|
+
* Create a child case
|
|
38
|
+
*
|
|
39
|
+
* @category Cases
|
|
40
|
+
* @param {number} busCaseId - The case Type ID
|
|
41
|
+
* @param {number} parentCaObjectId - The case subType ID
|
|
42
|
+
* @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
|
|
43
|
+
* @return {Object} Returns Promise that represents an object describing the newly-created case
|
|
44
|
+
*/
|
|
45
|
+
createChild(busCaseId: number, parentCaObjectId: number, options?: Object): Promise<unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* Create a case from a Service Request
|
|
48
|
+
*
|
|
49
|
+
* @category Cases
|
|
50
|
+
* @param {number} caseTypeId - The case Type ID
|
|
51
|
+
* @param {number} subTypeId - The case subType ID
|
|
52
|
+
* @param {number} requestId - The service request ID
|
|
53
|
+
* @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
|
|
54
|
+
* @return {Object} Returns Promise that represents an object describing the newly-created case
|
|
55
|
+
*/
|
|
56
|
+
createFromRequest(caseTypeId: number, subTypeId: number, requestId: number, options?: Object): Promise<unknown>;
|
|
57
|
+
/**
|
|
58
|
+
* Update a case
|
|
59
|
+
*
|
|
60
|
+
* @category Cases
|
|
61
|
+
* @param {number} caObjectId - The case Object ID to update
|
|
62
|
+
* @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
|
|
63
|
+
* @return {Object} Returns Promise that represents an object describing the updated case
|
|
64
|
+
*/
|
|
65
|
+
update(caObjectId: number, options?: Object): Promise<unknown>;
|
|
66
|
+
/**
|
|
67
|
+
* Get cases by IDs
|
|
68
|
+
*
|
|
69
|
+
* @category Cases
|
|
70
|
+
* @param {Array<number>} caObjectIds - The case Object ID to update
|
|
71
|
+
* @return {Object} Returns Promise that represents a collection of objects describing the cases
|
|
72
|
+
*/
|
|
73
|
+
getByIds(caObjectIds: Array<number>): Promise<unknown>;
|
|
74
|
+
/**
|
|
75
|
+
* Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
|
|
76
|
+
*
|
|
77
|
+
* @category Cases
|
|
78
|
+
* @param {Object} filters - The parameter(s) to search by
|
|
79
|
+
* @return {Object} Returns Promise that represents an Array of case Object IDs
|
|
80
|
+
*/
|
|
81
|
+
search(filters: Object): Promise<unknown>;
|
|
82
|
+
/**
|
|
83
|
+
* Move a Case point
|
|
84
|
+
*
|
|
85
|
+
* @category Cases
|
|
86
|
+
* @param {string} caObjectId
|
|
87
|
+
* @param {number} x
|
|
88
|
+
* @param {number} y
|
|
89
|
+
* @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
|
|
90
|
+
* @param {number} [z] - Optional Z coordinate
|
|
91
|
+
* @return {Object} Returns Promise that represents an object describing the updated GISPoint
|
|
92
|
+
*/
|
|
93
|
+
move(caObjectId: number, x: number, y: number, projection: {
|
|
94
|
+
WKID?: string;
|
|
95
|
+
WKT?: string;
|
|
96
|
+
VcsWKID?: string;
|
|
97
|
+
}, z?: number): Promise<unknown>;
|
|
98
|
+
/**
|
|
99
|
+
* Delete case
|
|
100
|
+
*
|
|
101
|
+
* @category Cases
|
|
102
|
+
* @param {number} caObjectId - The case Object ID
|
|
103
|
+
* @return {Object} Returns Promise that represents an object describing the deleted case
|
|
104
|
+
*/
|
|
105
|
+
delete(caObjectId: number): Promise<unknown>;
|
|
22
106
|
}
|
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
export declare class CaseAdmin {
|
|
2
|
+
/**
|
|
3
|
+
* @hidden
|
|
4
|
+
*/
|
|
5
|
+
cw: any;
|
|
6
|
+
/**
|
|
7
|
+
* @hidden
|
|
8
|
+
*/
|
|
9
|
+
constructor(cw: any);
|
|
10
|
+
/**
|
|
11
|
+
* Add Business Case Template
|
|
12
|
+
*
|
|
13
|
+
* @category Case Templates
|
|
14
|
+
* @param {Object} data - The Business Case Template options.
|
|
15
|
+
* @return {Object} Returns Promise that represents an object describing the created case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
|
|
16
|
+
*/
|
|
17
|
+
addBusinessCaseTemplate(data: Object): Promise<unknown>;
|
|
18
|
+
/**
|
|
19
|
+
* Update Business Case Template
|
|
20
|
+
*
|
|
21
|
+
* @category Case Templates
|
|
22
|
+
* @param {number} busCaseId - The Business Case ID to update
|
|
23
|
+
* @param {Object} data - The Business Case Template options.
|
|
24
|
+
* @return {Object} Returns Promise that represents an object describing the updated case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
|
|
25
|
+
*/
|
|
26
|
+
updateBusinessCaseTemplate(busCaseId: number, options: Object): Promise<unknown>;
|
|
27
|
+
/**
|
|
28
|
+
* Get Business Case Templates
|
|
29
|
+
*
|
|
30
|
+
* @category Case Templates
|
|
31
|
+
* @return {Object} Returns Promise that represents a collection of Business Case Templates
|
|
32
|
+
*/
|
|
33
|
+
getBusinessCaseTemplates(): Promise<unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* Add Case Type
|
|
36
|
+
*
|
|
37
|
+
* @category Types & SubTypes
|
|
38
|
+
* @param {string} caseTypeName - The case type name
|
|
39
|
+
* @param {string} caseTypeDesciption - The case type description
|
|
40
|
+
* @param {Object} options - The other options for the Case Type
|
|
41
|
+
* @return {Object} Returns Promise that represents an object describing the added case type
|
|
42
|
+
*/
|
|
43
|
+
addCaseType(caseTypeName: string, caseTypeDesciption: string, options: Object): Promise<unknown>;
|
|
44
|
+
/**
|
|
45
|
+
* Update Case Type
|
|
46
|
+
*
|
|
47
|
+
* @category Types & SubTypes
|
|
48
|
+
* @param {number} caseTypeId - The case Type ID
|
|
49
|
+
* @param {Object} options - The other options for the Case Type
|
|
50
|
+
* @return {Object} Returns Promise that represents an object describing the updated case type
|
|
51
|
+
*/
|
|
52
|
+
updateCaseType(caseTypeId: number, options?: Object): Promise<unknown>;
|
|
53
|
+
/**
|
|
54
|
+
* Get Case Types
|
|
55
|
+
*
|
|
56
|
+
* @category Types & SubTypes
|
|
57
|
+
* @return {Object} Returns Promise that represents a collection of CaseTypeItems
|
|
58
|
+
*/
|
|
59
|
+
getCaseTypes(): Promise<unknown>;
|
|
60
|
+
/**
|
|
61
|
+
* Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
|
|
62
|
+
*
|
|
63
|
+
* @category Types & SubTypes
|
|
64
|
+
* @param {Object} filters - The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
|
|
65
|
+
* @return {Object} Returns Promise that represents an Array of CaseTypeIDs
|
|
66
|
+
*/
|
|
67
|
+
searchCaseTypeIDs(filters: Object): Promise<unknown>;
|
|
68
|
+
/**
|
|
69
|
+
* Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
|
|
70
|
+
*
|
|
71
|
+
* @category Types & SubTypes
|
|
72
|
+
* @param {Object} filters - The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
|
|
73
|
+
* @return {Object} Returns Promise that represents a collection of CaseTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CaseTypeItem
|
|
74
|
+
*/
|
|
75
|
+
searchCaseTypeObjects(filters: Object): Promise<unknown>;
|
|
76
|
+
/**
|
|
77
|
+
* Add SubType
|
|
78
|
+
*
|
|
79
|
+
* @category Types & SubTypes
|
|
80
|
+
* @param {string} subTypeName - The SubTypeId
|
|
81
|
+
* @param {string} subTypeDescription - The SubTypeId
|
|
82
|
+
* @param {Object} options - Other SubType options.
|
|
83
|
+
* @return {Object} Returns Promise that represents an object describing the added SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
|
|
84
|
+
*/
|
|
85
|
+
addSubtype(subTypeName: string, subTypeDescription: string, options?: Object): Promise<unknown>;
|
|
86
|
+
/**
|
|
87
|
+
* Update SubType
|
|
88
|
+
*
|
|
89
|
+
* @category Types & SubTypes
|
|
90
|
+
* @param {number} subTypeId - The SubTypeId
|
|
91
|
+
* @param {Object} options - The case Object ID
|
|
92
|
+
* @return {Object} Returns Promise that represents an object describing the updated SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
|
|
93
|
+
*/
|
|
94
|
+
updateSubtype(subTypeId: number, options?: Object): Promise<unknown>;
|
|
95
|
+
/**
|
|
96
|
+
* Get SubTypes
|
|
97
|
+
*
|
|
98
|
+
* @category Types & SubTypes
|
|
99
|
+
* @return {Object} Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
|
|
100
|
+
*/
|
|
101
|
+
getSubtypes(): Promise<unknown>;
|
|
102
|
+
/**
|
|
103
|
+
* Get all Fees
|
|
104
|
+
*
|
|
105
|
+
* @category Fees
|
|
106
|
+
* @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
|
|
107
|
+
*/
|
|
108
|
+
getFees(): Promise<unknown>;
|
|
109
|
+
/**
|
|
110
|
+
* Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
|
|
111
|
+
*
|
|
112
|
+
* @param {Object} filters - The parameter(s) to search by (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId).
|
|
113
|
+
* @return {Object} Returns Promise that represents an Array of FeeSetupIDs
|
|
114
|
+
*/
|
|
115
|
+
searchFees(filters: {
|
|
116
|
+
AccountCode?: string;
|
|
117
|
+
FeeCode?: string;
|
|
118
|
+
FeeDesc?: string;
|
|
119
|
+
FeeSetupId?: number;
|
|
120
|
+
FeeTypeId?: number;
|
|
121
|
+
}): Promise<unknown>;
|
|
122
|
+
/**
|
|
123
|
+
* Get all Expirations
|
|
124
|
+
*
|
|
125
|
+
* @category Expirations
|
|
126
|
+
* @return {Object} Returns Promise that represents a collection of ExpirationTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem
|
|
127
|
+
*/
|
|
128
|
+
getExpirations(): Promise<unknown>;
|
|
129
|
+
/**
|
|
130
|
+
* Add an Expiration type
|
|
131
|
+
*
|
|
132
|
+
* @category Expirations
|
|
133
|
+
* @param {Object} options - Must specify OrgId and ExpirationDescType attributes. See: /{subdirectory}/apidocs/#/service-info/Pll/ExpirationType
|
|
134
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added ExpirationTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem
|
|
135
|
+
*/
|
|
136
|
+
addExpiration(options?: Object): Promise<unknown>;
|
|
137
|
+
/**
|
|
138
|
+
* Get all Deposits
|
|
139
|
+
*
|
|
140
|
+
* @category Deposits
|
|
141
|
+
* @return {Object} Returns Promise that represents a collection of DepositItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepositItemBase
|
|
142
|
+
*/
|
|
143
|
+
getDeposits(): Promise<unknown>;
|
|
144
|
+
/**
|
|
145
|
+
* Search Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
|
|
146
|
+
*
|
|
147
|
+
* @param {Object} filters - The parameter(s) to search by (AccountCode, DepositCode, DepositDesc, DepositId, DepositTypeId).
|
|
148
|
+
* @return {Object} Returns Promise that represents an Array of FeeSetupIDs
|
|
149
|
+
*/
|
|
150
|
+
searchDeposits(filters: {
|
|
151
|
+
AccountCode?: string;
|
|
152
|
+
DepositCode?: string;
|
|
153
|
+
DepositDesc?: string;
|
|
154
|
+
DepositId?: number;
|
|
155
|
+
DepositTypeId?: number;
|
|
156
|
+
}): Promise<unknown>;
|
|
157
|
+
/**
|
|
158
|
+
* Get all Disciplines
|
|
159
|
+
*
|
|
160
|
+
* @category Disciplines
|
|
161
|
+
* @return {Object} Returns Promise that represents a collection of DisciplineItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DisciplineItem
|
|
162
|
+
*/
|
|
163
|
+
getDisciplines(): Promise<unknown>;
|
|
164
|
+
/**
|
|
165
|
+
* Add Department
|
|
166
|
+
*
|
|
167
|
+
* @category Departments & Divisions
|
|
168
|
+
* @param {string} departmentCode - The SubTypeId
|
|
169
|
+
* @param {string} departmentName - The SubTypeId
|
|
170
|
+
* @param {Object} options - Other SubType options.
|
|
171
|
+
* @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
|
|
172
|
+
*/
|
|
173
|
+
addDepartment(departmentCode: string, departmentName: string, options?: Object): Promise<unknown>;
|
|
174
|
+
/**
|
|
175
|
+
* Get Departments
|
|
176
|
+
*
|
|
177
|
+
* @category Departments & Divisions
|
|
178
|
+
* @return {Object} Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
|
|
179
|
+
*/
|
|
180
|
+
getDepartments(): Promise<unknown>;
|
|
181
|
+
/**
|
|
182
|
+
* Add Division
|
|
183
|
+
*
|
|
184
|
+
* @category Departments & Divisions
|
|
185
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added DivisionItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem
|
|
186
|
+
*/
|
|
187
|
+
addDivision(departmentId: number, divisionName: string, options?: Object): Promise<unknown>;
|
|
188
|
+
/**
|
|
189
|
+
* Get all Divisions
|
|
190
|
+
*
|
|
191
|
+
* @category Departments & Divisions
|
|
192
|
+
* @return {Object} Returns Promise that represents a collection of DivisionItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem
|
|
193
|
+
*/
|
|
194
|
+
getDivisions(): Promise<unknown>;
|
|
195
|
+
/**
|
|
196
|
+
* Add Holiday
|
|
197
|
+
*
|
|
198
|
+
* @category Holidays
|
|
199
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added DivisionItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=HolidaysItem
|
|
200
|
+
*/
|
|
201
|
+
addHoliday(holidayDate: Date, holidayDesc: string, halfDayFlag?: string): Promise<unknown>;
|
|
202
|
+
/**
|
|
203
|
+
* Delete Holiday
|
|
204
|
+
*
|
|
205
|
+
* @category Holidays
|
|
206
|
+
* @param {number} holidayId - ID of Holiday to delete
|
|
207
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added HolidaysItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=HolidaysItem
|
|
208
|
+
*/
|
|
209
|
+
deleteHoliday(holidayId: number): Promise<unknown>;
|
|
210
|
+
/**
|
|
211
|
+
* Get all Holidays
|
|
212
|
+
*
|
|
213
|
+
* @category Holidays
|
|
214
|
+
* @return {Object} Returns Promise that represents a collection of HolidaysItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=HolidaysItem
|
|
215
|
+
*/
|
|
216
|
+
getHolidays(): Promise<unknown>;
|
|
217
|
+
/**
|
|
218
|
+
* Add Inspection Time Block
|
|
219
|
+
*
|
|
220
|
+
* @category Inspections
|
|
221
|
+
* @param {string} labelText - Label for the time block
|
|
222
|
+
* @param {string} startTime - Start time in 24 hour format (HH:mm)
|
|
223
|
+
* @param {string} endTime - End time in 24 hour format (HH:mm)
|
|
224
|
+
* @param {Object} inspTimeBlocksDetails - See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspTimeBlocksDetailItem
|
|
225
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added InspectionTimeBlocksItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem
|
|
226
|
+
*/
|
|
227
|
+
addInspectionTimeBlock(labelText: string, startTime: string, endTime: string, inspTimeBlocksDetails?: Object): Promise<unknown>;
|
|
228
|
+
/**
|
|
229
|
+
* Get all Inspection Time Blocks
|
|
230
|
+
*
|
|
231
|
+
* @category Inspections
|
|
232
|
+
* @return {Object} Returns Promise that represents a collection of InspectionTimeBlocksItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem
|
|
233
|
+
*/
|
|
234
|
+
getInspectionTimeBlocks(): Promise<unknown>;
|
|
235
|
+
/**
|
|
236
|
+
* Get all NotificationCases
|
|
237
|
+
*
|
|
238
|
+
* @category Notifications
|
|
239
|
+
* @return {Object} Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationCaseItem
|
|
240
|
+
*/
|
|
241
|
+
getNotificationCases(): Promise<unknown>;
|
|
242
|
+
/**
|
|
243
|
+
* Get all Notification Types
|
|
244
|
+
*
|
|
245
|
+
* @category Notifications
|
|
246
|
+
* @return {Object} Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationTypeItem
|
|
247
|
+
*/
|
|
248
|
+
getNotificationTypes(): Promise<unknown>;
|
|
249
|
+
/**
|
|
250
|
+
* Add Numbering Group
|
|
251
|
+
*
|
|
252
|
+
* @category NumberingGroups
|
|
253
|
+
* @param {number} options - attributes or update
|
|
254
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
|
|
255
|
+
*/
|
|
256
|
+
addNumberingGroup(options: Object): Promise<unknown>;
|
|
257
|
+
/**
|
|
258
|
+
* Update Numbering Group
|
|
259
|
+
*
|
|
260
|
+
* @category NumberingGroups
|
|
261
|
+
* @param {number} numberingGroupId - ID of NumberGroup to update
|
|
262
|
+
* @param {number} options - updates attributes
|
|
263
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added HolidaysItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
|
|
264
|
+
*/
|
|
265
|
+
updateNumberingGroup(numberingGroupId: number, options?: Object): Promise<unknown>;
|
|
266
|
+
/**
|
|
267
|
+
* Get all Numbering Groups
|
|
268
|
+
*
|
|
269
|
+
* @category NumberingGroups
|
|
270
|
+
* @return {Object} Returns Promise that represents a collection of NumberingGroupItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
|
|
271
|
+
*/
|
|
272
|
+
getNumberingGroups(): Promise<unknown>;
|
|
273
|
+
/**
|
|
274
|
+
* Add Person
|
|
275
|
+
*
|
|
276
|
+
* @category People
|
|
277
|
+
* @param {string} name - Name of person
|
|
278
|
+
* @param {Object} options - attributes for new person
|
|
279
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
|
|
280
|
+
*/
|
|
281
|
+
addPerson(name: string, options: Object): Promise<unknown>;
|
|
282
|
+
/**
|
|
283
|
+
* Get all People
|
|
284
|
+
*
|
|
285
|
+
* @category People
|
|
286
|
+
* @return {Object} Returns Promise that represents a collection of PeopleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleItem
|
|
287
|
+
*/
|
|
288
|
+
getPeople(): Promise<unknown>;
|
|
289
|
+
/**
|
|
290
|
+
* Add People Role
|
|
291
|
+
*
|
|
292
|
+
* @category People
|
|
293
|
+
* @param {string} name - Name of person
|
|
294
|
+
* @param {Object} options - attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/PeopleRole
|
|
295
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added PeopleRoleItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
|
|
296
|
+
*/
|
|
297
|
+
addPeopleRole(roleCode: string, options: Object): Promise<unknown>;
|
|
298
|
+
/**
|
|
299
|
+
* Get all PeopleRoles
|
|
300
|
+
*
|
|
301
|
+
* @category People
|
|
302
|
+
* @return {Object} Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
|
|
303
|
+
*/
|
|
304
|
+
getPeopleRoles(): Promise<unknown>;
|
|
305
|
+
/**
|
|
306
|
+
* Add TaskResultDetail
|
|
307
|
+
*
|
|
308
|
+
* @category TaskResults
|
|
309
|
+
* @param {Object} options - attributes for new TaskResultDetail. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
|
|
310
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
|
|
311
|
+
*/
|
|
312
|
+
addTaskResultDetail(options: Object): Promise<unknown>;
|
|
313
|
+
/**
|
|
314
|
+
* Update TaskResultDetail
|
|
315
|
+
*
|
|
316
|
+
* @category TaskResults
|
|
317
|
+
* @param {string} resultDetailId - Result Detail ID
|
|
318
|
+
* @param {Object} options - attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
|
|
319
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
|
|
320
|
+
*/
|
|
321
|
+
updateTaskResultDetail(resultDetailId: number, options: Object): Promise<unknown>;
|
|
322
|
+
/**
|
|
323
|
+
* Get all TaskResultDetails
|
|
324
|
+
*
|
|
325
|
+
* @category TaskResults
|
|
326
|
+
* @return {Object} Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
|
|
327
|
+
*/
|
|
328
|
+
getTaskResultDetails(): Promise<unknown>;
|
|
329
|
+
/**
|
|
330
|
+
* Add TaskResultFeeInsert
|
|
331
|
+
*
|
|
332
|
+
* @category TaskResults
|
|
333
|
+
* @param {Object} options - attributes for new TaskResultFeeInsert. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultFeeInsert
|
|
334
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added TaskResultFeeInsertItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem
|
|
335
|
+
*/
|
|
336
|
+
addTaskResultFeeInsert(options: Object): Promise<unknown>;
|
|
337
|
+
/**
|
|
338
|
+
* Delete TaskResultFeeInsert
|
|
339
|
+
*
|
|
340
|
+
* @category TaskResults
|
|
341
|
+
* @param {number} taskResultFeeInsertId - ID for TaskResultFeeInsert to be deleted.
|
|
342
|
+
* @return {Object} Returns Promise that represents the ID Number of the deleted TaskResultFeeInsertItem.
|
|
343
|
+
*/
|
|
344
|
+
deleteTaskResultFeeInsert(taskResultFeeInsertId: number): Promise<unknown>;
|
|
345
|
+
/**
|
|
346
|
+
* Delete TaskResultFeeInsert(s) by Task ID
|
|
347
|
+
*
|
|
348
|
+
* @category TaskResults
|
|
349
|
+
* @param {number} taskId - ID for Task parent of TaskResultFeeInsert(s) to be deleted.
|
|
350
|
+
* @return {Object} Returns Promise that represents the ID Number of the Task parent of the deleted TaskResultFeeInsertItem(s).
|
|
351
|
+
*/
|
|
352
|
+
deleteTaskResultFeeInsertByTaskId(taskId: number): Promise<unknown>;
|
|
353
|
+
/**
|
|
354
|
+
* Update TaskResultFeeInsert
|
|
355
|
+
*
|
|
356
|
+
* @category TaskResults
|
|
357
|
+
* @param {number} taskResultFeeInsertId - ID for TaskResultFeeInsert to be updated.
|
|
358
|
+
* @param {number} taskId - Updated TaskID
|
|
359
|
+
* @param {number} taskResultId - Updated TaskResultId
|
|
360
|
+
* @param {number} [feeSetupId] - Fee setup ID update for TaskResultFeeInsert
|
|
361
|
+
* @return {Object} Returns Promise that represents the ID Number of the updated TaskResultFeeInsertItem.
|
|
362
|
+
*/
|
|
363
|
+
updateTaskResultFeeInsert(taskResultFeeInsertId: number, taskId: number, taskResultId: number, feeSetupId?: number): Promise<unknown>;
|
|
364
|
+
/**
|
|
365
|
+
* Get all TaskResultFeeInsert
|
|
366
|
+
*
|
|
367
|
+
* @category TaskResults
|
|
368
|
+
* @return {Object} Returns Promise that represents a collection of TaskResultFeeInsertItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem
|
|
369
|
+
*/
|
|
370
|
+
getTaskResultFeeInsert(): Promise<unknown>;
|
|
371
|
+
}
|
package/dist/case_financial.d.ts
CHANGED
|
@@ -321,4 +321,28 @@ export declare class CaseFinancial {
|
|
|
321
321
|
FeeSetupId?: number;
|
|
322
322
|
FeeTypeId?: number;
|
|
323
323
|
}): Promise<unknown>;
|
|
324
|
+
/**
|
|
325
|
+
* Get all tender types configured
|
|
326
|
+
*
|
|
327
|
+
* @category Tender Types
|
|
328
|
+
* @return {Object} Returns Promise that represents a collection of tender type objects. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
|
|
329
|
+
*/
|
|
330
|
+
getTenderTypes(): Promise<unknown>;
|
|
331
|
+
/**
|
|
332
|
+
* Adds a tender type configuration
|
|
333
|
+
*
|
|
334
|
+
* @category Tender Types
|
|
335
|
+
* @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
|
|
336
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
|
|
337
|
+
*/
|
|
338
|
+
addTenderType(options: Object): Promise<unknown>;
|
|
339
|
+
/**
|
|
340
|
+
* Update a tender type configuration
|
|
341
|
+
*
|
|
342
|
+
* @category Tender Types
|
|
343
|
+
* @param {number} tenderTypeId - ID of the tender type to update
|
|
344
|
+
* @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
|
|
345
|
+
* @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
|
|
346
|
+
*/
|
|
347
|
+
updateTenderType(tenderTypeId: number, options: Object): Promise<unknown>;
|
|
324
348
|
}
|