cityworks 0.0.15 → 0.0.20

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/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,139 @@
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
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
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
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
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
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 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 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 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
+ * Add Department
104
+ *
105
+ * @category Departments
106
+ * @param {string} departmentCode - The SubTypeId
107
+ * @param {string} dpartmentName - The SubTypeId
108
+ * @param {Object} options - Other SubType options.
109
+ * @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
110
+ */
111
+ addDepartment(departmentCode: string, dpartmentName: string, options?: Object): Promise<unknown>;
112
+ /**
113
+ * Get Departments
114
+ *
115
+ * @category Departments
116
+ * @return {Object} Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
117
+ */
118
+ getDepartments(): Promise<unknown>;
119
+ /**
120
+ * Get all Fees
121
+ *
122
+ * @category Fees
123
+ * @return {Object} Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
124
+ */
125
+ getFees(): Promise<unknown>;
126
+ /**
127
+ * Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
128
+ *
129
+ * @param {Object} filters - The parameter(s) to search by (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId).
130
+ * @return {Object} Returns Promise that represents an Array of FeeSetupIDs
131
+ */
132
+ searchFees(filters: {
133
+ AccountCode?: string;
134
+ FeeCode?: string;
135
+ FeeDesc?: string;
136
+ FeeSetupId?: number;
137
+ FeeTypeId?: number;
138
+ }): Promise<unknown>;
139
+ }
@@ -17,15 +17,75 @@ export declare class CaseFinancial {
17
17
  * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
18
18
  */
19
19
  addFee(caObjectId: number, feeSetupId: number, options?: Object): Promise<unknown>;
20
+ /**
21
+ * Add Case Fee Payment. Adds a payment to the case fee specified by caObjectId.
22
+ *
23
+ * @category Case Payments
24
+ * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
25
+ * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
26
+ * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
27
+ */
28
+ addPayment(caObjectId: number, options: Object): Promise<unknown>;
29
+ /**
30
+ * Add Case Payment Refund. Refunds a payment on the case payment specified by caPaymentId.
31
+ *
32
+ * @category Case Payment Refunds
33
+ * @param {number} caPaymentId - The Case Payment ID for the case payment which to refund
34
+ * @param {number} refundAmount - The amount to refund
35
+ * @param {string} comment - A comment to append to the refund
36
+ * @return {Object} Returns Promise that represents an object describing the newly-added payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
37
+ */
38
+ addRefund(caPaymentId: number, refundAmount: number, comment: string): Promise<unknown>;
39
+ /**
40
+ * Add Case Deposit Payment. Adds a payment to the case deposit specified by CaDepositId.
41
+ *
42
+ * @category Case Payments
43
+ * @param {number} caDepositId - The Case Deposit ID for the case deposit to which to add the fee
44
+ * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
45
+ * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
46
+ */
47
+ addDepositPayment(caDepositId: number, options: Object): Promise<unknown>;
48
+ /**
49
+ * Adds a deposit to the case specified by the CaObectId.
50
+ *
51
+ * @category Case Deposits
52
+ * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
53
+ * @param {number} depositId - The deposit setup id for the deposit to add to the case.
54
+ * @param {number} [amount] - The amount of the deposit (optional)
55
+ * @param {string} [comment] - Comment text to add to the deposit (optional)
56
+ * @return {Object} Returns Promise that represents an object describing the newly-added deposit. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
57
+ */
58
+ addDeposit(caObjectId: number, depositId: number, amount?: number, comment?: string): Promise<unknown>;
59
+ /**
60
+ * Adds an instrument to the case specified by the CaObectId.
61
+ *
62
+ * @category Case Instruments
63
+ * @param {number} caObjectId - The Case Object ID for the case to which to add the instrument
64
+ * @param {number} instTypeId - The instrument type id for the instrument being added to the case.
65
+ * @param {number} amount - The amount of the instrument
66
+ * @param {Date} dateExpire - The datetime for the instrument to expire.
67
+ * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument for more options.
68
+ * @return {Object} Returns Promise that represents an object describing the newly-added instrument. See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument
69
+ */
70
+ addInstrument(caObjectId: number, instTypeId: number, amount: number, dateExpire: Date, options?: Object): Promise<unknown>;
20
71
  /**
21
72
  * Updates a fee specified by the CaFeeId.
22
73
  *
23
74
  * @category Case Fees
24
75
  * @param {number} caFeeId - The Fee ID for the specific instance of the fee you wish to update
25
76
  * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)
26
- * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
77
+ * @return {Object} Returns Promise that represents an object describing the updated fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
27
78
  */
28
79
  updateFee(caFeeId: number, options?: Object): Promise<unknown>;
80
+ /**
81
+ * Void a refund.
82
+ *
83
+ * @category Case Refund Payment
84
+ * @param {number} caPaymentRefundId - The Refund ID for the specific refund to void
85
+ * @param {String} voided - A string. No clue.
86
+ * @return {Object} Returns Promise that represents an object describing the voided refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
87
+ */
88
+ voidRefund(caPaymentRefundId: number, voided: string): Promise<unknown>;
29
89
  /**
30
90
  * Adds Default Case Fees. Adds fees to the case specified by the CaObectId and BusCaseId.
31
91
  *
@@ -35,20 +95,53 @@ export declare class CaseFinancial {
35
95
  * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
36
96
  */
37
97
  addDefaultFees(caObjectId: number, busCaseId: number): Promise<unknown>;
98
+ /**
99
+ * Adds Default Case Deposits. Adds deposits to the case specified by the CaObectId and BusCaseId.
100
+ *
101
+ * @category Case Deposits
102
+ * @param {number} caObjectId - The Case Object ID for the case to which to add the default deposits
103
+ * @param {number} busCaseId - The business case ID whose default deposits should be added to the case
104
+ * @return {Object} Returns Promise that represents a collection of Deposit Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
105
+ */
106
+ addDefaultDeposits(caObjectId: number, busCaseId: number): Promise<unknown>;
38
107
  /**
39
108
  * Gets the fees from the case specified by the CaObectId.
40
109
  *
41
110
  * @category Case Fees
42
- * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
43
- * @return {Object} Returns Promise that represents an collection of Case Fees.
111
+ * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
112
+ * @return {Object} Returns Promise that represents a collection of Case Fees.
44
113
  */
45
114
  getFees(caObjectId: number): Promise<unknown>;
115
+ /**
116
+ * Get Case Deposit by Case ObjectId.
117
+ *
118
+ * @category Case Deposits
119
+ * @param {number} caObjectId - The Case Object ID for the case to which to get the deposits
120
+ * @return {Object} Returns Promise that represents a collection of Case Deposits.
121
+ */
122
+ getDeposits(caObjectId: number): Promise<unknown>;
123
+ /**
124
+ * Get Case Payments by Case ObjectId
125
+ *
126
+ * @category Case Payments
127
+ * @param {number} caObjectId - The Case Object ID for the case to which to get the payments
128
+ * @return {Object} Returns Promise that represents a collection of Case Payments.
129
+ */
130
+ getPayments(caObjectId: number): Promise<unknown>;
131
+ /**
132
+ * Gets the instruments from the case specified by the CaObectId.
133
+ *
134
+ * @category Case Instruments
135
+ * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
136
+ * @return {Object} Returns Promise that represents a collection of Case Instruments.
137
+ */
138
+ getInstruments(caObjectId: number): Promise<unknown>;
46
139
  /**
47
140
  * Delete the fee specified by the caFeeId.
48
141
  *
49
142
  * @category Case Fees
50
143
  * @param {number} caFeeId - The Case Fee ID which should be deleted
51
- * @return {Object} Returns Promise that represents a collection of Case Fees.
144
+ * @return {Object} Returns Promise that represents a Case Fee object.
52
145
  */
53
146
  deleteFee(caFeeId: number): Promise<unknown>;
54
147
  /**
@@ -60,16 +153,93 @@ export declare class CaseFinancial {
60
153
  */
61
154
  deleteFeesByCaseId(caObjectId: number): Promise<unknown>;
62
155
  /**
63
- * Search for Case Fees. Include one or more of the listed search fields. A logical 'and' operation is applied for multiple search fields.
156
+ * Delete a Case Payment by Id. Delete a specific case payment by CaPaymentId.
157
+ *
158
+ * @category Case Payments
159
+ * @param {number} caPaymentId - The Case Payment ID which should be deleted
160
+ * @return {Object} Returns Promise that represents a Case Payment object.
161
+ */
162
+ deletePayment(caFeeId: number): Promise<unknown>;
163
+ /**
164
+ * Delete Case Payment Refund. Removes a refund on a payment.
165
+ *
166
+ * @category Case Payment Refunds
167
+ * @param {number} caPaymentRefundId - The Case Payment ID for the case payment which to refund
168
+ * @return {Object} Returns Promise that represents an object describing the deleted payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
169
+ */
170
+ deleteRefund(caPaymentRefundId: number): Promise<unknown>;
171
+ /**
172
+ * Delete Case Payments by Case ObjectId. Delete from the system all payments associated to a specific case as specified by the case id (CaObjectId)
173
+ *
174
+ * @category Case Payments
175
+ * @param {number} caObjectId - The Case Object ID whose payments should be deleted
176
+ * @return {Object} Returns Promise that represents a number (?)
177
+ */
178
+ deletePaymentsByCaseId(caObjectId: number): Promise<unknown>;
179
+ /**
180
+ * Delete the fee specified by the caFeeId.
181
+ *
182
+ * @category Case Deposits
183
+ * @param {number} caDepositId - The Case Deposit ID which should be deleted
184
+ * @return {Object} Returns Promise that represents a collection of Case Deposits.
185
+ */
186
+ deleteDeposit(caDepositId: number): Promise<unknown>;
187
+ /**
188
+ * Delete Case Fees by Case ObjectId. Delete from the system all Fees linked to a specific Case as specified by the Case Id parameter (CaObjectId).
189
+ *
190
+ * @category Case Deposits
191
+ * @param {number} caObjectId - The Case Object ID whose fees should be deleted
192
+ * @return {Object} Returns Promise that represents a number (?)
193
+ */
194
+ deleteDepositsByCaseId(caObjectId: number): Promise<unknown>;
195
+ /**
196
+ * Delete the instrument specified by the caInstrumentId.
197
+ *
198
+ * @category Case Instruments
199
+ * @param {number} caInstrumentId - The Case Instrument ID which should be deleted
200
+ * @return {Object} Returns Promise that represents a Case Instrument.
201
+ */
202
+ deleteInstrument(caInstrumentId: number): Promise<unknown>;
203
+ /**
204
+ * Delete Case Instruments by Case ObjectId. Delete from the system all Instruments linked to a specific Case as specified by the Case Id parameter (CaObjectId).
205
+ *
206
+ * @category Case Instruments
207
+ * @param {number} caObjectId - The Case Object ID whose instruments should be deleted
208
+ * @return {Object} Returns Promise that represents a number (?)
209
+ */
210
+ deleteInstrumentsByCaseId(caObjectId: number): Promise<unknown>;
211
+ /**
212
+ * Search for Case Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
64
213
  *
65
214
  * @category Case Fees
66
- * @param {number} [caFeeId] - The Case Fee ID which should be deleted
67
- * @param {number} [caObjectId] - The Case Fee ID which should be deleted
68
- * @param {string} [feeCode] - The Case Fee ID which should be deleted
69
- * @param {string} [feeDesc] - The Case Fee ID which should be deleted
215
+ * @param {Object} filters - The parameter(s) to search by
216
+ * @return {Object} Returns Promise that represents an Array of case fee IDs
217
+ */
218
+ searchFees(filters: Object): Promise<unknown>;
219
+ /**
220
+ * Search for Case Payments. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
221
+ *
222
+ * @category Case Payments
223
+ * @param {Object} filters - The filters to search for matched Case Payments
224
+ * @return {Object} Returns Promise that represents an Array of case payment IDs
225
+ */
226
+ searchPayments(filters: Object): Promise<unknown>;
227
+ /**
228
+ * Search for Case Payment Refunds. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
229
+ *
230
+ * @category Case Payment Refunds
231
+ * @param {Object} filters - The filters to search for matched Case Payments.
232
+ * @return {Object} Returns Promise that represents an Array of case payment refund IDs
233
+ */
234
+ searchRefunds(filters: Object): Promise<unknown>;
235
+ /**
236
+ * Search for Case Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
237
+ *
238
+ * @category Case Deposits
239
+ * @param {Object} filters - The parameters to search by.
70
240
  * @return {Object} Returns Promise that represents an Array of case fee IDs
71
241
  */
72
- searchFees(caFeeId?: number, caObjectId?: number, feeCode?: string, feeDesc?: string): Promise<unknown>;
242
+ searchDeposits(filters: Object): Promise<unknown>;
73
243
  /**
74
244
  * Get All Fee Templates
75
245
  *
@@ -78,15 +248,101 @@ export declare class CaseFinancial {
78
248
  */
79
249
  getAllFeeTemplates(): Promise<unknown>;
80
250
  /**
81
- * Search for Fees. Include one or more of the listed search fields. A logical 'and' operation is applied for multiple search fields.
251
+ * Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
82
252
  *
83
253
  * @category Case Fees
84
- * @param {number} [feeSetupId] - The Case Fee ID to search for
85
- * @param {number} [feeTypeId] - The Case Fee Type ID to search for
86
- * @param {string} [feeCode] - The fee code to search for
87
- * @param {string} [feeDesc] - The fee description to search for
88
- * @param {string} [accountCode] - The account code to search for
254
+ * @param {Object} filters - The parameters to search by
89
255
  * @return {Object} Returns Promise that represents an Array of case fee IDs
90
256
  */
91
- searchFeeTemplates(feeSetupId?: number, feeTypeId?: number, feeCode?: string, feeDesc?: string, accountCode?: string): Promise<unknown>;
257
+ searchFeeTemplates(filters: Object): Promise<unknown>;
258
+ /**
259
+ * Search for Case Instruments. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
260
+ *
261
+ * @category Case Instruments
262
+ * @param {Object} filters - The parameters to search by (AddressLine1, Amount, CaInstrumentId, CityName, CommentText, Company, ContactEmail, ContactName, ContactPhone, CountryCode, InstTypeId, SerialNumber, StateCode, ZipCode)
263
+ * @return {Object} Returns Promise that represents an Array of case instrument IDs
264
+ */
265
+ searchCaseInstruments(filters: Object): Promise<unknown>;
266
+ /**
267
+ * Get the Defined Instruments
268
+ *
269
+ * @category Instruments
270
+ * @param {Object} options - the options to filter the instruments returned by
271
+ * @return {Object} Returns Promise that represents an Array of CaInstrumentItem
272
+ */
273
+ getInstrumentList(options: Object): Promise<unknown>;
274
+ /**
275
+ * Adds a release to a case instrument specified by the caInstrumentId. Must provide either amountReleased OR percentReleased
276
+ *
277
+ * @category Case Instrument Releases
278
+ * @param {number} caInstrumentId - The Case Instrument ID to which to add the instrument release
279
+ * @param {number} releasedBy - UserID to attach to the release.
280
+ * @param {Date} dateReleased - The date of the release
281
+ * @param {number} [amountReleased] - The amount to be released
282
+ * @param {number} [percentReleased] - OR the percent to be released
283
+ * @param {string} [comment] - Comment to attach to the release
284
+ * @return {Object} Returns Promise that represents an object describing the newly-added instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
285
+ */
286
+ addCaseInstrumentRelease(caInstrumentId: number, releasedBy: number, dateReleased: Date, amountReleased?: number, percentReleased?: number, comment?: string): Promise<unknown>;
287
+ /**
288
+ * Deletes a release specified by the caInstReleasesId.
289
+ *
290
+ * @category Case Instrument Releases
291
+ * @param {number} caInstReleasesId - The Case Instrument Release ID to delete
292
+ * @return {Object} Returns Promise that represents an object describing the deleted instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
293
+ */
294
+ deleteCaseInstrumentRelease(caInstReleasesId: number): Promise<unknown>;
295
+ /**
296
+ * Search for Case Instrument Releases. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
297
+ *
298
+ * @category Case Instrument Releases
299
+ * @param {Object} filters - Specify at least one of the following: AmountReleased, CaInstReleasesId, CaInstrumentId, CommentText, PercentReleased, ReleasedBy
300
+ * @return {Object} Returns Promise that represents an Array of Case Instruments resulting from the search
301
+ */
302
+ searchCaseInstrumentReleases(filters: Object): Promise<unknown>;
303
+ /**
304
+ * Get All Fees
305
+ *
306
+ * @category Fees
307
+ * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
308
+ */
309
+ fees(): Promise<unknown>;
310
+ /**
311
+ * Search for Fees. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
312
+ *
313
+ * @category Fees
314
+ * @param {Object} filters - Specify at least one.
315
+ * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
316
+ */
317
+ searchAvailableFees(filters: {
318
+ AccountCode?: string;
319
+ FeeCode?: string;
320
+ FeeDesc?: string;
321
+ FeeSetupId?: number;
322
+ FeeTypeId?: number;
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>;
92
348
  }