cityworks 1.0.6 → 2.1.0

package/dist/case_financial.d.ts

@@ -1,348 +1,406 @@
-export declare class CaseFinancial {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: Object);
-    /**
-     * Adds a fee to the case specified by the CaObectId.
-     *
-     * @category Case Fees
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
-     * @param {number} feeSetupId - The fee setup id for the fee to add to the case.
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)
-     * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
-     */
-    addFee(caObjectId: number, feeSetupId: number, options?: Object): Promise<unknown>;
-    /**
-     * Add Case Fee Payment. Adds a payment to the case fee specified by caObjectId.
-     *
-     * @category Case Payments
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
-     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
-     * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
-     */
-    addPayment(caObjectId: number, options: Object): Promise<unknown>;
-    /**
-     * Add Case Payment Refund. Refunds a payment on the case payment specified by caPaymentId.
-     *
-     * @category Case Payment Refunds
-     * @param {number} caPaymentId - The Case Payment ID for the case payment which to refund
-     * @param {number} refundAmount - The amount to refund
-     * @param {string} comment - A comment to append to the refund
-     * @return {Object} Returns Promise that represents an object describing the newly-added payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
-     */
-    addRefund(caPaymentId: number, refundAmount: number, comment: string): Promise<unknown>;
-    /**
-     * Add Case Deposit Payment. Adds a payment to the case deposit specified by CaDepositId.
-     *
-     * @category Case Payments
-     * @param {number} caDepositId - The Case Deposit ID for the case deposit to which to add the fee
-     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
-     * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
-     */
-    addDepositPayment(caDepositId: number, options: Object): Promise<unknown>;
-    /**
-     * Adds a deposit to the case specified by the CaObectId.
-     *
-     * @category Case Deposits
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
-     * @param {number} depositId - The deposit setup id for the deposit to add to the case.
-     * @param {number} [amount] - The amount of the deposit (optional)
-     * @param {string} [comment] - Comment text to add to the deposit (optional)
-     * @return {Object} Returns Promise that represents an object describing the newly-added deposit. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
-     */
-    addDeposit(caObjectId: number, depositId: number, amount?: number, comment?: string): Promise<unknown>;
-    /**
-     * Adds an instrument to the case specified by the CaObectId.
-     *
-     * @category Case Instruments
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the instrument
-     * @param {number} instTypeId - The instrument type id for the instrument being added to the case.
-     * @param {number} amount - The amount of the instrument
-     * @param {Date} dateExpire - The datetime for the instrument to expire.
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument for more options.
-     * @return {Object} Returns Promise that represents an object describing the newly-added instrument. See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument
-     */
-    addInstrument(caObjectId: number, instTypeId: number, amount: number, dateExpire: Date, options?: Object): Promise<unknown>;
-    /**
-     * Updates a fee specified by the CaFeeId.
-     *
-     * @category Case Fees
-     * @param {number} caFeeId - The Fee ID for the specific instance of the fee you wish to update
-     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)
-     * @return {Object} Returns Promise that represents an object describing the updated fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
-     */
-    updateFee(caFeeId: number, options?: Object): Promise<unknown>;
-    /**
-     * Void a refund.
-     *
-     * @category Case Refund Payment
-     * @param {number} caPaymentRefundId - The Refund ID for the specific refund to void
-     * @param {String} voided - A string. No clue.
-     * @return {Object} Returns Promise that represents an object describing the voided refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
-     */
-    voidRefund(caPaymentRefundId: number, voided: string): Promise<unknown>;
-    /**
-     * Adds Default Case Fees. Adds fees to the case specified by the CaObectId and BusCaseId.
-     *
-     * @category Case Fees
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the default fees
-     * @param {number} busCaseId - The business case ID whose default fees should be added to the case
-     * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
-     */
-    addDefaultFees(caObjectId: number, busCaseId: number): Promise<unknown>;
-    /**
-     * Adds Default Case Deposits. Adds deposits to the case specified by the CaObectId and BusCaseId.
-     *
-     * @category Case Deposits
-     * @param {number} caObjectId - The Case Object ID for the case to which to add the default deposits
-     * @param {number} busCaseId - The business case ID whose default deposits should be added to the case
-     * @return {Object} Returns Promise that represents a collection of Deposit Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
-     */
-    addDefaultDeposits(caObjectId: number, busCaseId: number): Promise<unknown>;
-    /**
-     * Gets the fees from the case specified by the CaObectId.
-     *
-     * @category Case Fees
-     * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
-     * @return {Object} Returns Promise that represents a collection of Case Fees.
-     */
-    getFees(caObjectId: number): Promise<unknown>;
-    /**
-     * Get Case Deposit by Case ObjectId.
-     *
-     * @category Case Deposits
-     * @param {number} caObjectId - The Case Object ID for the case to which to get the deposits
-     * @return {Object} Returns Promise that represents a collection of Case Deposits.
-     */
-    getDeposits(caObjectId: number): Promise<unknown>;
-    /**
-     * Get Case Payments by Case ObjectId
-     *
-     * @category Case Payments
-     * @param {number} caObjectId - The Case Object ID for the case to which to get the payments
-     * @return {Object} Returns Promise that represents a collection of Case Payments.
-     */
-    getPayments(caObjectId: number): Promise<unknown>;
-    /**
-     * Gets the instruments from the case specified by the CaObectId.
-     *
-     * @category Case Instruments
-     * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
-     * @return {Object} Returns Promise that represents a collection of Case Instruments.
-     */
-    getInstruments(caObjectId: number): Promise<unknown>;
-    /**
-     * Delete the fee specified by the caFeeId.
-     *
-     * @category Case Fees
-     * @param {number} caFeeId - The Case Fee ID which should be deleted
-     * @return {Object} Returns Promise that represents a Case Fee object.
-     */
-    deleteFee(caFeeId: number): Promise<unknown>;
-    /**
-     * 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).
-     *
-     * @category Case Fees
-     * @param {number} caObjectId - The Case Object ID whose fees should be deleted
-     * @return {Object} Returns Promise that represents a number (?)
-     */
-    deleteFeesByCaseId(caObjectId: number): Promise<unknown>;
-    /**
-     * Delete a Case Payment by Id. Delete a specific case payment by CaPaymentId.
-     *
-     * @category Case Payments
-     * @param {number} caPaymentId - The Case Payment ID which should be deleted
-     * @return {Object} Returns Promise that represents a Case Payment object.
-     */
-    deletePayment(caFeeId: number): Promise<unknown>;
-    /**
-     * Delete Case Payment Refund. Removes a refund on a payment.
-     *
-     * @category Case Payment Refunds
-     * @param {number} caPaymentRefundId - The Case Payment ID for the case payment which to refund
-     * @return {Object} Returns Promise that represents an object describing the deleted payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
-     */
-    deleteRefund(caPaymentRefundId: number): Promise<unknown>;
-    /**
-     * Delete Case Payments by Case ObjectId. Delete from the system all payments associated to a specific case as specified by the case id (CaObjectId)
-     *
-     * @category Case Payments
-     * @param {number} caObjectId - The Case Object ID whose payments should be deleted
-     * @return {Object} Returns Promise that represents a number (?)
-     */
-    deletePaymentsByCaseId(caObjectId: number): Promise<unknown>;
-    /**
-     * Delete the fee specified by the caFeeId.
-     *
-     * @category Case Deposits
-     * @param {number} caDepositId - The Case Deposit ID which should be deleted
-     * @return {Object} Returns Promise that represents a collection of Case Deposits.
-     */
-    deleteDeposit(caDepositId: number): Promise<unknown>;
-    /**
-     * 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).
-     *
-     * @category Case Deposits
-     * @param {number} caObjectId - The Case Object ID whose fees should be deleted
-     * @return {Object} Returns Promise that represents a number (?)
-     */
-    deleteDepositsByCaseId(caObjectId: number): Promise<unknown>;
-    /**
-     * Delete the instrument specified by the caInstrumentId.
-     *
-     * @category Case Instruments
-     * @param {number} caInstrumentId - The Case Instrument ID which should be deleted
-     * @return {Object} Returns Promise that represents a Case Instrument.
-     */
-    deleteInstrument(caInstrumentId: number): Promise<unknown>;
-    /**
-     * 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).
-     *
-     * @category Case Instruments
-     * @param {number} caObjectId - The Case Object ID whose instruments should be deleted
-     * @return {Object} Returns Promise that represents a number (?)
-     */
-    deleteInstrumentsByCaseId(caObjectId: number): Promise<unknown>;
-    /**
-     * Search for Case Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Fees
-     * @param {Object} filters - The parameter(s) to search by
-     * @return {Object} Returns Promise that represents an Array of case fee IDs
-     */
-    searchFees(filters: Object): Promise<unknown>;
-    /**
-     * Search for Case Payments. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Payments
-     * @param {Object} filters - The filters to search for matched Case Payments
-     * @return {Object} Returns Promise that represents an Array of case payment IDs
-     */
-    searchPayments(filters: Object): Promise<unknown>;
-    /**
-     * Search for Case Payment Refunds. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Payment Refunds
-     * @param {Object} filters - The filters to search for matched Case Payments.
-     * @return {Object} Returns Promise that represents an Array of case payment refund IDs
-     */
-    searchRefunds(filters: Object): Promise<unknown>;
-    /**
-     * Search for Case Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Deposits
-     * @param {Object} filters - The parameters to search by.
-     * @return {Object} Returns Promise that represents an Array of case fee IDs
-     */
-    searchDeposits(filters: Object): Promise<unknown>;
-    /**
-     * Get All Fee Templates
-     *
-     * @category Case Fees
-     * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
-     */
-    getAllFeeTemplates(): Promise<unknown>;
-    /**
-     * Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Fees
-     * @param {Object} filters - The parameters to search by
-     * @return {Object} Returns Promise that represents an Array of case fee IDs
-     */
-    searchFeeTemplates(filters: Object): Promise<unknown>;
-    /**
-     * Search for Case Instruments. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-     *
-     * @category Case Instruments
-     * @param {Object} filters - The parameters to search by (AddressLine1, Amount, CaInstrumentId, CityName, CommentText, Company, ContactEmail, ContactName, ContactPhone, CountryCode, InstTypeId, SerialNumber, StateCode, ZipCode)
-     * @return {Object} Returns Promise that represents an Array of case instrument IDs
-     */
-    searchCaseInstruments(filters: Object): Promise<unknown>;
-    /**
-     * Get the Defined Instruments
-     *
-     * @category Instruments
-     * @param {Object} options - the options to filter the instruments returned by
-     * @return {Object} Returns Promise that represents an Array of CaInstrumentItem
-     */
-    getInstrumentList(options: Object): Promise<unknown>;
-    /**
-     * Adds a release to a case instrument specified by the caInstrumentId. Must provide either amountReleased OR percentReleased
-     *
-     * @category Case Instrument Releases
-     * @param {number} caInstrumentId - The Case Instrument ID to which to add the instrument release
-     * @param {number} releasedBy - UserID to attach to the release.
-     * @param {Date} dateReleased - The date of the release
-     * @param {number} [amountReleased] - The amount to be released
-     * @param {number} [percentReleased] - OR the percent to be released
-     * @param {string} [comment] - Comment to attach to the release
-     * @return {Object} Returns Promise that represents an object describing the newly-added instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
-     */
-    addCaseInstrumentRelease(caInstrumentId: number, releasedBy: number, dateReleased: Date, amountReleased?: number, percentReleased?: number, comment?: string): Promise<unknown>;
-    /**
-     * Deletes a release specified by the caInstReleasesId.
-     *
-     * @category Case Instrument Releases
-     * @param {number} caInstReleasesId - The Case Instrument Release ID to delete
-     * @return {Object} Returns Promise that represents an object describing the deleted instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
-     */
-    deleteCaseInstrumentRelease(caInstReleasesId: number): Promise<unknown>;
-    /**
-     * Search for Case Instrument Releases. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
-     *
-     * @category Case Instrument Releases
-     * @param {Object} filters - Specify at least one of the following: AmountReleased, CaInstReleasesId, CaInstrumentId, CommentText, PercentReleased, ReleasedBy
-     * @return {Object} Returns Promise that represents an Array of Case Instruments resulting from the search
-     */
-    searchCaseInstrumentReleases(filters: Object): Promise<unknown>;
-    /**
-     * Get All Fees
-     *
-     * @category Fees
-     * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
-     */
-    fees(): Promise<unknown>;
-    /**
-     * Search for Fees. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
-     *
-     * @category Fees
-     * @param {Object} filters - Specify at least one.
-     * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
-     */
-    searchAvailableFees(filters: {
-        AccountCode?: string;
-        FeeCode?: string;
-        FeeDesc?: string;
-        FeeSetupId?: number;
-        FeeTypeId?: number;
-    }): Promise<unknown>;
-    /**
-     * Get all tender types configured
-     *
-     * @category Tender Types
-     * @return {Object} Returns Promise that represents a collection of tender type objects. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
-     */
-    getTenderTypes(): Promise<unknown>;
-    /**
-     * Adds a tender type configuration
-     *
-     * @category Tender Types
-     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
-     * @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
-     */
-    addTenderType(options: Object): Promise<unknown>;
-    /**
-     * Update a tender type configuration
-     *
-     * @category Tender Types
-     * @param {number} tenderTypeId - ID of the tender type to update
-     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
-     * @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
-     */
-    updateTenderType(tenderTypeId: number, options: Object): Promise<unknown>;
-}
+export declare class CaseFinancial {
+    /**
+     * @hidden
+     */
+    cw: any;
+    /**
+     * @hidden
+     */
+    constructor(cw: Object);
+    /**
+     * Adds a fee to the case specified by the CaObectId.
+     *
+     * @category Case Fees
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
+     * @param {number} feeSetupId - The fee setup id for the fee to add to the case.
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)
+     * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    addFee(caObjectId: number, feeSetupId: number, options?: Object): Promise<unknown>;
+    /**
+     * Add Case Fee Payment. Adds a payment to the case fee specified by caObjectId.
+     *
+     * @category Case Payments
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
+     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
+     * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
+     */
+    addPayment(caObjectId: number, options: Object): Promise<unknown>;
+    /**
+     * Make a Payment. Adds a payment to the case fee(s) specified.
+     *
+     * @category Case Payments
+     * @param {Array<Array<string>>} payments - The Case Object ID for the case to which to add the fee
+     * @param {Array<number>} caseFees - Fees this payment should be applied to. Array of CaFeeIds values.
+     * @param {stringName:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,CityName?:string,CommentText?:string,Email?:string,FaxNumber?:string,PhoneHome?:string,PhoneMobile?:string,PhoneWork?:string,PhoneWorkExt?:string,StateCode?:string,WebSiteUrl?:string,ZipCode?:string,CountryCode?:string} payerInfo - Payer info for the payment being made.
+     * @return {Object} Returns Promise that represents an object describing the newly-added payment.
+     */
+    makePayment(payments: Array<Array<string>>, caseFees: Array<number>, payerInfo?: {
+        stringName: string;
+        AddressLine1?: string;
+        AddressLine2?: string;
+        AddressLine3?: string;
+        CityName?: string;
+        CommentText?: string;
+        Email?: string;
+        FaxNumber?: string;
+        PhoneHome?: string;
+        PhoneMobile?: string;
+        PhoneWork?: string;
+        PhoneWorkExt?: string;
+        StateCode?: string;
+        WebSiteUrl?: string;
+        ZipCode?: string;
+        CountryCode?: string;
+    }): Promise<unknown>;
+    /**
+     * Add Case Payment Refund. Refunds a payment on the case payment specified by caPaymentId.
+     *
+     * @category Case Payment Refunds
+     * @param {number} caPaymentId - The Case Payment ID for the case payment which to refund
+     * @param {number} refundAmount - The amount to refund
+     * @param {string} comment - A comment to append to the refund
+     * @return {Object} Returns Promise that represents an object describing the newly-added payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
+     */
+    addRefund(caPaymentId: number, refundAmount: number, comment: string): Promise<unknown>;
+    /**
+     * Add Case Deposit Payment. Adds a payment to the case deposit specified by CaDepositId.
+     *
+     * @category Case Payments
+     * @param {number} caDepositId - The Case Deposit ID for the case deposit to which to add the fee
+     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.
+     * @return {Object} Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase
+     */
+    addDepositPayment(caDepositId: number, options: Object): Promise<unknown>;
+    /**
+     * Adds a deposit to the case specified by the CaObectId.
+     *
+     * @category Case Deposits
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the fee
+     * @param {number} depositId - The deposit setup id for the deposit to add to the case.
+     * @param {number} [amount] - The amount of the deposit (optional)
+     * @param {string} [comment] - Comment text to add to the deposit (optional)
+     * @return {Object} Returns Promise that represents an object describing the newly-added deposit. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
+     */
+    addDeposit(caObjectId: number, depositId: number, amount?: number, comment?: string): Promise<unknown>;
+    /**
+     * Adds an instrument to the case specified by the CaObectId.
+     *
+     * @category Case Instruments
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the instrument
+     * @param {number} instTypeId - The instrument type id for the instrument being added to the case.
+     * @param {number} amount - The amount of the instrument
+     * @param {Date} dateExpire - The datetime for the instrument to expire.
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument for more options.
+     * @return {Object} Returns Promise that represents an object describing the newly-added instrument. See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument
+     */
+    addInstrument(caObjectId: number, instTypeId: number, amount: number, dateExpire: Date, options?: Object): Promise<unknown>;
+    /**
+     * Updates a fee specified by the CaFeeId.
+     *
+     * @category Case Fees
+     * @param {number} caFeeId - The Fee ID for the specific instance of the fee you wish to update
+     * @param {Object} [options] - See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)
+     * @return {Object} Returns Promise that represents an object describing the updated fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    updateFee(caFeeId: number, options?: Object): Promise<unknown>;
+    /**
+     * Void a refund.
+     *
+     * @category Case Refund Payment
+     * @param {number} caPaymentRefundId - The Refund ID for the specific refund to void
+     * @param {String} voided - A string. No clue.
+     * @return {Object} Returns Promise that represents an object describing the voided refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
+     */
+    voidRefund(caPaymentRefundId: number, voided: string): Promise<unknown>;
+    /**
+     * Adds Default Case Fees. Adds fees to the case specified by the CaObectId and BusCaseId.
+     *
+     * @category Case Fees
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the default fees
+     * @param {number} busCaseId - The business case ID whose default fees should be added to the case
+     * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    addDefaultFees(caObjectId: number, busCaseId: number): Promise<unknown>;
+    /**
+     * Adds Default Case Deposits. Adds deposits to the case specified by the CaObectId and BusCaseId.
+     *
+     * @category Case Deposits
+     * @param {number} caObjectId - The Case Object ID for the case to which to add the default deposits
+     * @param {number} busCaseId - The business case ID whose default deposits should be added to the case
+     * @return {Object} Returns Promise that represents a collection of Deposit Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase
+     */
+    addDefaultDeposits(caObjectId: number, busCaseId: number): Promise<unknown>;
+    /**
+     * Gets the fees from the case specified by the CaObectId.
+     *
+     * @category Case Fees
+     * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
+     * @return {Object} Returns Promise that represents a collection of Case Fees.
+     */
+    getFees(caObjectId: number): Promise<unknown>;
+    /**
+     * Get Case Deposit by Case ObjectId.
+     *
+     * @category Case Deposits
+     * @param {number} caObjectId - The Case Object ID for the case to which to get the deposits
+     * @return {Object} Returns Promise that represents a collection of Case Deposits.
+     */
+    getDeposits(caObjectId: number): Promise<unknown>;
+    /**
+     * Get Case Payments by Case ObjectId
+     *
+     * @category Case Payments
+     * @param {number} caObjectId - The Case Object ID for the case to which to get the payments
+     * @return {Object} Returns Promise that represents a collection of Case Payments.
+     */
+    getPayments(caObjectId: number): Promise<unknown>;
+    /**
+     * Gets the instruments from the case specified by the CaObectId.
+     *
+     * @category Case Instruments
+     * @param {number} caObjectId - The Case Object ID for the case to which to get the fees
+     * @return {Object} Returns Promise that represents a collection of Case Instruments.
+     */
+    getInstruments(caObjectId: number): Promise<unknown>;
+    /**
+     * Delete the fee specified by the caFeeId.
+     *
+     * @category Case Fees
+     * @param {number} caFeeId - The Case Fee ID which should be deleted
+     * @return {Object} Returns Promise that represents a Case Fee object.
+     */
+    deleteFee(caFeeId: number): Promise<unknown>;
+    /**
+     * 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).
+     *
+     * @category Case Fees
+     * @param {number} caObjectId - The Case Object ID whose fees should be deleted
+     * @return {Object} Returns Promise that represents a number (?)
+     */
+    deleteFeesByCaseId(caObjectId: number): Promise<unknown>;
+    /**
+     * Delete a Case Payment by Id. Delete a specific case payment by CaPaymentId.
+     *
+     * @category Case Payments
+     * @param {number} caPaymentId - The Case Payment ID which should be deleted
+     * @return {Object} Returns Promise that represents a Case Payment object.
+     */
+    deletePayment(caFeeId: number): Promise<unknown>;
+    /**
+     * Delete Case Payment Refund. Removes a refund on a payment.
+     *
+     * @category Case Payment Refunds
+     * @param {number} caPaymentRefundId - The Case Payment ID for the case payment which to refund
+     * @return {Object} Returns Promise that represents an object describing the deleted payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase
+     */
+    deleteRefund(caPaymentRefundId: number): Promise<unknown>;
+    /**
+     * Delete Case Payments by Case ObjectId. Delete from the system all payments associated to a specific case as specified by the case id (CaObjectId)
+     *
+     * @category Case Payments
+     * @param {number} caObjectId - The Case Object ID whose payments should be deleted
+     * @return {Object} Returns Promise that represents a number (?)
+     */
+    deletePaymentsByCaseId(caObjectId: number): Promise<unknown>;
+    /**
+     * Delete the fee specified by the caFeeId.
+     *
+     * @category Case Deposits
+     * @param {number} caDepositId - The Case Deposit ID which should be deleted
+     * @return {Object} Returns Promise that represents a collection of Case Deposits.
+     */
+    deleteDeposit(caDepositId: number): Promise<unknown>;
+    /**
+     * 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).
+     *
+     * @category Case Deposits
+     * @param {number} caObjectId - The Case Object ID whose fees should be deleted
+     * @return {Object} Returns Promise that represents a number (?)
+     */
+    deleteDepositsByCaseId(caObjectId: number): Promise<unknown>;
+    /**
+     * Delete the instrument specified by the caInstrumentId.
+     *
+     * @category Case Instruments
+     * @param {number} caInstrumentId - The Case Instrument ID which should be deleted
+     * @return {Object} Returns Promise that represents a Case Instrument.
+     */
+    deleteInstrument(caInstrumentId: number): Promise<unknown>;
+    /**
+     * 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).
+     *
+     * @category Case Instruments
+     * @param {number} caObjectId - The Case Object ID whose instruments should be deleted
+     * @return {Object} Returns Promise that represents a number (?)
+     */
+    deleteInstrumentsByCaseId(caObjectId: number): Promise<unknown>;
+    /**
+     * Search for Case Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Fees
+     * @param {Object} filters - The parameter(s) to search by
+     * @return {Object} Returns Promise that represents an Array of case fee IDs
+     */
+    searchFees(filters: Object): Promise<unknown>;
+    /**
+     * Search for Case Payments. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Payments
+     * @param {Object} filters - The filters to search for matched Case Payments
+     * @return {Object} Returns Promise that represents an Array of case payment IDs
+     */
+    searchPayments(filters: Object): Promise<unknown>;
+    /**
+     * Search for Case Payment Refunds. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Payment Refunds
+     * @param {Object} filters - The filters to search for matched Case Payments.
+     * @return {Object} Returns Promise that represents an Array of case payment refund IDs
+     */
+    searchRefunds(filters: Object): Promise<unknown>;
+    /**
+     * Get the Escrow Fees for a specific case template (BusCaseId).
+     *
+     * @category Case Escrow
+     * @param {number} busCaseId - The business case ID whose default fees should be added to the case
+     * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    getEscrowFees(busCaseId: number): Promise<unknown>;
+    /**
+     * Add an Escrow Payment. Adds a payment to the case.
+     *
+     * @category Case Escrow
+     * @param {number} escrowPaymentItems - The escrow payment items to add to the case (See: /{subdirectory}/apidocs/#/data-type-info;dataType=EscrowPaymentItem)
+     * @return {Object} Returns Promise that represents a collection of Escrow Paymnent Items that were added.
+     */
+    addEscrowPayment(escrowPaymentItems: Array<Object>): Promise<unknown>;
+    /**
+     * Search for Escrow Payments
+     *
+     * @category Case Escrow
+     * @param {number} caObectId - The business case ID whose default fees should be added to the case
+     * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    /**
+     * Get the Escrow Fees for a specific case template (BusCaseId).
+     *
+     * @category Case Escrow
+     * @param {number} busCaseId - The business case ID whose default fees should be added to the case
+     * @return {Object} Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    updateEscrowPayment(busCaseId: number): Promise<unknown>;
+    /**
+     * Search for Case Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Deposits
+     * @param {Object} filters - The parameters to search by.
+     * @return {Object} Returns Promise that represents an Array of case fee IDs
+     */
+    searchDeposits(filters: Object): Promise<unknown>;
+    /**
+     * Get All Fee Templates
+     *
+     * @category Case Fees
+     * @return {Object} Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase
+     */
+    getAllFeeTemplates(): Promise<unknown>;
+    /**
+     * Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Fees
+     * @param {Object} filters - The parameters to search by
+     * @return {Object} Returns Promise that represents an Array of case fee IDs
+     */
+    searchFeeTemplates(filters: Object): Promise<unknown>;
+    /**
+     * Search for Case Instruments. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
+     *
+     * @category Case Instruments
+     * @param {Object} filters - The parameters to search by (AddressLine1, Amount, CaInstrumentId, CityName, CommentText, Company, ContactEmail, ContactName, ContactPhone, CountryCode, InstTypeId, SerialNumber, StateCode, ZipCode)
+     * @return {Object} Returns Promise that represents an Array of case instrument IDs
+     */
+    searchCaseInstruments(filters: Object): Promise<unknown>;
+    /**
+     * Get the Defined Instruments
+     *
+     * @category Instruments
+     * @param {Object} options - the options to filter the instruments returned by
+     * @return {Object} Returns Promise that represents an Array of CaInstrumentItem
+     */
+    getInstrumentList(options: Object): Promise<unknown>;
+    /**
+     * Adds a release to a case instrument specified by the caInstrumentId. Must provide either amountReleased OR percentReleased
+     *
+     * @category Case Instrument Releases
+     * @param {number} caInstrumentId - The Case Instrument ID to which to add the instrument release
+     * @param {number} releasedBy - UserID to attach to the release.
+     * @param {Date} dateReleased - The date of the release
+     * @param {number} [amountReleased] - The amount to be released
+     * @param {number} [percentReleased] - OR the percent to be released
+     * @param {string} [comment] - Comment to attach to the release
+     * @return {Object} Returns Promise that represents an object describing the newly-added instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
+     */
+    addCaseInstrumentRelease(caInstrumentId: number, releasedBy: number, dateReleased: Date, amountReleased?: number, percentReleased?: number, comment?: string): Promise<unknown>;
+    /**
+     * Deletes a release specified by the caInstReleasesId.
+     *
+     * @category Case Instrument Releases
+     * @param {number} caInstReleasesId - The Case Instrument Release ID to delete
+     * @return {Object} Returns Promise that represents an object describing the deleted instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase
+     */
+    deleteCaseInstrumentRelease(caInstReleasesId: number): Promise<unknown>;
+    /**
+     * Search for Case Instrument Releases. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
+     *
+     * @category Case Instrument Releases
+     * @param {Object} filters - Specify at least one of the following: AmountReleased, CaInstReleasesId, CaInstrumentId, CommentText, PercentReleased, ReleasedBy
+     * @return {Object} Returns Promise that represents an Array of Case Instruments resulting from the search
+     */
+    searchCaseInstrumentReleases(filters: Object): Promise<unknown>;
+    /**
+     * Get All Fees
+     *
+     * @category Fees
+     * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
+     */
+    fees(): Promise<unknown>;
+    /**
+     * Search for Fees. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.
+     *
+     * @category Fees
+     * @param {Object} filters - Specify at least one.
+     * @return {Object} Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase
+     */
+    searchAvailableFees(filters: {
+        AccountCode?: string;
+        FeeCode?: string;
+        FeeDesc?: string;
+        FeeSetupId?: number;
+        FeeTypeId?: number;
+    }): Promise<unknown>;
+    /**
+     * Get all tender types configured
+     *
+     * @category Tender Types
+     * @return {Object} Returns Promise that represents a collection of tender type objects. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
+     */
+    getTenderTypes(): Promise<unknown>;
+    /**
+     * Adds a tender type configuration
+     *
+     * @category Tender Types
+     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
+     * @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
+     */
+    addTenderType(options: Object): Promise<unknown>;
+    /**
+     * Update a tender type configuration
+     *
+     * @category Tender Types
+     * @param {number} tenderTypeId - ID of the tender type to update
+     * @param {Object} options - See /{subdirectory}/apidocs/#/service-info/Pll/TenderType
+     * @return {Object} Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem
+     */
+    updateTenderType(tenderTypeId: number, options: Object): Promise<unknown>;
+}