import { HttpClient, HttpHeaders, HttpResponse } from '@angular/common/http'; import { Observable } from 'rxjs'; import * as i0 from '@angular/core'; import { InjectionToken, ModuleWithProviders } from '@angular/core'; import * as i1 from '@angular/common'; /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountAlertRequest { /** * Required Must be between 1899-12-31 and 3000-01-01 */ beginDate: Date | null; /** * Required Must be between 1899-12-31 and 3000-01-01 Must be greater than or equal to BeginDate */ endDate: Date | null; /** * Required */ message: string | null; /** * Required */ allowBillProcessing: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountAlertResponse { /** * */ alertId: number | null | undefined; /** * */ beginDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; /** * */ message: string | null | undefined; /** * */ allowBillProcessing: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountAuditEnable { /** * List of AccountIds to try and update Cannot be Empty Required (defined) */ accountIds: Array | null | undefined; /** * True to allow the accounts' bills to be audited False to exclude the accounts' bills from being audited Required (defined) */ auditEnabled: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillCostWithOutlierAnalysisSettingRequest { /** * Minimum outlier sensitivity for abnormal cost analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of 'Severe', 'High', 'Moderate' */ sensitivity: string | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillDemandWithOutlierAnalysisSettingRequest { /** * Minimum outlier sensitivity for abnormal demand analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of 'Severe', 'High', 'Moderate' */ sensitivity: string | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillUseWithOutlierAnalysisSettingRequest { /** * Minimum outlier sensitivity for abnormal use analysis If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold One of 'Severe', 'High', 'Moderate' */ sensitivity: string | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AuditSettingRequest { /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillContainsLineItemDescriptionsSettingRequest { /** * List of line item descriptions. Each description must be shorter than 100 characters. If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty */ lineItemDescriptions: Array | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillContainsLineItemTypesSettingRequest { /** * List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty */ lineItemTypes: Array | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillSignificantlyShorterOrLongerThanPreviousSettingRequest { /** * Percent variance for bill length If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty */ percentLengthVariance: number | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DueDateTooLongAfterBillEndSettingRequest { /** * Threshold for how long the due date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 0 and 2147483647 Required when SettingStatus is set to Check, or Hold */ days: number | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class StatementDateTooLongAfterBillEndSettingRequest { /** * Threshold for how long the statement date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 0 and 2147483647 Required when SettingStatus is set to Check, or Hold */ days: number | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TooManyConsecutiveEstimatedBillsSettingRequest { /** * Threshold for how many bills can be estimated in a row If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Must be between 1 and 2147483647 Required when SettingStatus is set to Check, or Hold */ bills: number | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TotalBillCostDoesNotMatchLineItemTypesSettingRequest { /** * List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set Required when SettingStatus is set to Check, or Hold List cannot be empty */ lineItemTypes: Array | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountAuditSettingsRequest { billContainsLineItemDescriptions: BillContainsLineItemDescriptionsSettingRequest | null | undefined; billContainsLineItemTypes: BillContainsLineItemTypesSettingRequest | null | undefined; totalBillCostDoesNotMatchLineItemTypes: TotalBillCostDoesNotMatchLineItemTypesSettingRequest | null | undefined; billingPeriodOutsideStartEndDates: AuditSettingRequest | null | undefined; billOverlapsWithOtherAccountBill: AuditSettingRequest | null | undefined; gapBetweenBillAndPreviousBillOnAccount: AuditSettingRequest | null | undefined; billEndsInFuture: AuditSettingRequest | null | undefined; accountHasMultipleBillsInBillingPeriod: AuditSettingRequest | null | undefined; statementDateBeforeEndDate: AuditSettingRequest | null | undefined; dueDateBeforeEndDate: AuditSettingRequest | null | undefined; billSignificantlyShorterOrLongerThanPrevious: BillSignificantlyShorterOrLongerThanPreviousSettingRequest | null | undefined; tooManyConsecutiveEstimatedBills: TooManyConsecutiveEstimatedBillsSettingRequest | null | undefined; dueDateTooLongAfterBillEnd: DueDateTooLongAfterBillEndSettingRequest | null | undefined; statementDateTooLongAfterBillEnd: StatementDateTooLongAfterBillEndSettingRequest | null | undefined; invoiceNumberIsRepeatedOnAccount: AuditSettingRequest | null | undefined; likelyDuplicateBillOnAccount: AuditSettingRequest | null | undefined; totalMeterCostIsPercentageHigherThanPastYear: AuditSettingRequest | null | undefined; totalMeterUseIsPercentageHigherThanPastYear: AuditSettingRequest | null | undefined; serialNumberDoesNotMatchImportFile: AuditSettingRequest | null | undefined; rateCodeDoesNotMatchImportFile: AuditSettingRequest | null | undefined; importFileStartDateAdjustedToPreventGaps: AuditSettingRequest | null | undefined; accountAlertExistsOnAccountInImportFile: AuditSettingRequest | null | undefined; abnormalBillCostWithOutlierAnalysis: AbnormalBillCostWithOutlierAnalysisSettingRequest | null | undefined; abnormalBillUseWithOutlierAnalysis: AbnormalBillUseWithOutlierAnalysisSettingRequest | null | undefined; abnormalBillDemandWithOutlierAnalysis: AbnormalBillDemandWithOutlierAnalysisSettingRequest | null | undefined; currencyUnitAnalysis: AuditSettingRequest | null | undefined; multipleUseUnitAnalysis: AuditSettingRequest | null | undefined; billUseUnitDifferentFromMeterAnalysis: AuditSettingRequest | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorChild { /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountChild { /** * */ accountId: number | null | undefined; /** * */ accountCode: string | null | undefined; /** * */ accountInfo: string | null | undefined; vendor: VendorChild | null | undefined; /** * */ active: boolean | null | undefined; /** * */ hasCalculatedMeter: boolean | null | undefined; /** * */ hasSplitParentMeter: boolean | null | undefined; /** * */ hasSplitChildMeter: boolean | null | undefined; /** * */ isSubAccount: boolean | null | undefined; /** * */ hasSubAccount: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserChild { /** * The user identifier */ userId: number | null | undefined; /** * The user code */ userCode: string | null | undefined; /** * The user's full name */ fullName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillCostWithOutlierAnalysisSettingResponse { /** * Minimum outlier sensitivity for abnormal cost analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ sensitivity: string | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillDemandWithOutlierAnalysisSettingResponse { /** * Minimum outlier sensitivity for abnormal demand analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ sensitivity: string | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AbnormalBillUseWithOutlierAnalysisSettingResponse { /** * Minimum outlier sensitivity for abnormal use analysis Possible values - severe, high, moderate If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ sensitivity: string | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AuditSettingResponse { /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillContainsLineItemDescriptionsSettingResponse { /** * List of line item descriptions. Each description must be shorter than 100 characters. If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ lineItemDescriptions: Array | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillContainsLineItemTypesSettingResponse { /** * List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ lineItemTypes: Array | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillSignificantlyShorterOrLongerThanPreviousSettingResponse { /** * Percent variance for bill length If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ percentLengthVariance: number | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Icon { /** * The icon code Must be between 0 and 64 characters Required when Color is set */ code: string | null | undefined; /** * The icon color Must be between 0 and 32 characters Required when Code is set */ color: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityChild { /** * The commodity identifier Required (defined) */ commodityId: number | null | undefined; /** * The commodity code Required (defined) */ commodityCode: string | null | undefined; /** * The commodity info Required (defined) */ commodityInfo: string | null | undefined; commodityIcon: Icon | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommoditySkipAuditSettingResponse { /** * */ commoditiesToSkip: Array | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DueDateTooLongAfterBillEndSettingResponse { /** * Threshold for how long the due date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ days: number | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class StatementDateTooLongAfterBillEndSettingResponse { /** * Threshold for how long the statement date can be after the end date If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ days: number | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TooManyConsecutiveEstimatedBillsSettingResponse { /** * Threshold for how many bills can be estimated in a row If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ bills: number | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TotalBillCostDoesNotMatchLineItemTypesSettingResponse { /** * List of observation type codes If SettingStatus is set to Skip and no value is provided, EnergyCAP default will be set */ lineItemTypes: Array | null | undefined; /** * The status of the audit setting - Possible values Check, Hold, Skip */ settingStatus: string | null | undefined; /** * The setting code */ settingCode: string | null | undefined; /** * A description of the setting */ settingDescription: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit wwill run only when the cost meets the specified minimum cost */ minimumCost: number | null | undefined; /** * List of Assignees. UserChildDTO representing the users the flag should get assigned to when the audit fails. */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AuditSettingsResponse { billContainsLineItemDescriptions: BillContainsLineItemDescriptionsSettingResponse | null | undefined; billContainsLineItemTypes: BillContainsLineItemTypesSettingResponse | null | undefined; totalBillCostDoesNotMatchLineItemTypes: TotalBillCostDoesNotMatchLineItemTypesSettingResponse | null | undefined; billingPeriodOutsideStartEndDates: AuditSettingResponse | null | undefined; billOverlapsWithOtherAccountBill: CommoditySkipAuditSettingResponse | null | undefined; gapBetweenBillAndPreviousBillOnAccount: CommoditySkipAuditSettingResponse | null | undefined; billEndsInFuture: AuditSettingResponse | null | undefined; accountHasMultipleBillsInBillingPeriod: CommoditySkipAuditSettingResponse | null | undefined; statementDateBeforeEndDate: AuditSettingResponse | null | undefined; dueDateBeforeEndDate: AuditSettingResponse | null | undefined; billSignificantlyShorterOrLongerThanPrevious: BillSignificantlyShorterOrLongerThanPreviousSettingResponse | null | undefined; tooManyConsecutiveEstimatedBills: TooManyConsecutiveEstimatedBillsSettingResponse | null | undefined; dueDateTooLongAfterBillEnd: DueDateTooLongAfterBillEndSettingResponse | null | undefined; statementDateTooLongAfterBillEnd: StatementDateTooLongAfterBillEndSettingResponse | null | undefined; invoiceNumberIsRepeatedOnAccount: AuditSettingResponse | null | undefined; likelyDuplicateBillOnAccount: AuditSettingResponse | null | undefined; totalMeterCostIsPercentageHigherThanPastYear: AuditSettingResponse | null | undefined; totalMeterUseIsPercentageHigherThanPastYear: AuditSettingResponse | null | undefined; serialNumberDoesNotMatchImportFile: AuditSettingResponse | null | undefined; rateCodeDoesNotMatchImportFile: AuditSettingResponse | null | undefined; importFileStartDateAdjustedToPreventGaps: AuditSettingResponse | null | undefined; accountAlertExistsOnAccountInImportFile: AuditSettingResponse | null | undefined; abnormalBillCostWithOutlierAnalysis: AbnormalBillCostWithOutlierAnalysisSettingResponse | null | undefined; abnormalBillUseWithOutlierAnalysis: AbnormalBillUseWithOutlierAnalysisSettingResponse | null | undefined; abnormalBillDemandWithOutlierAnalysis: AbnormalBillDemandWithOutlierAnalysisSettingResponse | null | undefined; currencyUnitAnalysis: AuditSettingResponse | null | undefined; multipleUseUnitAnalysis: AuditSettingResponse | null | undefined; billUseUnitDifferentFromMeterAnalysis: AuditSettingResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountAuditSettingsResponse { account: AccountChild | null | undefined; /** * Indicates if audits are enabled for the account */ auditEnabled: boolean | null | undefined; settings: AuditSettingsResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountCodeHistoryRequest { /** * Account code that will replace the existing one Required Must be between 0 and 50 characters */ newAccountCode: string | null; /** * Account info that can replace the existing info Must be between 0 and 50 characters Required (defined) */ newAccountInfo: string | null | undefined; /** * Date that the account code was changed Required (defined) */ codeChangeDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountCodeHistoryChild { /** * The previous account code of this account */ previousAccountCode: string | null | undefined; /** * Date that the account code was changed */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountCodeHistoryResponse { /** * Account identifier Required (defined) */ accountId: number | null | undefined; /** * Account code of the account Required (defined) */ accountCode: string | null | undefined; /** * Name of the account Required (defined) */ accountInfo: string | null | undefined; accountCodeHistory: AccountCodeHistoryChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AddressChildBase { /** * Remit To field is the name of the person or company who should receive the payment. It's required for bill pay customers. Must be between 0 and 100 characters */ remitTo: string | null | undefined; /** * The line 1 of the address Must be between 0 and 100 characters */ line1: string | null | undefined; /** * The line 2 of the address Must be between 0 and 100 characters */ line2: string | null | undefined; /** * The line 3 of the address Must be between 0 and 100 characters */ line3: string | null | undefined; /** * The city of the place Must be between 0 and 100 characters */ city: string | null | undefined; /** * The state of the place Must be between 0 and 100 characters */ state: string | null | undefined; /** * The country of the place Must be between 0 and 64 characters */ country: string | null | undefined; /** * The postal code of the place Must be between 0 and 32 characters */ postalCode: string | null | undefined; /** * The latitude of the place Required when the country is not United States or Canada Must be between -90 and 90 Required when Longitude is set */ latitude: number | null | undefined; /** * The longitude of the place Required when the country is not United States or Canada Must be between -180 and 180 Required when Latitude is set */ longitude: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountCreate { /** * The account code Required Must be between 0 and 50 characters */ accountCode: string | null; /** * The account info Required Must be between 0 and 50 characters */ accountInfo: string | null; /** * The identifier for the account type Required */ accountTypeId: number | null; /** * The identifier for the cost center to which the account belongs Topmost (CostCenter) Required */ costCenterId: number | null; /** * The identifier for the account's vendor Required */ vendorId: number | null; /** * The identifier for the customer the account serves. This is normally only set for chargeback accounts */ customerId: number | null | undefined; /** * The identifier for the account's contact */ contactId: number | null | undefined; /** * Indicates if the account is active or inactive */ active: boolean | null | undefined; /** * Indicates if the account is used with accruals */ accrualEnabled: boolean | null | undefined; /** * The address postal code Required when the country is US or CA Must be between 0 and 32 characters */ postalCode: string | null | undefined; /** * The address city Must be between 0 and 100 characters */ city: string | null | undefined; /** * The address state Must be between 0 and 100 characters */ state: string | null | undefined; /** * The address country Required Must be between 0 and 64 characters */ country: string | null; /** * The address first line Must be between 0 and 100 characters */ line1: string | null | undefined; /** * The address second line Must be between 0 and 100 characters */ line2: string | null | undefined; /** * The address third line Must be between 0 and 100 characters */ line3: string | null | undefined; /** * The date and time the account deposit was paid */ depositPaid: Date | null | undefined; /** * The date and time the account deposit was returned */ depositReturn: Date | null | undefined; /** * A note related to the account deposit */ depositNote: string | null | undefined; /** * The account deposit amount */ depositAmount: number | null | undefined; /** * The account memo */ memo: string | null | undefined; /** * The account's service begin date and time */ serviceStart: Date | null | undefined; /** * The account's service end date and time Must be greater than ServiceStart */ serviceEnd: Date | null | undefined; /** * An array of identifiers for meters attached to this account */ meters: Array | null | undefined; /** * The identifier for the account's generalLedgerId */ generalLedgerId: number | null | undefined; /** * A description of the account Must be between 0 and 4000 characters */ accountDescription: string | null | undefined; remitAddress: AddressChildBase | null | undefined; /** * The remit email Must be between 0 and 128 characters */ remitEmail: string | null | undefined; /** * The remit phone number Must be between 0 and 50 characters */ remitPhoneNumber: string | null | undefined; /** * Indicates whether the account is a landlord account */ landlordAccount: boolean | null | undefined; /** * The BillCapture bill acquisition method for the account EnergyCap.Shared.Common.Utilities.BillCaptureAccountBillAcquisitionMethod One of 'Customer_Upload', 'Mail_Redirect', 'Web_Download', 'Web_Download_And_Extract_1', 'Web_Download_And_Extract_2', 'EDI', 'Custom_Import', 'Email_Delivery' */ billAcquisitionMethod: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountEdit { /** * An array of account code aliases. Account alias cannot match an existing account code or another alias in the system. All alias entries will replace existing ones. Empty or null array will remove all existing aliases. Maximum of 5 aliases, each with a maximum length of 50 characters. Max length of 5 Required (defined) */ accountCodeAliases: Array | null | undefined; /** * Indicates whether the account is a landlord account Required (defined) */ landlordAccount: boolean | null | undefined; /** * The BillCapture bill acquisition method for the account EnergyCap.Shared.Common.Utilities.BillCaptureAccountBillAcquisitionMethod One of 'Customer_Upload', 'Mail_Redirect', 'Web_Download', 'Web_Download_And_Extract_1', 'Web_Download_And_Extract_2', 'EDI', 'Custom_Import', 'Email_Delivery' Required (defined) */ billAcquisitionMethod: string | null | undefined; remitAddress: AddressChildBase | null | undefined; /** * The remit email Must be between 0 and 128 characters Required (defined) */ remitEmail: string | null | undefined; /** * The remit phone number Must be between 0 and 50 characters Required (defined) */ remitPhoneNumber: string | null | undefined; /** * The account code Required Must be between 0 and 50 characters */ accountCode: string | null; /** * The account info Required Must be between 0 and 50 characters */ accountInfo: string | null; /** * The identifier for the cost center to which the account belongs Topmost (CostCenter) Required */ costCenterId: number | null; /** * The identifier for the customer the account serves. This is normally only set for chargeback accounts Required (defined) */ customerId: number | null | undefined; /** * The identifier for the account's contact Required (defined) */ contactId: number | null | undefined; /** * Indicates if the account is active or inactive Required (defined) */ active: boolean | null | undefined; /** * Indicates if the account is used with accruals Required (defined) */ accrualEnabled: boolean | null | undefined; /** * The address postal code Required when country is US or CA Must be between 0 and 32 characters */ postalCode: string | null | undefined; /** * The address city Must be between 0 and 100 characters Required (defined) */ city: string | null | undefined; /** * The address state Must be between 0 and 100 characters Required (defined) */ state: string | null | undefined; /** * The address country Required Must be between 0 and 64 characters */ country: string | null; /** * The address first line Must be between 0 and 100 characters Required (defined) */ line1: string | null | undefined; /** * The address second line Must be between 0 and 100 characters Required (defined) */ line2: string | null | undefined; /** * The address third line Must be between 0 and 100 characters Required (defined) */ line3: string | null | undefined; /** * The date and time the account deposit was paid Required (defined) */ depositPaid: Date | null | undefined; /** * The date and time the account deposit was returned Required (defined) */ depositReturn: Date | null | undefined; /** * A note related to the account deposit Required (defined) */ depositNote: string | null | undefined; /** * The account deposit amount Required (defined) */ depositAmount: number | null | undefined; /** * The account memo Required (defined) */ memo: string | null | undefined; /** * The account's service begin date and time Required (defined) */ serviceStart: Date | null | undefined; /** * The account's service end date and time Must be greater than ServiceStart Required (defined) */ serviceEnd: Date | null | undefined; /** * The identifier for the account's generalLedgerId Required (defined) */ generalLedgerId: number | null | undefined; /** * A description of the account Must be between 0 and 4000 characters Required (defined) */ accountDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GeneralLedgerChild { /** * */ generalLedgerId: number | null | undefined; /** * */ generalLedgerCode: string | null | undefined; /** * */ generalLedgerInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceEntityType { /** * The place entity type identifier */ placeEntityTypeId: number | null | undefined; /** * The place entity type name */ placeEntityTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceTypeResponse { /** * The place type identifier */ placeTypeId: number | null | undefined; /** * The place type code */ placeTypeCode: string | null | undefined; /** * The place type info */ placeTypeInfo: string | null | undefined; /** * Indicates if the place is a structure */ structure: boolean | null | undefined; icon: Icon | null | undefined; placeEntityType: PlaceEntityType | null | undefined; /** * Flag to indicate if the place type is a system-level place type */ isSystemPlaceType: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceChild { placeType: PlaceTypeResponse | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorTypeChild { /** * The vendor type identifier */ vendorTypeId: number | null | undefined; /** * The vendor type code */ vendorTypeCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterChild { /** * The AccountMeter identifier */ accountMeterId: number | null | undefined; /** * The beginning date and time for this AccountMeter relationship */ startDate: Date | null | undefined; /** * The ending date and time for this AccountMeter relationship */ endDate: Date | null | undefined; /** * The Meter identifier for this AccountMeter */ meterId: number | null | undefined; /** * The code of the Meter for this AccountMeter */ meterCode: string | null | undefined; /** * The info of the Meter for this AccountMeter */ meterInfo: string | null | undefined; place: PlaceChild | null | undefined; commodity: CommodityChild | null | undefined; meterGeneralLedger: GeneralLedgerChild | null | undefined; vendorType: VendorTypeChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountRateResponse { /** * The meter tariff identifier */ rateId: number | null | undefined; /** * The rate name */ name: string | null | undefined; /** * The rate code */ rateCode: string | null | undefined; /** * The start date for the rate on the account meter */ startDate: Date | null | undefined; /** * The end date for the rate on the account meter */ endDate: Date | null | undefined; meter: AccountMeterChild | null | undefined; vendor: VendorChild | null | undefined; /** * The rate's note */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterChildWithSerialNumber { /** * The Serial Number of the Meter */ serialNumber: string | null | undefined; /** * The AccountMeter identifier */ accountMeterId: number | null | undefined; /** * The beginning date and time for this AccountMeter relationship */ startDate: Date | null | undefined; /** * The ending date and time for this AccountMeter relationship */ endDate: Date | null | undefined; /** * The Meter identifier for this AccountMeter */ meterId: number | null | undefined; /** * The code of the Meter for this AccountMeter */ meterCode: string | null | undefined; /** * The info of the Meter for this AccountMeter */ meterInfo: string | null | undefined; place: PlaceChild | null | undefined; commodity: CommodityChild | null | undefined; meterGeneralLedger: GeneralLedgerChild | null | undefined; vendorType: VendorTypeChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountTypeChild { /** * The account type identifier */ accountTypeId: number | null | undefined; /** * The account type code */ accountTypeCode: string | null | undefined; /** * The account type info */ accountTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AddressChild { /** * The address type identifier */ addressTypeId: number | null | undefined; /** * Remit To field is the name of the person or company who should receive the payment. It's required for bill pay customers. Must be between 0 and 100 characters */ remitTo: string | null | undefined; /** * The line 1 of the address Must be between 0 and 100 characters */ line1: string | null | undefined; /** * The line 2 of the address Must be between 0 and 100 characters */ line2: string | null | undefined; /** * The line 3 of the address Must be between 0 and 100 characters */ line3: string | null | undefined; /** * The city of the place Must be between 0 and 100 characters */ city: string | null | undefined; /** * The state of the place Must be between 0 and 100 characters */ state: string | null | undefined; /** * The country of the place Must be between 0 and 64 characters */ country: string | null | undefined; /** * The postal code of the place Must be between 0 and 32 characters */ postalCode: string | null | undefined; /** * The latitude of the place Required when the country is not United States or Canada Must be between -90 and 90 Required when Longitude is set */ latitude: number | null | undefined; /** * The longitude of the place Required when the country is not United States or Canada Must be between -180 and 180 Required when Latitude is set */ longitude: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ContactChild { /** * The contact identifier */ contactId: number | null | undefined; /** * The contact's first name */ first: string | null | undefined; /** * The contact's middle name */ middle: string | null | undefined; /** * The contact's last name */ last: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterChild { /** * The cost center identifier */ costCenterId: number | null | undefined; /** * The cost center code */ costCenterCode: string | null | undefined; /** * The cost center info */ costCenterInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CustomerChild { /** * The customer identifier */ customerId: number | null | undefined; /** * The customer code */ customerCode: string | null | undefined; /** * The customer info */ customerInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UnitChild { /** * The unit identifier */ unitId: number | null | undefined; /** * The unit code */ unitCode: string | null | undefined; /** * The unit info */ unitInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountResponse { /** * The account identifier */ accountId: number | null | undefined; /** * The accountmeter identifier for the account */ accountMeterId: number | null | undefined; /** * The account code */ accountCode: string | null | undefined; /** * An array of account code aliases */ accountCodeAliases: Array | null | undefined; /** * The account info */ accountInfo: string | null | undefined; accountType: AccountTypeChild | null | undefined; costCenter: CostCenterChild | null | undefined; vendor: VendorChild | null | undefined; contact: ContactChild | null | undefined; customer: CustomerChild | null | undefined; /** * Indicates whether the Account is active or inactive */ active: boolean | null | undefined; /** * Indicates if this account is used with accruals */ accrualEnabled: boolean | null | undefined; address: AddressChild | null | undefined; /** * The date and time a deposit was paid */ depositPaid: Date | null | undefined; /** * The date and time the account deposit was returned */ depositReturn: Date | null | undefined; /** * A note related to the account deposit */ depositNote: string | null | undefined; /** * The account deposit amount */ depositAmount: number | null | undefined; /** * The account memo */ memo: string | null | undefined; /** * The account's service begin date and time */ serviceStart: Date | null | undefined; /** * The account's service end date and time */ serviceEnd: Date | null | undefined; accountGeneralLedger: GeneralLedgerChild | null | undefined; /** * An array of identifiers for meters attached to this account */ meters: Array | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the account was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; costUnit: UnitChild | null | undefined; /** * Indicates whether the Account has a child calculated meter */ hasCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Account is a recipient of a split */ hasSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Account has a child split meter */ hasSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Account has a sub-account */ hasSubAccount: boolean | null | undefined; accountCodeHistory: AccountCodeHistoryChild | null | undefined; /** * A description of the account */ accountDescription: string | null | undefined; /** * When true, bills for this account will be audited */ auditEnabled: boolean | null | undefined; /** * The data access release identifier for this Account, null if there is no release. */ dataAccessReleaseId: number | null | undefined; /** * Indicates if the DataAccessRelease is approved null if there is no release */ dataAccessReleaseApproved: boolean | null | undefined; remitAddress: AddressChild | null | undefined; /** * The remit email address */ remitEmail: string | null | undefined; /** * The remit phone number */ remitPhoneNumber: string | null | undefined; /** * If there are settings configured to split account charges for this account */ splitAccountChargesConfigured: boolean | null | undefined; summaryAccount: AccountChild | null | undefined; /** * Is this a landlord account? */ landlordAccount: boolean | null | undefined; /** * The BillCapture calculated billing frequency for the account EnergyCap.Shared.Common.Utilities.BillCaptureAccountBillingFrequency */ billingFrequency: string | null | undefined; /** * The BillCapture bill acquisition method for the account EnergyCap.Shared.Common.Utilities.BillCaptureAccountBillAcquisitionMethod */ billAcquisitionMethod: string | null | undefined; /** * The BillCapture anticipated date of the next bill issue date for the account */ billNextIssueDate: Date | null | undefined; /** * The BillCapture anticipated date of the next bill receipt date for the account */ billNextReceiptDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountTemplateResponse { /** * The meter form template identifier */ formTemplateId: number | null | undefined; /** * The template name */ templateInfo: string | null | undefined; /** * The template code */ templateCode: string | null | undefined; /** * The start date for the form template on the account meter */ startDate: Date | null | undefined; /** * The end date for the form template on the account meter */ endDate: Date | null | undefined; /** * The form template's display order */ displayOrder: number | null | undefined; meter: AccountMeterChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataTypeResponse { /** * Required (defined) */ dataTypeId: number | null | undefined; /** * Required (defined) */ dataTypeCode: string | null | undefined; /** * Required (defined) */ dataTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFSelectValueEntityResponse { /** * Required (defined) */ udfSelectValueId: number | null | undefined; /** * Required (defined) */ value: string | null | undefined; /** * Required (defined) */ displayOrder: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFFieldChild { /** * Required (defined) */ udfId: number | null | undefined; dataType: DataTypeResponse | null | undefined; /** * Required (defined) */ name: string | null | undefined; /** * Required (defined) */ description: string | null | undefined; /** * Required (defined) */ displayOrder: number | null | undefined; /** * Required (defined) */ value: string | null | undefined; /** * Required (defined) */ udfSelectValues: Array | null | undefined; /** * Required (defined) */ important: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountUDFResponse { /** * The account identifier */ accountId: number | null | undefined; /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * An array of user-defined fields (UDFs) */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterTypeChild { /** * */ meterTypeId: number | null | undefined; /** * */ meterTypeCode: string | null | undefined; /** * */ meterTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Class derived from MeterChildDTO - has Meter Address and Serial Number This class is used by the Bill Entry Account Searcher */ declare class MeterChildSearch { meterAddress: AddressChild | null | undefined; /** * The meter's previous serial number */ previousSerialNumber: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchAccountMeterBillEntry { /** * The MatchType values - Account - we found a match on account code, account info or previous account code Meter - we found a match on meter code, meter info or serial number AccountAddress - we found a match on account's address - line1, line2, city or state MeterAddress - we found a match on meter's address - line1, line2, city or state */ matchType: string | null | undefined; /** * The Account identifier */ accountId: number | null | undefined; /** * The Account code */ accountCode: string | null | undefined; /** * The Account info */ accountInfo: string | null | undefined; /** * The Previous Account code */ previousAccountCode: string | null | undefined; /** * Indicates whether the Account is active or inactive */ active: boolean | null | undefined; accountType: AccountTypeChild | null | undefined; /** * Indicates whether the Account has a child calculated meter */ hasCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Account is a recipient of a split */ hasSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Account has a child split meter */ hasSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Account is a sub-account */ isSubAccount: boolean | null | undefined; /** * Indicates whether the Account has a sub-account */ hasSubAccount: boolean | null | undefined; vendor: VendorChild | null | undefined; accountAddress: AddressChild | null | undefined; /** * The Account's vendor */ meters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SingleValue { /** * */ value: any | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFValue { /** * udfId of the UDF being edited Required (defined) */ udfId: number | null | undefined; /** * Required (defined) */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateResult { /** * Required (defined) */ selected: number | null | undefined; /** * Required (defined) */ updated: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * DTO for Custom Actions */ declare class WebhookCustomAction { /** * The list of ids on which to perform the custom action Cannot be Empty Required (defined) */ ids: Array | null | undefined; /** * The webhook identifier that represents the custom action Required */ webhookId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookLogDetailsResponse { /** * The URL that the webhook is configured for Required (defined) */ url: string | null | undefined; /** * The request that was sent from the webhook (headers and body) Required (defined) */ request: string | null | undefined; /** * The response that was received from the configured url (headers and body) Required (defined) */ response: string | null | undefined; /** * The HTTP status code that was received from the configured url 0 indicates no response was received from the configured url Required (defined) */ result: string | null | undefined; user: UserChild | null | undefined; } interface ConfigurationParameters { apiKeys?: { [key: string]: string; }; username?: string; password?: string; accessToken?: string; basePath?: string; withCredentials?: boolean; } declare class Configuration { apiKeys: { [key: string]: string; }; username: string; password: string; accessToken: string | (() => string); basePath: string; withCredentials: boolean; constructor(configurationParameters?: ConfigurationParameters); } declare class AccountService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an account * * @param body Data representing the account being created */ createAccount(body?: AccountCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an account alert * * @param accountId The identifier for the account to create alert is on * @param body Data representing the account alert being created */ createAccountAlert(accountId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an account. Currently NO confirmation is required * * @param accountId The identifier for the account being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteAccount(accountId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an account alert. * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to delete */ deleteAccountAlert(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for an account custom field * * @param accountId * @param udfId */ downloadAccountCustomFieldFile(accountId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an account * * @param accountId The identifier for the account being edited * @param body Data representing the account being edited */ editAccount(accountId: number, body?: AccountEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param accountId * @param body */ editAccountCodeVersion(accountId: number, body?: AccountCodeHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular account * * @param accountId The identifier for the account * @param body Data representing the account user defined fields / custom fields being edited */ editAccountUDFs(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one account * * @param accountId The account identifier for the account being retrieved */ getAccount(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an alert for an account * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to return */ getAccountAlert(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all alerts for an account * * @param accountId The identifier for the account */ getAccountAlerts(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets all account audit setting overrides * * @param accountId */ getAccountAuditSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all rates for a particular account * * @param accountId The account identifier for which rate values are being retrieved */ getAccountRates(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates for a particular account * * @param accountId The account identifier for which template values are being retrieved */ getAccountTemplates(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular account * * @param accountId The account identifier for which user defined field / custom field values are being retrieved */ getAccountUdfs(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccounts(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For a given accountId, startDate and endDates for a bill get a billing period recommendation The billing period will be in YYYYMM format YYYY represents the 4 digit year and MM is the two digit month 01 for Jan to 12 for Dec * * @param accountId The identifier for the account for which bill is being created * @param startDate The start date of the bill * @param endDate The end date of the bill */ getDefaultBillingPeriod(accountId: number, startDate?: Date, endDate?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of accounts to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of accountIds to move under the parentCostCenterId */ moveAccount(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom account action. Custom account actions are setup as webhooks * * @param body */ processAccountCustomAction(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Search for accounts Search for accounts whose account code, address, old account code, meter serial number, or meter address contains \"query\" * * @param query The string to search for * @param includeInactiveAccounts Flag to determine if inactive accounts should be included in the search results */ searchAccounts(query?: string, includeInactiveAccounts?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Enable or disable Accounts from audits * * @param body */ setAccountAuditExclusion(body?: AccountAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates an account alert * * @param accountId The identifier for the account the alert to update is on * @param alertId The identifier for the account alert to update * @param body Data representing the account alert being created */ updateAccountAlert(accountId: number, alertId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update audit settings for an account. Every audit must be included but supplying null for its settings will remove them. * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param accountId The account identifier * @param body The new state of the audit settings */ updateAccountAuditSettings(accountId: number, body?: AccountAuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an account * * @param body Data representing the account being created */ createAccountWithHttpInfo(body?: AccountCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an account alert * * @param accountId The identifier for the account to create alert is on * @param body Data representing the account alert being created */ createAccountAlertWithHttpInfo(accountId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an account. Currently NO confirmation is required * * @param accountId The identifier for the account being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteAccountWithHttpInfo(accountId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an account alert. * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to delete */ deleteAccountAlertWithHttpInfo(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for an account custom field * * @param accountId * @param udfId */ downloadAccountCustomFieldFileWithHttpInfo(accountId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an account * * @param accountId The identifier for the account being edited * @param body Data representing the account being edited */ editAccountWithHttpInfo(accountId: number, body?: AccountEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param accountId * @param body */ editAccountCodeVersionWithHttpInfo(accountId: number, body?: AccountCodeHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular account * * @param accountId The identifier for the account * @param body Data representing the account user defined fields / custom fields being edited */ editAccountUDFsWithHttpInfo(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one account * * @param accountId The account identifier for the account being retrieved */ getAccountWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an alert for an account * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to return */ getAccountAlertWithHttpInfo(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all alerts for an account * * @param accountId The identifier for the account */ getAccountAlertsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets all account audit setting overrides * * @param accountId */ getAccountAuditSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all rates for a particular account * * @param accountId The account identifier for which rate values are being retrieved */ getAccountRatesWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates for a particular account * * @param accountId The account identifier for which template values are being retrieved */ getAccountTemplatesWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular account * * @param accountId The account identifier for which user defined field / custom field values are being retrieved */ getAccountUdfsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * For a given accountId, startDate and endDates for a bill get a billing period recommendation The billing period will be in YYYYMM format YYYY represents the 4 digit year and MM is the two digit month 01 for Jan to 12 for Dec * * @param accountId The identifier for the account for which bill is being created * @param startDate The start date of the bill * @param endDate The end date of the bill */ getDefaultBillingPeriodWithHttpInfo(accountId: number, startDate?: Date, endDate?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of accounts to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of accountIds to move under the parentCostCenterId */ moveAccountWithHttpInfo(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom account action. Custom account actions are setup as webhooks * * @param body */ processAccountCustomActionWithHttpInfo(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search for accounts Search for accounts whose account code, address, old account code, meter serial number, or meter address contains \"query\" * * @param query The string to search for * @param includeInactiveAccounts Flag to determine if inactive accounts should be included in the search results */ searchAccountsWithHttpInfo(query?: string, includeInactiveAccounts?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Enable or disable Accounts from audits * * @param body */ setAccountAuditExclusionWithHttpInfo(body?: AccountAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates an account alert * * @param accountId The identifier for the account the alert to update is on * @param alertId The identifier for the account alert to update * @param body Data representing the account alert being created */ updateAccountAlertWithHttpInfo(accountId: number, alertId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update audit settings for an account. Every audit must be included but supplying null for its settings will remove them. * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param accountId The account identifier * @param body The new state of the audit settings */ updateAccountAuditSettingsWithHttpInfo(accountId: number, body?: AccountAuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualMonthlyResponseCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualMonthlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of commodity monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualMonthlyResponse { /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * The account identifier */ accountId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data per commodity */ commodities: Array | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountDigestActualYearlyResponse { /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * The account identifier */ accountId: number | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } declare class AccountDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getAccountActualMonthly(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getAccountActualYearly(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getAccountActualMonthlyWithHttpInfo(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getAccountActualYearlyWithHttpInfo(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterEdit { /** * The beginning date and time for this account meter relationship Must be between 1899-12-31 and 3000-01-01 Required (defined) */ beginDate: Date | null | undefined; /** * The ending date and time for this account meter relationship Must be greater than BeginDate Must be between 1899-12-31 and 3000-01-01 Required (defined) */ endDate: Date | null | undefined; /** * The identifier for the general ledger assigned to this account meter Required (defined) */ generalLedgerId: number | null | undefined; /** * The identifier for the vendor type. Vendors may assume different types on different account meters Required (defined) */ vendorTypeId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterRateResponse { /** * The account meter tariff identifier Required (defined) */ rateId: number | null | undefined; /** * The rate name Required (defined) */ name: string | null | undefined; /** * The rate code Required (defined) */ rateCode: string | null | undefined; /** * The rate's note Required (defined) */ note: string | null | undefined; /** * The start date for the rate on the account meter Required (defined) */ startDate: Date | null | undefined; /** * The end date for the rate on the account meter Required (defined) */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterRequest { /** * The account identifier for this account meter Required Topmost (Account) */ accountId: number | null; /** * The meter identifier for this account meter Required Topmost (Meter) */ meterId: number | null; /** * The beginning date and time for this account meter relationship Defaults to 1899-01-01 */ beginDate: Date | null | undefined; /** * The ending date and time for this account meter relationship Defaults to 3000-01-01 */ endDate: Date | null | undefined; /** * The identifier for the general ledger assigned to this account meter */ generalLedgerId: number | null | undefined; /** * The identifier for the vendor type. Vendors may assume different types on different account meters */ vendorTypeId: number | null | undefined; /** * Indicates if the account meter is deregulated */ deregulated: boolean | null | undefined; /** * The account meter template to be used for bill entry Optional. If passed in, the templateId will be used. If not passed If vendortypeid is 2 (supplier), --then a template on this meter's commodity with code that starts with S_meter's use unit code will be used --if not found we will try to use a template on this meter's commodity with code that starts with S_ --If not found we will use a non-supplier template described below If vendortype is non- supplier -- the template will be defaulted using the meter's assigned use and demand units --First try and match template by commodityId, useUnitId, demandUnitId --If no match try commodityId, useUnitId --If no match select the first use only template that matches on commodity --If no match find the first template on this commodity --If none is found no template will be assigned */ templateId: number | null | undefined; /** * Indicates if the account meter rate Required */ rateId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateChild { /** * */ rateId: number | null | undefined; /** * */ name: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountRateChild { rate: RateChild | null | undefined; /** * */ startDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemplateChild { /** * */ templateId: number | null | undefined; /** * */ templateCode: string | null | undefined; /** * */ templateInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FormTemplateChild { /** * */ formTemplateId: number | null | undefined; /** * */ displayOrder: number | null | undefined; template: TemplateChild | null | undefined; /** * */ beginDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterChild { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountMeterResponse { /** * The account meter identifier Required (defined) */ accountMeterId: number | null | undefined; account: AccountChild | null | undefined; meter: MeterChild | null | undefined; /** * The beginning date and time for this account meter relationship Required (defined) */ beginDate: Date | null | undefined; /** * The ending date and time for this account meter relationship Required (defined) */ endDate: Date | null | undefined; generalLedger: GeneralLedgerChild | null | undefined; vendorType: VendorTypeChild | null | undefined; /** * Indicates if the account meter is deregulated Required (defined) */ deregulated: boolean | null | undefined; /** * The template assigned to this account meter Required (defined) */ formTemplates: Array | null | undefined; /** * The rate assigned to this account meter Required (defined) */ rates: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountRateRequest { /** * The identifier for the rate to assign to the accountMeter Required Required */ rateId: number | null; /** * The start date for the accountRate Required Required */ startDate: Date | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FormTemplateRequest { /** * The identifier for the template being assigned Required Required */ templateId: number | null; /** * The begin date of the template assignment Required Required */ beginDate: Date | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FormTemplateResponse { /** * The identifier for the template assignment Required (defined) */ formTemplateId: number | null | undefined; template: TemplateChild | null | undefined; /** * The display order for the bill entry screen Required (defined) */ displayOrder: number | null | undefined; /** * The begin date of the template assignment Required (defined) */ beginDate: Date | null | undefined; /** * The end date of the template assignment Required (defined) */ endDate: Date | null | undefined; } declare class AccountMeterService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Links an account and meter together Meters must be linked to an active account to be usable in EnergyCAP Once an account and meter are created individually, they must be linked with this API * * @param body Data representing the account and meter being linked */ createAccountMeter(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an AccountRate Relationship. Linking AccountMeter and Rate * * @param accountMeterId * @param body */ createAccountRate(accountMeterId: number, body?: AccountRateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Assigns a new template to an account meter. The new template's begin date must be after the begin date of all existing template assignments * * @param accountMeterId * @param body */ createFormTemplate(accountMeterId: number, body?: FormTemplateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an account meter * * @param accountMeterId * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter WARNING: Bills for this account include other meters. The ENTIRE bill is deleted. This flag can only be true when: There is a single relationship between the specified account and meter */ deleteAccountMeter(accountMeterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an template assignment from an account meter If we are deleting a template assignment in the middle of two other template assignments, then we will move back the next template's start date If we are deleting the last template(current template), the extend second last template's end date to match the account meter's end date If we are deleting the first template pull the second template's begin date to match account meter's begin date * * @param accountMeterId * @param formTemplateId */ deleteTemplateAssignment(accountMeterId: number, formTemplateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an account meter relationship * * @param accountMeterId The id of the account meter record to edit * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter and a bill start date greater than or equal to the new account and meter relationship end date. WARNING: Bills for this account may include other meters. The ENTIRE bill is deleted. This flag can only be true when: Editing the most recent relationship between this account and meter The end date has been changed but not the begin date * @param body Data used to update the account and meter */ editAccountMeter(accountMeterId: number, deleteBills?: boolean, body?: AccountMeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit all AccountRate relationships * * @param accountMeterId * @param body */ editAccountRateList(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all FormTemplate relationships * * @param accountMeterId * @param body */ editFormTemplateList(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Links an account and meter together Meters must be linked to an active account to be usable in EnergyCAP Once an account and meter are created individually, they must be linked with this API * * @param body Data representing the account and meter being linked */ createAccountMeterWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Creates an AccountRate Relationship. Linking AccountMeter and Rate * * @param accountMeterId * @param body */ createAccountRateWithHttpInfo(accountMeterId: number, body?: AccountRateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Assigns a new template to an account meter. The new template's begin date must be after the begin date of all existing template assignments * * @param accountMeterId * @param body */ createFormTemplateWithHttpInfo(accountMeterId: number, body?: FormTemplateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an account meter * * @param accountMeterId * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter WARNING: Bills for this account include other meters. The ENTIRE bill is deleted. This flag can only be true when: There is a single relationship between the specified account and meter */ deleteAccountMeterWithHttpInfo(accountMeterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an template assignment from an account meter If we are deleting a template assignment in the middle of two other template assignments, then we will move back the next template's start date If we are deleting the last template(current template), the extend second last template's end date to match the account meter's end date If we are deleting the first template pull the second template's begin date to match account meter's begin date * * @param accountMeterId * @param formTemplateId */ deleteTemplateAssignmentWithHttpInfo(accountMeterId: number, formTemplateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an account meter relationship * * @param accountMeterId The id of the account meter record to edit * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter and a bill start date greater than or equal to the new account and meter relationship end date. WARNING: Bills for this account may include other meters. The ENTIRE bill is deleted. This flag can only be true when: Editing the most recent relationship between this account and meter The end date has been changed but not the begin date * @param body Data used to update the account and meter */ editAccountMeterWithHttpInfo(accountMeterId: number, deleteBills?: boolean, body?: AccountMeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all AccountRate relationships * * @param accountMeterId * @param body */ editAccountRateListWithHttpInfo(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit all FormTemplate relationships * * @param accountMeterId * @param body */ editFormTemplateListWithHttpInfo(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccrualProcessorRequest { /** * The batch to create for accrual bills Required Must be between 0 and 255 characters */ batchCode: string | null; /** * Use a safety net for accrued cost calculation? - if we have usage and we are using an average unit cost safety net and the most recent unit cost does not vary more than the specified percentage from the historical average unit cost, accrued cost = accrued use * most recent unit cost - if we have usage and we are not using an average unit cost safety net or the most recent unit cost does vary more than the specified percentage from the historical average unit cost, accrued cost = accrued use * average historical unit cost - if we don't have usage, accrued cost = historical average cost per day * number of days in accrual period Required */ aucSafetyNet: boolean | null; /** * Percent of cost variance allowed when using average unit cost safety net Required when AucSafetyNet is set to True, case sensitive. */ aucPercentVarianceAllowed: number | null | undefined; /** * End date for accrual bills generated Required */ accrualPeriodEndDate: Date | null; /** * Earliest bill end date to begin accruing from (end dates become begin dates for accrued bills) Required */ accrualPeriodMinimumStartDate: Date | null; /** * Billing period calculation method. Valid values are \"bill midpoint\" and \"manual\". One of 'bill midpoint', 'manual' Case sensitive Required */ billingPeriodCalculationMethod: string | null; /** * Fixed billing period for accrual bills generated when billing period calculation method is manual. Required when BillingPeriodCalculationMethod is set to manual, case sensitive. Must be between 190001 and 209912 */ manualBillingPeriod: number | null | undefined; /** * Account period calculation method. Valid values are \"blank\", \"billing period\" and \"manual\". One of 'blank', 'billing period', 'manual' Case sensitive Required */ accountPeriodCalculationMethod: string | null; /** * Fixed account period for accrual bills generated when account period calculation method is manual. Required when AccountPeriodCalculationMethod is set to manual, case sensitive. Must be between 190001 and 209913 */ manualAccountPeriod: number | null | undefined; /** * Generate accrual bills in test mode? Test mode bills are created as voided bills. Required */ testMode: boolean | null; /** * Optional percentage for cost adjustment. It can be positive or negative. */ percentCostAdjustment: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccrualSettingsResponse { /** * Accrual method to employ. Valid values are: simple - cost per day from the most recent bill use history - unit cost based on historical bills (if AUC safety net used, use the most recent bill if the unit cost is within the safety net percentage, otherwise use a historical average of the last three years from the same period), or average cost per day if no usage */ accrualMethod: string | null | undefined; /** * Use an average unit cost safety net (apply to most recent bill unit cost) */ aucSafetyNet: boolean | null | undefined; /** * Average unit cost safety net percentage */ aucSafetyNetPercentage: number | null | undefined; /** * Default filter to use when selecting most recent bills. Valid value are: non-void - select any non-void bill approved - select only approved bills apexported - select AP exported bills non-exporthold - select bills not held from AP export */ accrualBillFilter: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GuidResponse { /** * A guid that identifies the current task */ taskGUId: string | null | undefined; } declare class AccrualService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete all bills created by the Accrual task If any bills have already been exported they will still be deleted * * @param taskId Identifier for the accrual task */ deleteAccrualTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get Accrual settings * */ getAccrualSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run the accrual processor engine using the supplied settings to generate accrual bills * * @param filter Accrual data selection filters * @param body Accrual processor settings */ processAccruals(filter?: string, body?: AccrualProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void all bills created by the Accrual task If any bills have already been exported they will still be voided * * @param taskId Identifier for the accrual task */ voidAccrualTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by the Accrual task If any bills have already been exported they will still be deleted * * @param taskId Identifier for the accrual task */ deleteAccrualTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Accrual settings * */ getAccrualSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run the accrual processor engine using the supplied settings to generate accrual bills * * @param filter Accrual data selection filters * @param body Accrual processor settings */ processAccrualsWithHttpInfo(filter?: string, body?: AccrualProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by the Accrual task If any bills have already been exported they will still be voided * * @param taskId Identifier for the accrual task */ voidAccrualTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Activity { /** * */ id: number | null | undefined; /** * */ reason: string | null | undefined; } declare class ActivityService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * List of a bill IDs that were created or modified since the given date. * * @param date Created or modified datetime; Defaults to yesterday at the current time */ getBillActivity(date?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * List of a bill IDs that were created or modified since the given date. * * @param date Created or modified datetime; Defaults to yesterday at the current time */ getBillActivityWithHttpInfo(date?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountPeriodResponse { /** * The account period identifier */ accountPeriodId: number | null | undefined; /** * The period number */ periodNumber: number | null | undefined; /** * The name of the period */ name: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountPeriodRequest { /** * The period number When submitted with a list of other account periods, there cannot be more than one account period with the same periodNumber Must be between 1 and 12 Required (defined) */ periodNumber: number | null | undefined; /** * The name of the period Max length of 32 Required (defined) */ name: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountingSettingsRequest { /** * First month of fiscal year Must be between 1 and 12 Required (defined) */ fiscalYearStartMonth: number | null | undefined; /** * Fiscal year reflects the calendar year in which it Begins or Ends One of 'beginning', 'ending' Case sensitive Required (defined) */ fiscalYearDefinedAtYear: string | null | undefined; /** * Calendarization method Value will be one of \"monthly\", \"user-defined\" One of 'monthly', 'user-defined' Case sensitive Required (defined) */ calendarizationMethod: string | null | undefined; /** * List of accounting period names Required (defined) */ accountPeriods: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountingSettingsResponse { /** * First month of fiscal year Value will be from 1-12 */ fiscalYearStartMonth: number | null | undefined; /** * Fiscal year reflects the calendar year in which it Begins or Ends Value will be one of \"beginning\", \"ending\" */ fiscalYearDefinedAtYear: string | null | undefined; /** * Calendarization method Value will be one of \"monthly\", \"user-defined\" */ calendarizationMethod: string | null | undefined; /** * List of accounting period names */ accountPeriods: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AdminSettingsRequest { /** * The setting field Required Must be between 0 and 32 characters */ fieldName: string | null; /** * The setting value Must be between 0 and 255 characters Required (defined) */ value: string | null | undefined; /** * The setting's data type identifier. Possible value include 1 (boolean), 2 (integer), 3 (string), 4 (double), 6 (date) Required One of '1', '2', '3', '4', '6' Case sensitive */ dataTypeId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AdminSettingsResponse { /** * The setting field */ fieldName: string | null | undefined; /** * The setting value */ value: string | null | undefined; dataType: DataTypeResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseRequest { /** * User's license validation key. Required (defined) */ validationKey: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountOrMeterUsage { /** * Number of chargeback accounts or meters. */ chargeback: number | null | undefined; /** * Number of non-chargeback accounts or meters. */ nonChargeback: number | null | undefined; /** * Number of inactive accounts or meters. */ inactive: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillUsage { /** * Number of bills that are manually entered. */ manuallyEntered: number | null | undefined; /** * Number of bills that are imported. */ imported: number | null | undefined; /** * Number of bills that are chargeback. */ chargeback: number | null | undefined; /** * Number of bills that have accrued. */ accrual: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatures { /** * Whether accounting export is available on the user's the license. */ accountingExport: boolean | null | undefined; /** * Whether bill accruals are available on the user's license. */ billAccruals: boolean | null | undefined; /** * Whether chargebacks are available on the user's license. */ chargebacks: boolean | null | undefined; /** * Whether cost avoidance is available on the user's license. */ costAvoidance: boolean | null | undefined; /** * Whether custom benchmarks are available on the user's license. */ customBenchmarks: boolean | null | undefined; /** * Whether interval data analysis is available on the user's license. */ intervalDataAnalysis: boolean | null | undefined; /** * Whether report designer is available on the user's license. */ reportDesigner: boolean | null | undefined; /** * Whether report distribution is available on the user's license. */ reportDistribution: boolean | null | undefined; /** * Whether CarbonHub Standard is available on the user's license. */ ghg: boolean | null | undefined; /** * Whether CarbonHub Premium is available on the user's license. */ ghgPremium: boolean | null | undefined; /** * Whether Legacy GHG features are available on the user's license. */ ghgLegacy: boolean | null | undefined; /** * Whether Budgets is available on the user's license */ budgets: boolean | null | undefined; /** * Whether EnergyCAP Payments is available on the user's license */ energyCAPPayments: boolean | null | undefined; /** * Whether Bill CAPture Managed Services is available on the user's license */ billCAPtureManagedServices: boolean | null | undefined; /** * Whether CarbonHub is available on the user's license */ carbonHub: boolean | null | undefined; /** * Whether Interval Data Managed Services is available on the user's license */ intervalData: boolean | null | undefined; /** * Whether Bill CAPture PrePay is available on the user's license */ billCapturePrePay: boolean | null | undefined; /** * Whether Bill CAPture PostPay is available on the user's license */ billCapturePostPay: boolean | null | undefined; /** * Whether Bill CAPture NonEnglish Bills is available on the user's license */ nonEnglishBills: boolean | null | undefined; /** * Whether Vendor Management Services is available on the user's license */ vendorManagementServices: boolean | null | undefined; /** * Whether UIDI is available on the user's license */ uIdI: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseUsage { /** * Purchased allotment of licensed items */ purchased: number | null | undefined; /** * Number of active licenses */ active: number | null | undefined; /** * Number of inactive licenses */ inactive: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseResponse { /** * User's license validation key. */ validationKey: string | null | undefined; /** * User's license expiration date. */ expirationDate: Date | null | undefined; /** * Number of licensed meters for this user. */ licensedMeters: number | null | undefined; /** * The user number. */ userNumber: string | null | undefined; /** * EnergyCAP version on this license. */ version: string | null | undefined; /** * Additional notes related to the license. */ notes: string | null | undefined; meterUsage: AccountOrMeterUsage | null | undefined; accountUsage: AccountOrMeterUsage | null | undefined; billsCreatedLast30Days: BillUsage | null | undefined; billsCreatedLast12Months: BillUsage | null | undefined; licenseFeatures: LicenseFeatures | null | undefined; /** * Application SKU as set in the license code for UtilityManagement. Possible values are: SaaS (Express), Professional, Online (Enterprise), ConsultantPlatform, ConsultantPlatformPlus, UtilityCompanyPlatform, and Other. */ utilityManagementSKU: string | null | undefined; emissionSourcesScope1And2Usage: LicenseUsage | null | undefined; emissionSourcesScope3Usage: LicenseUsage | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportingSettingRequest { /** * The energy unit identifier Required (defined) */ energyUnitId: number | null | undefined; /** * The cost unit identifier Required (defined) */ costUnitId: number | null | undefined; /** * The floor area unit identifier Required (defined) */ floorAreaUnitId: number | null | undefined; /** * Months to exclude from charts, including the current month. Ex. If the current month is October, A value of 0 will not exclude any months, A value of 1 will exclude the month of October, A value of 2 will exclude October and September, A value of 3 will exclude October, September, and August, A value of 13 will exclude October and the last full year of data. Must be between 0 and 13 Required (defined) */ monthsToExcludeFromCharts: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportingSettingResponse { energyUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; floorAreaUnit: UnitChild | null | undefined; /** * Months to exclude from charts, including the current month. Ex. If the current month is October, A value of 0 will not exclude any months, A value of 1 will exclude the month of October, A value of 2 will exclude October and September, A value of 3 will exclude October, September, and August, A value of 13 will exclude October and the last full year of data. */ monthsToExcludeFromCharts: number | null | undefined; /** * For internal use only. The task GUID of cost reporting unit post processing, only set when the cost reporting unit is changed in the Edit Reporting Settings API. */ costReportingUnitTaskGUId: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SystemSettingsRequest { /** * Default topmost space ID for new users Required (defined) */ defaultTopmostSpaceId: number | null | undefined; /** * Cut over date when EnergyCAP officially takes over bill payments. In order to modify this date, the user needs to have Special Permission (ECAP) and LicenseFeatureEnergyCAPPayments. It's not possible to change the field to null since the value is mandatory for (ECAP) and LicenseFeatureEnergyCAPPayments. For non (ECAP) and/or non LicenseFeatureEnergyCAPPayments users, use null or inform same value provided in the GET endpoint. Required (defined) */ billPayCutoverEndDate: Date | null | undefined; /** * Default topmost collection ID for new users Required (defined) */ defaultTopmostCollectionId: number | null | undefined; /** * The organization name Required (defined) */ organizationName: string | null | undefined; /** * Indicates whether or not organization name should be displayed in the application header Required */ displayOrganizationNameInHeader: boolean | null; /** * The organization logo May be a base64-encoded PNG, JPG, or SVG image or a URI for an image hosted online A null value will clear the saved image Min length of 5 Required (defined) */ organizationLogo: string | null | undefined; /** * Number of minutes after which users will be automatically logged out Must be between 10 and 780 Required (defined) */ automaticLogoutMinutes: number | null | undefined; /** * Default country for new users Required (defined) */ defaultCountry: string | null | undefined; /** * ID of the default time zone for new meters Required */ defaultMeterTimeZoneId: number | null; /** * Default date format for new users One of 'MM/dd/yyyy', 'dd/MM/yyyy' Case sensitive Required (defined) */ defaultDateFormat: string | null | undefined; /** * Default topmost cost center ID for new users Required (defined) */ defaultTopmostCostCenterId: number | null | undefined; /** * Default topmost place ID for new users Required (defined) */ defaultTopmostPlaceId: number | null | undefined; /** * Default user role ID for new users Required (defined) */ defaultUserRoleId: number | null | undefined; /** * Months to exclude from charts, including the current month. Set to 2 months by default. Ex. If the current month is October, A value of 0 will not exclude any months, A value of 1 will exclude the month of October, A value of 2 will exclude October and September, A value of 3 will exclude October, September, and August, A value of 13 will exclude October and the last full year of data. A null value will preserve the existing setting. Must be between 0 and 13 Required (defined) */ monthsToExcludeFromCharts: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CollectionChild { /** * The collection identifier */ collectionId: number | null | undefined; /** * The collection code */ collectionCode: string | null | undefined; /** * The collection info */ collectionInfo: string | null | undefined; collectionIcon: Icon | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SystemUserRoleChild { /** * The user role identifier */ userRoleId: number | null | undefined; /** * The user role name */ userRoleInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeZoneResponse { /** * The time zone id */ timeZoneId: number | null | undefined; /** * The time zone code */ timeZoneCode: string | null | undefined; /** * The time zone info */ timeZoneInfo: string | null | undefined; /** * The time zone gmt offset */ gmtOffset: number | null | undefined; /** * Indicates if the time zone observes daylight savings time or not */ daylightSavingsObserved: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SystemSettingsResponse { /** * The organization name */ organizationName: string | null | undefined; /** * Indicates whether or not organization name should be displayed in the application header */ displayOrganizationNameInHeader: boolean | null | undefined; /** * The organization logo May be a base64-encoded PNG, JPG, or SVG image or a URI for an image hosted online A null value will clear the saved image */ organizationLogo: string | null | undefined; /** * Number of minutes after which users will be automatically logged out */ automaticLogoutMinutes: number | null | undefined; /** * Default country for new users */ defaultCountry: string | null | undefined; defaultMeterTimeZone: TimeZoneResponse | null | undefined; /** * Default date format for new users */ defaultDateFormat: string | null | undefined; defaultTopmostPlace: PlaceChild | null | undefined; defaultCostCenter: CostCenterChild | null | undefined; defaultCollection: CollectionChild | null | undefined; defaultTopmostSpace: PlaceChild | null | undefined; defaultUserRole: SystemUserRoleChild | null | undefined; /** * Number of months to exclude from powerview charts */ monthsToExcludeFromCharts: number | null | undefined; /** * Cut over date when EnergyCAP officially takes over bill payments */ billPayCutoverEndDate: Date | null | undefined; } declare class AdminService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit accounting settings * * @param body */ editAccountingSettings(body?: AccountingSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the license details. * * @param body */ editLicenseDetails(body?: LicenseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit system settings * * @param body */ editSystemSettings(body?: SystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the list of account periods * */ getAccountPeriods(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get accounting settings * */ getAccountingSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get license details. * */ getLicenseDetails(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve the organization logo, if configured. Only URLs or JPEG, PNG, and SVG images are acceptable organization logos. If the saved base64 image is of a different file type, it will return an error. * */ getOrganizationLogo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the system reporting settings * */ getReportingSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ getSystemSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get system settings * */ getSystemSettingsNew(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fire a custom application action webhook * * @param webhookId The identifier for the webhook being fired */ processCustomAppAction(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Set the system reporting settings * * @param body */ setReportingSettings(body?: ReportingSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ updateSystemSettings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit accounting settings * * @param body */ editAccountingSettingsWithHttpInfo(body?: AccountingSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the license details. * * @param body */ editLicenseDetailsWithHttpInfo(body?: LicenseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit system settings * * @param body */ editSystemSettingsWithHttpInfo(body?: SystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the list of account periods * */ getAccountPeriodsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get accounting settings * */ getAccountingSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get license details. * */ getLicenseDetailsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve the organization logo, if configured. Only URLs or JPEG, PNG, and SVG images are acceptable organization logos. If the saved base64 image is of a different file type, it will return an error. * */ getOrganizationLogoWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the system reporting settings * */ getReportingSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * */ getSystemSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get system settings * */ getSystemSettingsNewWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fire a custom application action webhook * * @param webhookId The identifier for the webhook being fired */ processCustomAppActionWithHttpInfo(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Set the system reporting settings * * @param body */ setReportingSettingsWithHttpInfo(body?: ReportingSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param body */ updateSystemSettingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FilterResponse { /** * The list of available operators Required (defined) */ availableOperator: Array | null | undefined; /** * The caption of the filter Required (defined) */ caption: string | null | undefined; /** * The Query parameter name Required (defined) */ queryParameterName: string | null | undefined; /** * The field identifier Required (defined) */ fieldId: number | null | undefined; /** * The datafield identifier Required (defined) */ dataFieldId: number | null | undefined; dataType: DataTypeResponse | null | undefined; /** * The operator Required (defined) */ operator: string | null | undefined; /** * The value of the filter Required (defined) */ value: string | null | undefined; /** * Indicates if the filter is required */ required: boolean | null | undefined; /** * Indicates if the filter is recommended Required (defined) */ recommended: boolean | null | undefined; /** * Indicates if the filter is hidden Required (defined) */ hidden: boolean | null | undefined; } declare class ApiService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get filters for an API * * @param apiId The api Id */ getApiFilters(apiId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get filters for an API * * @param apiId The api Id */ getApiFiltersWithHttpInfo(apiId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApiKeyCreateRequest { /** * The name of the API key Required Must be between 0 and 60 characters */ apiKeyName: string | null; /** * A description for the API key */ apiKeyDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApiKeyCreateResponse { /** * The API key. This value cannot be retrieved again after it is created. */ apiKey: string | null | undefined; /** * The identifier of the API key */ apiKeyId: number | null | undefined; /** * The name of the API key */ apiKeyName: string | null | undefined; /** * A description of the API key */ apiKeyDescription: string | null | undefined; createdBy: UserChild | null | undefined; /** * The API key creation date */ createdDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApiKeyEditRequest { /** * The name of the API key Required Must be between 0 and 60 characters */ apiKeyName: string | null; /** * A description for the API key Required (defined) */ apiKeyDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApiKeyResponse { /** * The identifier of the API key */ apiKeyId: number | null | undefined; /** * The name of the API key */ apiKeyName: string | null | undefined; /** * A description of the API key */ apiKeyDescription: string | null | undefined; createdBy: UserChild | null | undefined; /** * The API key creation date */ createdDate: Date | null | undefined; } declare class ApiKeyService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new API key * * @param body */ createApiKey(body?: ApiKeyCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an API key * * @param apiKeyId */ deleteApiKey(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the name and description of an api key * * @param apiKeyId * @param body */ editApiKey(apiKeyId: number, body?: ApiKeyEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get an API key * * @param apiKeyId */ getApiKey(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all available API keys * * @param filter */ getApiKeys(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new API key * * @param body */ createApiKeyWithHttpInfo(body?: ApiKeyCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an API key * * @param apiKeyId */ deleteApiKeyWithHttpInfo(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the name and description of an api key * * @param apiKeyId * @param body */ editApiKeyWithHttpInfo(apiKeyId: number, body?: ApiKeyEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an API key * * @param apiKeyId */ getApiKeyWithHttpInfo(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available API keys * * @param filter */ getApiKeysWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommoditySkipAuditSettingRequest { /** * Required (defined) */ commoditiesToSkip: Array | null | undefined; /** * The status of the audit setting One of 'Check', 'Hold', 'Skip' Required (defined) */ settingStatus: string | null | undefined; /** * Minimum Bill/Meter Cost. This audit will run only when the cost meets the specified minimum cost Required (defined) */ minimumCost: number | null | undefined; /** * List of Assignees. Ids of the users the flag should get assigned to when the audit fails. Required (defined) */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AuditSettingsRequest { currencyUnitAnalysis: AuditSettingRequest | null; multipleUseUnitAnalysis: AuditSettingRequest | null; billUseUnitDifferentFromMeterAnalysis: AuditSettingRequest | null; billContainsLineItemDescriptions: BillContainsLineItemDescriptionsSettingRequest | null; billContainsLineItemTypes: BillContainsLineItemTypesSettingRequest | null; totalBillCostDoesNotMatchLineItemTypes: TotalBillCostDoesNotMatchLineItemTypesSettingRequest | null; billingPeriodOutsideStartEndDates: AuditSettingRequest | null; billOverlapsWithOtherAccountBill: CommoditySkipAuditSettingRequest | null; gapBetweenBillAndPreviousBillOnAccount: CommoditySkipAuditSettingRequest | null; billEndsInFuture: AuditSettingRequest | null; accountHasMultipleBillsInBillingPeriod: CommoditySkipAuditSettingRequest | null; statementDateBeforeEndDate: AuditSettingRequest | null; dueDateBeforeEndDate: AuditSettingRequest | null; billSignificantlyShorterOrLongerThanPrevious: BillSignificantlyShorterOrLongerThanPreviousSettingRequest | null; tooManyConsecutiveEstimatedBills: TooManyConsecutiveEstimatedBillsSettingRequest | null; dueDateTooLongAfterBillEnd: DueDateTooLongAfterBillEndSettingRequest | null; statementDateTooLongAfterBillEnd: StatementDateTooLongAfterBillEndSettingRequest | null; invoiceNumberIsRepeatedOnAccount: AuditSettingRequest | null; likelyDuplicateBillOnAccount: AuditSettingRequest | null; totalMeterCostIsPercentageHigherThanPastYear: AuditSettingRequest | null; totalMeterUseIsPercentageHigherThanPastYear: AuditSettingRequest | null; serialNumberDoesNotMatchImportFile: AuditSettingRequest | null; rateCodeDoesNotMatchImportFile: AuditSettingRequest | null; importFileStartDateAdjustedToPreventGaps: AuditSettingRequest | null; accountAlertExistsOnAccountInImportFile: AuditSettingRequest | null; abnormalBillCostWithOutlierAnalysis: AbnormalBillCostWithOutlierAnalysisSettingRequest | null; abnormalBillUseWithOutlierAnalysis: AbnormalBillUseWithOutlierAnalysisSettingRequest | null; abnormalBillDemandWithOutlierAnalysis: AbnormalBillDemandWithOutlierAnalysisSettingRequest | null; } declare class AuditService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Gets all audit settings * */ getAuditSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param rerunResolvedIssues When true, resolved issues can be re-flagged. When false, resolved issues are not re-flagged. Defaults to true. * @param body The list of bills to audit */ rerunAudits(rerunResolvedIssues?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param body The list of bills to audit */ rerunAudits_1(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update audit settings * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param body The new state of the audit settings */ updateAuditSettings(body?: AuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets all audit settings * */ getAuditSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param rerunResolvedIssues When true, resolved issues can be re-flagged. When false, resolved issues are not re-flagged. Defaults to true. * @param body The list of bills to audit */ rerunAuditsWithHttpInfo(rerunResolvedIssues?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param body The list of bills to audit */ rerunAudits_1WithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update audit settings * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param body The new state of the audit settings */ updateAuditSettingsWithHttpInfo(body?: AuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LoginRequest { /** * Datasource Required */ dataSource: string | null; /** * Password Required */ password: string | null; /** * Username Required */ username: string | null; /** * OPTIONAL - Partition Usually this is the environment, Staging, Pro, Web. An empty or NULL partition will result in all partitions being scanned. */ partition: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApiUser { /** * */ userName: string | null | undefined; /** * */ fullName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LoginResponse { /** * */ token: string | null | undefined; user: ApiUser | null | undefined; } declare class AuthenticationService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * */ beta(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable<{ [key: string]: boolean; }>; /** * My.EnergyCap.Com needs a way to get a token from a partition name. Pass in a partition, create and return a token for provided partition. * * @param partition */ createTokenForPartition(partition?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ login(body?: LoginRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Logout user- if they were logged in using a cookie * */ logout(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ betaWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * My.EnergyCap.Com needs a way to get a token from a partition name. Pass in a partition, create and return a token for provided partition. * * @param partition */ createTokenForPartitionWithHttpInfo(partition?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param body */ loginWithHttpInfo(body?: LoginRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Logout user- if they were logged in using a cookie * */ logoutWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchCreate { /** * The batch code Required Must be between 0 and 255 characters */ batchCode: string | null; /** * If user has other batches open, should they be closed? */ closeExistingBatch: boolean | null | undefined; /** * Statement date for batch - will get applied as default to any bill added to this batch */ statementDate: Date | null | undefined; /** * Due date for batch - will get applied as default to any bill added to this batch */ dueDate: Date | null | undefined; /** * Next reading date for batch - will get applied as default to any bill added to this batch */ nextReading: Date | null | undefined; /** * Control code for batch - will get applied as default to any bill added to this batch Must be between 0 and 255 characters */ controlCode: string | null | undefined; /** * Invoice number for batch - will get applied as default to any bill added to this batch Must be between 0 and 255 characters */ invoiceNumber: string | null | undefined; /** * Account period number for batch - will get applied as default to any bill added to this batch */ accountPeriodNumber: number | null | undefined; /** * Accountperiod year for batch - will get applied as default to any bill added to this batch Must be between 1900 and 2099 */ accountPeriodYear: number | null | undefined; /** * Note/comment for batch Must be between 0 and 255 characters */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchEdit { /** * The batch code Required Must be between 0 and 255 characters */ batchCode: string | null; /** * Note/comment for batch Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchChild { /** * The batch id. */ batchId: number | null | undefined; /** * The batch code. */ batchCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SourceBatchLogResponse { targetBatch: BatchChild | null | undefined; /** * Unique identifier for the operation that moved the bills. There can be multiple bills moved in a single operation, so this ID is the same for all bills moved in that operation. */ moveOperationId: string | null | undefined; /** * Date/time offset of the operation */ createdDate: Date | null | undefined; /** * Bill IDs that were moved in this operation. */ billIds: Array | null | undefined; createdBy: UserChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TargetBatchLogResponse { sourceBatch: BatchChild | null | undefined; /** * Unique identifier for the operation that moved the bills. There can be multiple bills moved in a single operation, so this ID is the same for all bills moved in that operation. */ moveOperationId: string | null | undefined; /** * Date/time offset of the operation */ createdDate: Date | null | undefined; /** * Bill IDs that were moved in this operation. */ billIds: Array | null | undefined; createdBy: UserChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchLogResponse { /** * The batch identifier */ batchId: number | null | undefined; /** * Logs of bills that were added to this batch from another batch. */ billsAddedFromLogs: Array | null | undefined; /** * Logs of bills that were moved from this batch to another batch. */ billsMovedToLogs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchResponse { /** * The batch identifier */ batchId: number | null | undefined; /** * The batch code */ batchCode: string | null | undefined; /** * Is the batch open */ isOpen: boolean | null | undefined; /** * The status of the batch (open, pending, closed) */ batchStatus: string | null | undefined; /** * The date when the batch was created */ startDate: Date | null | undefined; /** * The date when the batch was closed */ endDate: Date | null | undefined; /** * The number of bills in this batch */ billCount: number | null | undefined; /** * The cost of all bills in this batch */ runningTotal: number | null | undefined; /** * Statement date batch setting */ statementDate: string | null | undefined; /** * Due date batch setting */ dueDate: string | null | undefined; /** * Next reading date batch setting */ nextReading: string | null | undefined; /** * Control code batch setting */ controlCode: string | null | undefined; /** * Invoice number batch setting */ invoiceNumber: string | null | undefined; /** * Account period name batch setting */ accountPeriodName: string | null | undefined; /** * Account period number batch setting */ accountPeriodNumber: number | null | undefined; /** * Account period year batch setting */ accountPeriodYear: number | null | undefined; /** * Note/comment for the batch */ note: string | null | undefined; createdBy: UserChild | null | undefined; /** * Number of unresolved flags on bills contained in this batch */ flagCount: number | null | undefined; /** * Number of bills contained in this batch that are currently being analyzed */ analyzingCount: number | null | undefined; /** * Denotes if the Batch has any imported bills associated with it */ hasImportedBills: boolean | null | undefined; /** * Denotes if the Batch has any import task with Status = \"Completed with kickouts\" */ hasImportsWithKickout: boolean | null | undefined; /** * Denotes if the Batch has any move log events associated with it */ hasLogs: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributeAccountChargesBase { /** * Determines if account charges should be assigned proportionally based on the usage values of each meter or based on the bill cost from each meter. If not provided, defaults to \"Usage\". One of 'Usage', 'Cost', '' Case sensitive Required (defined) */ splitBasis: DistributeAccountChargesBase.SplitBasisEnum; } declare namespace DistributeAccountChargesBase { enum SplitBasisEnum { NUMBER_0, NUMBER_1 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class UpdateBatchStatusRequest { /** * The status to set on the batch Required One of 'Open', 'Pending', 'Closed' Case sensitive */ batchStatus: string | null; /** * The batch note, referred to as a comment in the application when setting state to pending. If opening another user's batch, the note will only be applied to the requesting user's open batch that is being set to pending (if any). If null, the note will not be updated. Set to an empty string to remove the current note. Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; /** * If not provided or false, any open batches for the requesting user will be set to pending, when another pending batch is switched to open If true, any open batches for the requesting user will be left open, when another pending batch is switched to open. Required (defined) */ leaveOpenBatchesAsIs: boolean | null | undefined; } declare class BatchService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param batchId */ closeBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ deleteBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the provided batch which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param batchId ID for the batch containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInBatch(batchId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId * @param body */ editBatch(batchId: number, body?: BatchEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ getBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all move operation logs for a specific batch * * @param batchId Batch identifier */ getBatchLogs(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatches(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Opens a new batch. If there are other open batches for this user, and CloseExistingBatch is true, closes those batches before creating the new batch. Returns the batch response DTO. * * @param body The batch to create */ openBatch(body?: BatchCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the status of a batch. Requesting user must have BillAndBatches Create to update their own batch or to open another user's pending batch. User must have BillsAndBatches Manage to update another user's batch to closed or pending. If opening another user's batch, the requesting user's open batches (if any) will be set to Pending status if LeaveOpenBatchesAsIs is not set or is false. the requesting user's open batches (if any) will be left open if LeaveOpenBatchesAsIs is true. See 'Batch Statuses' section below for more information. * __Batch Statuses:__ | Batch Status | Description | | -------------- | ----------- | | Open | Batch must currently be pending. Un-voids all bills in the batch. | | Pending | Batch must currently be open. Voids all bills in the batch. | | Closed | Batch must currently be open or pending. If the batch was pending, un-voids all bills in the batch. | * @param batchId ID for the batch to set status * @param body The new status, (optional) note on the batch, (optional) LeaveOpenBatchesAsIs property. See 'Batch Statuses' section below for available statuses. */ updateBatchStatus(batchId: number, body?: UpdateBatchStatusRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ closeBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId */ deleteBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the provided batch which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param batchId ID for the batch containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInBatchWithHttpInfo(batchId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId * @param body */ editBatchWithHttpInfo(batchId: number, body?: BatchEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId */ getBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all move operation logs for a specific batch * * @param batchId Batch identifier */ getBatchLogsWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatchesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Opens a new batch. If there are other open batches for this user, and CloseExistingBatch is true, closes those batches before creating the new batch. Returns the batch response DTO. * * @param body The batch to create */ openBatchWithHttpInfo(body?: BatchCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the status of a batch. Requesting user must have BillAndBatches Create to update their own batch or to open another user's pending batch. User must have BillsAndBatches Manage to update another user's batch to closed or pending. If opening another user's batch, the requesting user's open batches (if any) will be set to Pending status if LeaveOpenBatchesAsIs is not set or is false. the requesting user's open batches (if any) will be left open if LeaveOpenBatchesAsIs is true. See 'Batch Statuses' section below for more information. * __Batch Statuses:__ | Batch Status | Description | | -------------- | ----------- | | Open | Batch must currently be pending. Un-voids all bills in the batch. | | Pending | Batch must currently be open. Voids all bills in the batch. | | Closed | Batch must currently be open or pending. If the batch was pending, un-voids all bills in the batch. | * @param batchId ID for the batch to set status * @param body The new status, (optional) note on the batch, (optional) LeaveOpenBatchesAsIs property. See 'Batch Statuses' section below for available statuses. */ updateBatchStatusWithHttpInfo(batchId: number, body?: UpdateBatchStatusRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountMeterResponse { /** * Global use */ globalUse: number | null | undefined; /** * Global use per day */ globalUsePerDay: number | null | undefined; globalUseUnit: UnitChild | null | undefined; /** * Native use */ nativeUse: number | null | undefined; /** * Native use per day */ nativeUsePerDay: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; /** * Native demand */ nativeDemand: number | null | undefined; nativeDemandUnit: UnitChild | null | undefined; /** * Native billed demand */ nativeBilledDemand: number | null | undefined; nativeBilledDemandUnit: UnitChild | null | undefined; /** * Native actual demand */ nativeActualDemand: number | null | undefined; nativeActualDemandUnit: UnitChild | null | undefined; /** * Common use */ commonUse: number | null | undefined; /** * Common use per day */ commonUsePerDay: number | null | undefined; commonUseUnit: UnitChild | null | undefined; /** * Common demand */ commonDemand: number | null | undefined; commonDemandUnit: UnitChild | null | undefined; /** * Common billed demand */ commonBilledDemand: number | null | undefined; commonBilledDemandUnit: UnitChild | null | undefined; /** * Common actual demand */ commonActualDemand: number | null | undefined; commonActualDemandUnit: UnitChild | null | undefined; /** * Direct cost */ directCost: number | null | undefined; /** * Direct cost per day */ directCostPerDay: number | null | undefined; /** * Proportional cost */ proportionalCost: number | null | undefined; /** * Proportional cost per day */ proportionalCostPerDay: number | null | undefined; costUnit: UnitChild | null | undefined; /** * The bill identifier */ billId: number | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The number of days the bill covers */ days: number | null | undefined; account: AccountChild | null | undefined; meter: MeterChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OutlierSeverityChild { /** * The integer that represents the severity of the outlier Values: 1, 2, 3, or 4 */ outlierSeverity: number | null | undefined; /** * The information regarding the current outlier severity Values: 1 = Severe, 2 = High, 3 = Moderate, 4 = Cannot be determined Severe - Actual value is 1, standard deviation > 3.0 on the high side or > 5.0 on the low side High - Actual value is 2, standard deviation > 2.0 high and > 4.0 low Moderate - Actual value is 3, standard deviation > 1.5 high and > 3.0 low Not Classified - It is not one of Severe, High, Low or the model could not be determined */ outlierSeverityInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class StatisticsResponse { /** * The model value */ model: number | null | undefined; /** * The difference between the model and the actual value */ difference: number | null | undefined; /** * Statistical measure of how spread out numbers are from the average */ standardDeviation: number | null | undefined; /** * Statistical measure of how far each value in the data set is from the mean */ variance: number | null | undefined; /** * Statistical measure of how close the data is to the fitted regression line */ rSquared: number | null | undefined; unit: UnitChild | null | undefined; severity: OutlierSeverityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountMeterStatisticsResponse { usePerDay: StatisticsResponse | null | undefined; costPerDay: StatisticsResponse | null | undefined; demandPerDay: StatisticsResponse | null | undefined; /** * The bill identifier */ billId: number | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The number of days the bill covers */ days: number | null | undefined; account: AccountChild | null | undefined; meter: MeterChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccrualExclusionRequest { /** * List of bill IDs to exclude from accruals or include again Required */ billIds: Array | null; /** * Whether or not the bill ids should be excluded from accruals, or included again Required */ exclude: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionApprove { /** * Cannot be Empty Required (defined) */ ids: Array | null | undefined; /** * Required (defined) */ approve: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionCustom { /** * The list of bill ids on which to perform the custom action Cannot be Empty Required (defined) */ billIds: Array | null | undefined; /** * The webhook identifier that represents the custom bill action Required */ webhookId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionDelete { /** * Cannot be Empty */ ids: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionExportHold { /** * Cannot be Empty Required (defined) */ ids: Array | null | undefined; /** * Required (defined) */ exportHold: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Account Period */ declare class BillHeaderUpdateAccountPeriodChild { /** * Must be between 190001 and 209913 Required (defined) */ accountPeriod: number | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Begin Date */ declare class BillHeaderUpdateBeginDateChild { /** * Required when Update is set to True, case sensitive. Must be between 1899-12-31 and 3000-01-01 */ beginDate: Date | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Billing Period */ declare class BillHeaderUpdateBillingPeriodChild { /** * Required when Update is set to True, case sensitive. Valid billing period between 190001 and 209912 NULL Valid */ billingPeriod: number | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Control Code */ declare class BillHeaderUpdateControlCodeChild { /** * Must be between 0 and 255 characters Required (defined) */ controlCode: string | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Due Date */ declare class BillHeaderUpdateDueDateChild { /** * Must be between 1899-12-31 and 3000-01-01 Required (defined) */ dueDate: Date | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * End Date */ declare class BillHeaderUpdateEndDateChild { /** * Required when Update is set to True, case sensitive. Must be between 1899-12-31 and 3000-01-01 */ endDate: Date | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Estimated */ declare class BillHeaderUpdateEstimatedChild { /** * Required when Update is set to True, case sensitive. */ estimated: boolean | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Invoice Number */ declare class BillHeaderUpdateInvoiceNumberChild { /** * Must be between 0 and 32 characters Required (defined) */ invoiceNumber: string | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Statement Date */ declare class BillHeaderUpdateStatementDateChild { /** * Must be between 1899-12-31 and 3000-01-01 Required (defined) */ statementDate: Date | null | undefined; /** * Indicates whether or not the header value is being updated Required */ update: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Bill header values to update */ declare class BillHeaderUpdate { beginDate: BillHeaderUpdateBeginDateChild | null; endDate: BillHeaderUpdateEndDateChild | null; dueDate: BillHeaderUpdateDueDateChild | null; statementDate: BillHeaderUpdateStatementDateChild | null; controlCode: BillHeaderUpdateControlCodeChild | null; invoiceNumber: BillHeaderUpdateInvoiceNumberChild | null; accountPeriod: BillHeaderUpdateAccountPeriodChild | null; billingPeriod: BillHeaderUpdateBillingPeriodChild | null; estimated: BillHeaderUpdateEstimatedChild | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionHeaderUpdate { /** * Bill IDs whose headers are going to be updated Cannot be Empty Required */ billIds: Array | null; billHeader: BillHeaderUpdate | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionMove { /** * Ids of bills to be moved Cannot be Empty Required (defined) */ ids: Array | null | undefined; /** * Destination Account Id Required (defined) */ accountId: number | null | undefined; /** * Destination AccountMeter Ids Required (defined) */ accountMeterIds: Array | null | undefined; /** * Use Account General Ledger from destination account? Required (defined) */ updateAccountGLs: boolean | null | undefined; /** * Use Meter General Ledger from destination meter? Required (defined) */ updateMeterGLs: boolean | null | undefined; /** * If both the source and destination meter is linked to an emissions source and there are records generated from the bills being moved, update the scope category and GHG factor on those records to the destination meter defaults? Defaults to true for GHG Lite users, otherwise false. Required (defined) */ updateRecordScopeAndFactor: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionSplit { /** * List of billIds that need to be split Cannot be Empty */ ids: Array | null | undefined; /** * Optional note/comment */ note: string | null | undefined; batchSettings: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionVoid { /** * Cannot be Empty Required (defined) */ ids: Array | null | undefined; /** * Required (defined) */ void: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountBodyLineCreate { /** * The bodyline's special charge (SingleLine) id, if applicable */ specialChargeId: number | null | undefined; /** * The bodyline's observation type Required */ observationTypeId: number | null; /** * The bodyline's cost unit of measure for this Required when Cost is set */ costUnitId: number | null | undefined; /** * The cost attributed to the line item Required when CostUnitId is set */ cost: number | null | undefined; /** * The caption Required Must be between 0 and 100 characters */ caption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillMeterBodyLineCreate { /** * The bodyline's observation type Required */ observationTypeId: number | null; /** * The bodyline's unit of measure Required when Value is set */ valueUnitId: number | null | undefined; /** * The line item's value Required when ValueUnitId is set */ value: number | null | undefined; /** * The bodyline's cost unit of measure for this Required when Cost is set */ costUnitId: number | null | undefined; /** * The cost attributed to the line item Required when CostUnitId is set */ cost: number | null | undefined; /** * The caption Required Must be between 0 and 100 characters */ caption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillMeterCreate { /** * The meter the line items are assigned to Required */ meterId: number | null; /** * Required Cannot be Empty */ bodyLines: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillCreate { /** * The bill's account Required */ accountId: number | null; /** * The bill's begin date Required Must be between 1899-12-31 and 3000-01-01 */ beginDate: Date | null; /** * The bill's end date Required Must be greater than BeginDate Must be between 1899-12-31 and 3000-01-01 */ endDate: Date | null; /** * The bill's billing period Required Must be between 190001 and 209912 */ billingPeriod: number | null; /** * The bill's accounting period Depending on your settings you can have up to 13 accounting periods Must be between 190001 and 209913 */ accountPeriod: number | null | undefined; /** * Indicates if the bill is estimated */ estimated: boolean | null | undefined; /** * The bill's entry method. True = manual entry, false = automatic entry. Required */ manualEntry: boolean | null; /** * The date and time of the bill statement Must be between 1899-12-31 and 3000-01-01 */ statementDate: Date | null | undefined; /** * The date and time the bill is due Must be between 1899-12-31 and 3000-01-01 */ dueDate: Date | null | undefined; /** * The date and time the of the next reading Must be between 1899-12-31 and 3000-01-01 */ nextReading: Date | null | undefined; /** * The bill's control code Must be between 0 and 255 characters */ controlCode: string | null | undefined; /** * The bill's invoice number Must be between 0 and 32 characters */ invoiceNumber: string | null | undefined; /** * The bill note */ note: string | null | undefined; /** * The meters with line items */ meters: Array | null | undefined; /** * The account line items */ accountBodyLines: Array | null | undefined; /** * Existing batch id to add this bill to, if applicable. If batchId is provided, it needs to be an open batch. If the batch is another user’s open batch, the permission \"Bills and Batches:Manage\" is required. If NOT provided, and current user has multiple open batches, the API will return an error. */ batchId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillDeleteActionResult { /** * */ selected: number | null | undefined; /** * */ deleted: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountBodyLineEdit { /** * The bodyline's id for an existing bodyline Required (defined) */ bodyLineId: number | null | undefined; /** * The bodyline's special charge (SingleLine) id, if applicable Required (defined) */ specialChargeId: number | null | undefined; /** * The bodyline's observation type Required */ observationTypeId: number | null; /** * The bodyline's cost unit of measure for this Required when Cost is set */ costUnitId: number | null | undefined; /** * The cost attributed to the line item Required when CostUnitId is set */ cost: number | null | undefined; /** * The caption Required Must be between 0 and 100 characters */ caption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillMeterBodyLineEdit { /** * The bodyline's id for an existing bodyline Required (defined) */ bodyLineId: number | null | undefined; /** * The bodyline's observation type Required */ observationTypeId: number | null; /** * The bodyline's unit of measure Required when Value is set */ valueUnitId: number | null | undefined; /** * The line item's value Required when ValueUnitId is set */ value: number | null | undefined; /** * The bodyline's cost unit of measure for this Required when Cost is set */ costUnitId: number | null | undefined; /** * The cost attributed to the line item Required when CostUnitId is set */ cost: number | null | undefined; /** * The caption Required Must be between 0 and 100 characters */ caption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillMeterEdit { /** * The meter the line items are assigned to Required */ meterId: number | null; /** * Required Cannot be Empty */ bodyLines: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEdit { /** * Required */ saveAsResolved: boolean | null; /** * Max length of 255 Required (defined) */ saveAsResolvedComment: string | null | undefined; /** * Required */ rerunResolvedIssues: boolean | null; /** * The bill's account Required */ accountId: number | null; /** * The bill's begin date Required Must be between 1899-12-31 and 3000-01-01 */ beginDate: Date | null; /** * The bill's end date Required Must be greater than BeginDate Must be between 1899-12-31 and 3000-01-01 */ endDate: Date | null; /** * The bill's billing period Required Must be between 190001 and 209912 */ billingPeriod: number | null; /** * The bill's accounting period Depending on your settings you can have up to 13 accounting periods Must be between 190001 and 209913 Required (defined) */ accountPeriod: number | null | undefined; /** * Indicates if the bill is estimated Required (defined) */ estimated: boolean | null | undefined; /** * The date and time of the bill statement Must be between 1899-12-31 and 3000-01-01 Required (defined) */ statementDate: Date | null | undefined; /** * The date and time the bill is due Must be between 1899-12-31 and 3000-01-01 Required (defined) */ dueDate: Date | null | undefined; /** * The date and time the next reading Must be between 1899-12-31 and 3000-01-01 Required (defined) */ nextReading: Date | null | undefined; /** * The bill's control code Must be between 0 and 255 characters Required (defined) */ controlCode: string | null | undefined; /** * The bill's invoice number Must be between 0 and 32 characters Required (defined) */ invoiceNumber: string | null | undefined; /** * The bill's \"approval change flag\". If a bill is approved and the approval system is turned on: true = unapprove bill, false = don't change bill's approval status. If the approval system is not turned on: the bill's approval status will not be changed regardless of this setting. Required (defined) */ setToUnapproved: boolean | null | undefined; /** * The bill note Required (defined) */ note: string | null | undefined; /** * The meters with line items Required (defined) */ meters: Array | null | undefined; /** * The account line items Required (defined) */ accountBodyLines: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryBodyLineChild { /** * The body line's numeric value */ value: number | null | undefined; /** * The body line's observation type */ type: string | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryBodyLineWithNounChild { /** * The body line's noun */ noun: string | null | undefined; /** * The body line's numeric value */ value: number | null | undefined; /** * The body line's observation type */ type: string | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryObservationTypeChild { /** * The observation type identifier */ observationTypeId: number | null | undefined; /** * The observation type code */ observationTypeCode: string | null | undefined; /** * The observation type name */ observationTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryBodyLine { /** * The body line identifier */ bodyLineId: number | null | undefined; /** * The body line's caption */ caption: string | null | undefined; value: BillEntryBodyLineWithNounChild | null | undefined; cost: BillEntryBodyLineChild | null | undefined; observationType: BillEntryObservationTypeChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryMeterChild { /** * True means a \"template\" was used to generate the bodylines False means an existing bill was used to generate the bodylines */ fromTemplate: boolean | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter name */ meterInfo: string | null | undefined; /** * The meter gl code */ generalLedgerCode: string | null | undefined; /** * The bill's meter-level details */ bodyLines: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillHeaderChild { /** * The bill header value */ value: string | null | undefined; /** * Indicates if the bill header is required during bill entry */ required: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostConversion { sourceUnit: UnitChild | null | undefined; systemUnit: UnitChild | null | undefined; /** * The conversion factor used to convert from the source cost unit to the system cost unit */ sourceToSystemConversionValue: number | null | undefined; /** * The date used to look up the currency conversion */ conversionDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ObservationMethodChild { /** * Observation method identifier */ observationMethodId: number | null | undefined; /** * Observation method code */ observationMethodCode: string | null | undefined; /** * Observation method name: Automatic, Manual, Estimated, Simulated, Accrual, or Adjustment */ observationMethodInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillEntryResponse { /** * The bill identifier */ billId: number | null | undefined; /** * The account identifier */ accountId: number | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; /** * Indicates if a new bill batch needs to be opened to place this bill in */ needsToOpenBatch: boolean | null | undefined; /** * Indicates how many open batches the user has */ numberOfOpenBatches: number | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's number of days */ days: number | null | undefined; /** * The bill's total cost in the system currency. The system currency is the reporting/global currency unit. */ totalCost: number | null | undefined; /** * The bill's total cost in the source currency. The source currency is the native currency unit. */ totalSourceCost: number | null | undefined; costConversion: CostConversion | null | undefined; dueDate: BillHeaderChild | null | undefined; statementDate: BillHeaderChild | null | undefined; invoiceNumber: BillHeaderChild | null | undefined; controlCode: BillHeaderChild | null | undefined; nextReading: BillHeaderChild | null | undefined; accountPeriodName: BillHeaderChild | null | undefined; accountPeriodNumber: BillHeaderChild | null | undefined; accountPeriodYear: BillHeaderChild | null | undefined; estimated: BillHeaderChild | null | undefined; /** * The bill's note */ billNote: string | null | undefined; /** * Indicates if the bill has been voided */ void: boolean | null | undefined; /** * Indicates if the bill is from a vendor */ fromVendor: boolean | null | undefined; observationMethod: ObservationMethodChild | null | undefined; /** * Indicates if the bill has been approved */ approved: boolean | null | undefined; /** * Indicates if the bill has been split */ hasBeenSplit: boolean | null | undefined; /** * Indicates if the bill is being withheld from bill exports */ exportHold: boolean | null | undefined; /** * Indicates if the bill has been ap exported */ apExported: boolean | null | undefined; /** * Indicates if the bill has been gl exported */ glExported: boolean | null | undefined; /** * Indicates if the bill has been exported to bill payment */ paymentExported: boolean | null | undefined; /** * Indicates if the bill is an accrual bill */ accrual: boolean | null | undefined; /** * The number of the check that the bill was paid with */ checkNumber: string | null | undefined; /** * The date and time of the check */ checkDate: Date | null | undefined; /** * The payment status of the bill */ payStatus: string | null | undefined; /** * The date when funds were withdrawn */ fundsWithdrawnDate: Date | null | undefined; /** * The date and time that the check cleared */ clearedDate: Date | null | undefined; /** * The fully qualified url to the bill image */ billImageUrl: string | null | undefined; /** * The general ledger code of the bill's account-level details (\"Mixed\" if there is more than one) */ generalLedgerCode: string | null | undefined; /** * The billing account's meters */ meters: Array | null | undefined; /** * The bill's account-level details */ accountBodyLines: Array | null | undefined; /** * The bill's vendor template details */ vendorBodyLines: Array | null | undefined; batch: BatchChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillExport { /** * Cannot be Empty NULL Valid Required (defined) */ billIds: Array | null | undefined; /** * The export mode to use. Valid values are 'AP', 'GL', 'Payment' Required One of 'ap', 'gl', 'payment' */ exportMode: string | null; /** * Flag to mark bills as exported after the export is complete. Required */ markAsExported: boolean | null; /** * Optional filename to use for the export file. Filenames may only contain alphanumeric characters, dashes, underscores, or periods. Required (defined) */ fileName: string | null | undefined; /** * Optional note/comment. Required (defined) */ exportNote: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountMeterChild { /** * The bill-account-meter's account id */ accountId: number | null | undefined; /** * The bill-account-meter's meter id */ meterId: number | null | undefined; /** * The bill-account-meter's native use */ nativeUse: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; /** * The bill-account-meter's direct cost */ directCost: number | null | undefined; directCostUnit: UnitChild | null | undefined; /** * The bill-account-meter's native use unit cost */ nativeUseUnitCost: number | null | undefined; /** * The bill-account-meter's native use per day */ nativeUsePerDay: number | null | undefined; /** * The bill-account-meter's direct cost per day */ directCostPerDay: number | null | undefined; /** * The bill-account-meter's native billed demand */ nativeBilledDemand: number | null | undefined; nativeBilledDemandUnit: UnitChild | null | undefined; /** * The bill-account-meter's native actual demand */ nativeActualDemand: number | null | undefined; nativeActualDemandUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillHistoryResponse { /** * The bill's bill id */ billId: number | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's created date */ createdDate: Date | null | undefined; /** * The bill's total cost */ totalCost: number | null | undefined; totalCostUnit: UnitChild | null | undefined; /** * The bill's void indicator */ void: boolean | null | undefined; /** * The bill's accrual indicator */ accrual: boolean | null | undefined; /** * The bill's invoice number */ invoiceNumber: string | null | undefined; /** * Indicates if the bill is estimated or not */ estimated: boolean | null | undefined; /** * The bill's due date */ dueDate: Date | null | undefined; /** * The bill's statement date */ statementDate: Date | null | undefined; /** * The bill's account-meter summaries */ billAccountMeters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillIdResponse { /** * The bill identifier */ billId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillLineTypeMappingResponse { /** * The observation type identifier */ observationTypeId: number | null | undefined; /** * The observation type code that the caption maps to */ observationTypeCode: string | null | undefined; /** * The observation type info that the caption maps to */ observationTypeInfo: string | null | undefined; /** * The account identifier */ accountId: number | null | undefined; /** * The account code that the caption maps to */ accountCode: string | null | undefined; /** * The account info that the caption maps to */ accountInfo: string | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code that the caption maps to */ vendorCode: string | null | undefined; /** * The vendor info that the caption maps to */ vendorInfo: string | null | undefined; /** * The type of mapping, either default, vendor or account */ type: string | null | undefined; /** * The bill line mapping operator identifier */ operatorId: number | null | undefined; /** * The match operator used to map the caption */ operator: string | null | undefined; /** * The caption match that maps to the observation type */ caption: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentDetailsFileResponse { /** * Number of successful bill payment detail updates Required (defined) */ success: number | null | undefined; /** * Number of unsuccessful bill payment detail updates Required (defined) */ failure: number | null | undefined; /** * Base64 encoded File content of unsuccessful bill payment detail updates with reasons for failure Required (defined) */ kickoutStream: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OptionalUpdateNullableDateOnly { /** * The value to save during update Should be a date only with no time element If null is passed as a value and update is true it will be saved to the database Required (defined) */ value: Date | null | undefined; /** * Should the value be saved This is used to optionally update certain fields during a PUT request Required (defined) */ update: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OptionalUpdateNullableDecimal { /** * The value to save during update If null is passed as a value and update is true it will be saved to the database */ value: number | null | undefined; /** * Should the value be saved This is used to optionally update certain fields during a PUT request */ update: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OptionalUpdateNullableInt32 { /** * The value to save during update If null is passed as a value and update is true it will be saved to the database */ value: number | null | undefined; /** * Should the value be saved This is used to optionally update certain fields during a PUT request */ update: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OptionalUpdateString { /** * The value to save during update If null is passed as a value and update is true it will be saved to the database */ value: string | null | undefined; /** * Should the value be saved This is used to optionally update certain fields during a PUT request */ update: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentDetailsOptionalItem { /** * Identifier for bill to update Required */ billId: number | null; checkNumber: OptionalUpdateString | null | undefined; checkDate: OptionalUpdateNullableDateOnly | null | undefined; payStatus: OptionalUpdateString | null | undefined; clearedDate: OptionalUpdateNullableDateOnly | null | undefined; accountingPeriod: OptionalUpdateNullableInt32 | null | undefined; fundsWithdrawnDate: OptionalUpdateNullableDateOnly | null | undefined; paymentAmount: OptionalUpdateNullableDecimal | null | undefined; paymentType: OptionalUpdateString | null | undefined; paymentVoucher: OptionalUpdateString | null | undefined; checkImage: OptionalUpdateString | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentDetailsOptionalItemWithErrors { /** * Give error details Required (defined) */ errors: string | null | undefined; /** * Identifier for bill to update Required */ billId: number | null; checkNumber: OptionalUpdateString | null | undefined; checkDate: OptionalUpdateNullableDateOnly | null | undefined; payStatus: OptionalUpdateString | null | undefined; clearedDate: OptionalUpdateNullableDateOnly | null | undefined; accountingPeriod: OptionalUpdateNullableInt32 | null | undefined; fundsWithdrawnDate: OptionalUpdateNullableDateOnly | null | undefined; paymentAmount: OptionalUpdateNullableDecimal | null | undefined; paymentType: OptionalUpdateString | null | undefined; paymentVoucher: OptionalUpdateString | null | undefined; checkImage: OptionalUpdateString | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentDetailsOptionalResponse { /** * Number of successful bill payment detail updates Required (defined) */ success: number | null | undefined; /** * Number of unsuccessful bill payment detail updates Required (defined) */ failure: number | null | undefined; /** * List of unsuccessful bill payment detail updates with reasons for failure Required (defined) */ failedBillPaymentDetailsOptionalItems: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentEventCreate { /** * Bill ids for the event Required Cannot be Empty */ billIds: Array | null; /** * The payment event type of the event. For example, paymentGroup.approved, payment.open, payment.returned Required Must be between 0 and 32 characters */ paymentEventType: string | null; /** * An object representing the JSON received by the web hook */ webhookPayload: any | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillPaymentEventResponse { /** * The identifier of the payment event */ paymentEventId: number | null | undefined; /** * The payment type of the event. For example, paymentGroup.approved, payment.open, payment.returned */ paymentEventType: string | null | undefined; /** * The date and time of the bill payment event */ createdDate: Date | null | undefined; /** * An object representing the JSON received by the web hook */ webhookPayload: any | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillReversal { /** * Identifier of the other bill in the reversal pair */ referenceBillId: number | null | undefined; /** * Indicates whether the reference bill is a reversal or source of a reversal. It is \"Source\" if the reference bill is the source bill and \"Reversal\" if the reference bill is the reversal bill */ referenceType: string | null | undefined; /** * Description of the reversal pair */ description: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillResponse { /** * The bill identifier */ billId: number | null | undefined; batch: BatchChild | null | undefined; account: AccountChild | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's accounting period */ accountPeriod: number | null | undefined; /** * The bill's total cost in the system currency. The system currency is the reporting/global currency unit. */ totalCost: number | null | undefined; /** * The bill's total cost in the source currency. The source currency is the native currency unit. */ totalSourceCost: number | null | undefined; costConversion: CostConversion | null | undefined; /** * Indicates if the bill is estimated */ estimated: boolean | null | undefined; /** * Indicates if the bill has been approved */ approved: boolean | null | undefined; /** * The date and time the bill was approved */ approveDate: Date | null | undefined; approvedBy: UserChild | null | undefined; /** * Indicates if the bill has been exported */ exported: boolean | null | undefined; /** * The date and time the bill was exported */ exportDate: Date | null | undefined; exportedBy: UserChild | null | undefined; observationMethod: ObservationMethodChild | null | undefined; /** * The date and time of the bill statement */ statementDate: Date | null | undefined; /** * The date and time the bill is due */ dueDate: Date | null | undefined; /** * The date and time of the next reading */ nextReading: Date | null | undefined; /** * The bill's control code */ controlCode: string | null | undefined; /** * The bill's invoice number */ invoiceNumber: string | null | undefined; /** * The number of pages on the invoice */ invoicePages: number | null | undefined; /** * The check number */ checkNumber: string | null | undefined; /** * The date and time of the check */ checkDate: Date | null | undefined; /** * The pay status of the bill */ payStatus: string | null | undefined; /** * The date when funds were withdrawn */ fundsWithdrawnDate: Date | null | undefined; /** * The cleared date */ clearedDate: Date | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the bill was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Indicates if the bill has been voided */ void: boolean | null | undefined; /** * Indicates if the bill record has been cleaned. Cleaning is an internal EnergyCAP process */ dirty: boolean | null | undefined; /** * Indicates if the import has been verified */ importVerified: boolean | null | undefined; /** * Indicates if the bill is an accrual */ accrual: boolean | null | undefined; /** * Indicates if the bill is a reversed accrual */ accrualReversed: boolean | null | undefined; /** * The date and time the accrual was reversed */ accrualReversedDate: Date | null | undefined; /** * Indicates if the bill is held for export */ exportHold: boolean | null | undefined; /** * Indicates if the bill has been gl exported */ glExported: boolean | null | undefined; glExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to gl */ glExportDate: Date | null | undefined; /** * Indicates if the bill has been bill payment exported */ paymentExported: boolean | null | undefined; paymentExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to bill payment */ paymentExportDate: Date | null | undefined; /** * Indicates if the bill is from a vendor */ fromVendor: boolean | null | undefined; /** * Indicates if the bill has been split */ hasBeenSplit: boolean | null | undefined; /** * The date and time the bill was split */ wasSplitDate: Date | null | undefined; /** * The transaction reference number of the bill */ transRefNum: string | null | undefined; /** * The payment type of the bill. For example, Check, VCard, and ACH. */ paymentType: string | null | undefined; /** * The actual amount paid */ actualAmountPaid: number | null | undefined; assignedTo: UserChild | null | undefined; /** * The date and time the bill was assigned to a user */ assignedDate: Date | null | undefined; /** * The bill's pay source */ paySource: string | null | undefined; /** * Indicates whom the bill paid */ payTo: string | null | undefined; /** * The balance of the previous bill */ previousBalance: number | null | undefined; /** * The amount of balance that was forwarded */ balanceForward: number | null | undefined; /** * The current charges */ currentCharges: number | null | undefined; /** * Bill note for this bill */ billNote: string | null | undefined; reversalDetails: BillReversal | null | undefined; /** * Indicates whether this bill is excluded from accruals or not */ excludedFromAccruals: boolean | null | undefined; /** * Indicates whether this bill is currently being analyzed */ analyzing: boolean | null | undefined; /** * The net amount of the payment event of the bill */ paymentAmount: number | null | undefined; /** * The API URL that can be used to download the file of the payment voucher */ paymentVoucher: string | null | undefined; /** * The API URL that can be used to download the file of the check image */ checkImage: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReversalBatchSettings { /** * Needs to be one of - \"new self-contained batch\", \"use existing batch\", or \"new batch\" If \"new self-contained batch\", make a new batch and add bills to it and close it. \"CloseExistingBatch\" property of NewBatch object is ignored in this case since a self-contained batch should not affect existing batches. If \"use existing batch\", we will use an existing open batch and leave it open. Used with \"ExistingOpenBatchId\" property. If \"new batch\", open a new batch. If there are other open batches for this user, and \"CloseExistingBatch\" is true, then close those batches. One of 'new self-contained batch', 'use existing batch', 'new batch' Required (defined) */ batchMode: string | null | undefined; /** * Optional - ID of an existing open batch to use. Only applies when BatchMode is \"use existing batch\". If not provided, the current user must have exactly one open batch, otherwise an error occurs. Must reference an open batch belonging to the current user, or if the user has \"Bills and Batch: Manage\" permission, any user's open batch. Required (defined) */ existingOpenBatchId: number | null | undefined; newBatch: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillReversalRequest { /** * Bill ids to reverse Required Cannot be Empty */ billIds: Array | null; batchSettings: ReversalBatchSettings | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillUnexport { /** * Required Cannot be Empty */ billIds: Array | null; /** * Required One of 'ap', 'gl', 'payment' */ exportMode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ObservationTypeChild { /** * The identifier for the observation type's noun */ nounId: number | null | undefined; /** * The observation type's noun code */ nounCode: string | null | undefined; /** * Indicates the type of credit for the observation type. Possible values include: 1 (Credit), 2 (Debit), 3 (Ignore) */ credit: number | null | undefined; /** * The observation type identifier */ observationTypeId: number | null | undefined; /** * The observation type code */ observationTypeCode: string | null | undefined; /** * The observation type info */ observationTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BodylineResponse { /** * The bodyline identifier */ bodylineId: number | null | undefined; /** * The bill identifier */ billId: number | null | undefined; /** * The bodyline's value */ value: number | null | undefined; /** * The cost attributed to the bodyline */ cost: number | null | undefined; /** * The display order */ displayOrder: number | null | undefined; /** * The caption */ caption: string | null | undefined; /** * The help tag */ helpTag: string | null | undefined; commodity: CommodityChild | null | undefined; meter: MeterChild | null | undefined; account: AccountChild | null | undefined; generalLedger: GeneralLedgerChild | null | undefined; observationType: ObservationTypeChild | null | undefined; unit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowBase { /** * Identifier for the chargeback workflow */ chargebackWorkflowId: number | null | undefined; /** * Name given to the chargeback workflow */ chargebackWorkflowInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowStepChild { /** * Identifier for the chargeback workflow step */ chargebackWorkflowStepId: number | null | undefined; /** * Name given to the chargeback workflow step */ chargebackWorkflowStepInfo: string | null | undefined; /** * Description for the chargeback workflow step */ chargebackWorkflowStepDescription: string | null | undefined; /** * The chargeback type that can be assign to this chargeback workflow step. One of 'Split', 'Calculation' One of 'Split', 'Calculation' */ chargebackWorkflowStepType: string | null | undefined; /** * The order for this step within the chargeback workflow */ chargebackWorkflowStepOrder: number | null | undefined; chargebackWorkflow: ChargebackWorkflowBase | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackTaskResponse { /** * The number of bills created by the task */ numberOfBillsCreated: number | null | undefined; /** * The number of chargeback versions that failed to run within the task */ numberOfFailedVersions: number | null | undefined; /** * Identifier for the task */ taskId: number | null | undefined; workflow: ChargebackWorkflowStepChild | null | undefined; /** * Begin date when the task started */ taskBegin: Date | null | undefined; /** * End date when the task ended */ taskEnd: Date | null | undefined; user: UserChild | null | undefined; /** * The billing period the task was run for */ billingPeriod: number | null | undefined; batch: BatchChild | null | undefined; /** * The task's settings */ settings: any | null | undefined; /** * User comments on the task */ comment: string | null | undefined; /** * Current status of the task */ status: string | null | undefined; /** * The chargeback type. Either \"Split\" or \"Calculation\" */ chargebackType: string | null | undefined; reversedBy: UserChild | null | undefined; /** * The date when all bills generated by the task were voided or deleted */ reversedDate: Date | null | undefined; /** * The number of bills that are currently analyzing within the task */ numberOfAnalyzingBills: number | null | undefined; /** * The number of unresolved flags on bills within the task */ numberOfUnresolvedFlags: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributeAccountChargesToBillsRequest { /** * Bill IDs for which account charges will be proportionally distributed to the meters Cannot be Empty Required (defined) */ billIds: Array | null | undefined; /** * Determines if account charges should be assigned proportionally based on the usage values of each meter or based on the bill cost from each meter. If not provided, defaults to \"Usage\". One of 'Usage', 'Cost', '' Case sensitive Required (defined) */ splitBasis: DistributeAccountChargesToBillsRequest.SplitBasisEnum; } declare namespace DistributeAccountChargesToBillsRequest { enum SplitBasisEnum { NUMBER_0, NUMBER_1 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportLine { /** * */ bodyLineId: number | null | undefined; /** * */ caption: string | null | undefined; /** * */ value: number | null | undefined; /** * */ valueIsInfoOnly: boolean | null | undefined; /** * */ cost: number | null | undefined; /** * */ costIsInfoOnly: boolean | null | undefined; valueUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; observationType: ObservationTypeChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportGeneralLedger { /** * */ generalLedgerId: number | null | undefined; /** * */ generalLedgerCode: string | null | undefined; /** * */ generalLedgerInfo: string | null | undefined; /** * */ subCode01: string | null | undefined; /** * */ subCode02: string | null | undefined; /** * */ subCode03: string | null | undefined; /** * */ subCode04: string | null | undefined; /** * */ subCode05: string | null | undefined; /** * */ subCode06: string | null | undefined; /** * */ subCode07: string | null | undefined; /** * */ subCode08: string | null | undefined; /** * */ subCode09: string | null | undefined; /** * */ subCode10: string | null | undefined; /** * */ subCode11: string | null | undefined; /** * */ subCode12: string | null | undefined; /** * */ subCode13: string | null | undefined; /** * */ subCode14: string | null | undefined; /** * */ subCode15: string | null | undefined; /** * */ subCode16: string | null | undefined; /** * */ subCode17: string | null | undefined; /** * */ subCode18: string | null | undefined; /** * */ subCode19: string | null | undefined; /** * */ subCode20: string | null | undefined; /** * */ lines: Array | null | undefined; /** * */ cost: number | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportPlace { /** * */ placeId: number | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeInfo: string | null | undefined; placeType: PlaceTypeResponse | null | undefined; address: AddressChild | null | undefined; /** * */ customFields: { [key: string]: string; } | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportMeter { /** * */ meterId: number | null | undefined; /** * */ meterCode: string | null | undefined; /** * */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; address: AddressChild | null | undefined; commodity: CommodityChild | null | undefined; /** * */ serialNumber: string | null | undefined; rate: RateChild | null | undefined; place: JsonBillExportPlace | null | undefined; /** * */ customFields: { [key: string]: string; } | null | undefined; /** * */ generalLedgers: Array | null | undefined; /** * */ lines: Array | null | undefined; /** * */ nativeUse: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; /** * */ cost: number | null | undefined; costUnit: UnitChild | null | undefined; /** * */ nativeBilledDemand: number | null | undefined; nativeBilledDemandUnit: UnitChild | null | undefined; /** * */ nativeActualDemand: number | null | undefined; nativeActualDemandUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportVendor { /** * */ vendorId: number | null | undefined; /** * */ vendorCode: string | null | undefined; /** * */ vendorInfo: string | null | undefined; address: AddressChild | null | undefined; /** * */ customFields: { [key: string]: string; } | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportAccount { /** * */ accountId: number | null | undefined; /** * */ accountCode: string | null | undefined; /** * */ accountInfo: string | null | undefined; accountType: AccountTypeChild | null | undefined; address: AddressChild | null | undefined; vendor: JsonBillExportVendor | null | undefined; /** * */ customFields: { [key: string]: string; } | null | undefined; /** * */ meters: Array | null | undefined; /** * */ generalLedgers: Array | null | undefined; /** * */ lines: Array | null | undefined; /** * */ cost: number | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class JsonBillExportResponse { /** * The bill identifier */ billId: number | null | undefined; /** * Indicates if the bill has been voided */ void: boolean | null | undefined; /** * Indicates if the bill is from a vendor */ fromVendor: boolean | null | undefined; /** * The method used to create the bill Automatic, Manual, Estimated, Simulated, Accrual, or Adjustment */ creationMethod: string | null | undefined; /** * Indicates if the bill is an accrual */ accrual: boolean | null | undefined; /** * Indicates if the bill is a reversed accrual */ accrualReversed: boolean | null | undefined; batch: BatchChild | null | undefined; /** * The date the batch was closed */ batchEndDate: Date | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the bill was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Indicates if the bill has been approved */ approved: boolean | null | undefined; /** * The date and time the bill was approved */ approveDate: Date | null | undefined; approvedBy: UserChild | null | undefined; /** * Indicates if the bill has been split */ hasBeenSplit: boolean | null | undefined; /** * The date and time the bill was split */ wasSplitDate: Date | null | undefined; /** * Indicates if the bill is being withheld from bill exports */ exportHold: boolean | null | undefined; /** * Indicates if the bill has been ap exported */ apExported: boolean | null | undefined; /** * The date and time the bill was ap exported */ apExportDate: Date | null | undefined; apExportedBy: UserChild | null | undefined; /** * Indicates if the bill has been gl exported */ glExported: boolean | null | undefined; glExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to gl */ glExportDate: Date | null | undefined; /** * Indicates if the bill has been exported to bill payment */ paymentExported: boolean | null | undefined; paymentExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to bill payment */ paymentExportDate: Date | null | undefined; /** * The method used to upload the bill to BillCAPture, if applicable */ bcAcquisitionMethod: string | null | undefined; /** * The date and time the bill was received by BillCAPture */ bcReceived: Date | null | undefined; /** * The date and time the bill entered processing in BillCAPture */ bcSentToProcessing: Date | null | undefined; /** * The date and time the bill was returned from processing in BillCAPture */ bcReturnedFromProcessing: Date | null | undefined; /** * The date and time the bill processing was completed in BillCAPture */ bcProcessingComplete: Date | null | undefined; /** * The number of the check that the bill was paid with */ checkNumber: string | null | undefined; /** * The date and time of the check */ checkDate: Date | null | undefined; /** * The payment status of the bill */ payStatus: string | null | undefined; /** * The date when funds were withdrawn */ fundsWithdrawnDate: Date | null | undefined; /** * The date and time that the check cleared */ clearedDate: Date | null | undefined; /** * The payment type of the bill. For example, Check, VCard, and ACH. */ paymentType: string | null | undefined; /** * The net amount of the payment event of the bill */ paymentAmount: number | null | undefined; /** * The API URL that can be used to download the file of the payment voucher */ paymentVoucher: string | null | undefined; /** * The API URL that can be used to download the file of the check image */ checkImage: string | null | undefined; account: JsonBillExportAccount | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's number of days */ days: number | null | undefined; /** * The bill's accounting period */ accountPeriod: number | null | undefined; /** * The bill's accounting period name */ accountPeriodName: string | null | undefined; /** * The bill's total cost in the system currency. The system currency is the reporting/global currency unit. */ totalCost: number | null | undefined; /** * The bill's total cost in the source currency. The source currency is the native currency unit. */ totalSourceCost: number | null | undefined; costConversion: CostConversion | null | undefined; /** * The bill's balance */ balance: number | null | undefined; /** * Indicates if the bill is estimated */ estimated: boolean | null | undefined; /** * The date of the billing statement */ statementDate: Date | null | undefined; /** * The date and time the bill is due */ dueDate: Date | null | undefined; /** * The bill's invoice number */ invoiceNumber: string | null | undefined; /** * The bill's control code */ controlCode: string | null | undefined; /** * The fully qualified url to the bill image */ billImageUrl: string | null | undefined; /** * Bill note */ billNote: string | null | undefined; /** * The bill's next reading date */ nextReading: Date | null | undefined; reversalDetails: BillReversal | null | undefined; /** * Indicates whether this bill is excluded from accruals or not */ excludedFromAccruals: boolean | null | undefined; /** * Indicates whether this bill is currently being analyzed */ analyzing: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListIds { /** * Required (defined) */ ids: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DestinationAccountMeterChild { /** * The AccountMeter identifier Required (defined) */ accountMeterId: number | null | undefined; /** * The Meter identifier for this AccountMeter Required (defined) */ meterId: number | null | undefined; /** * The code of the Meter for this AccountMeter Required (defined) */ meterCode: string | null | undefined; /** * The info of the Meter for this AccountMeter Required (defined) */ meterInfo: string | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DestinationAccountResponse { /** * The account identifier Required (defined) */ accountId: number | null | undefined; /** * The account code Required (defined) */ accountCode: string | null | undefined; /** * The account info Required (defined) */ accountInfo: string | null | undefined; vendor: VendorChild | null | undefined; /** * An array of identifiers for meters attached to this account Required (defined) */ meters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MoveBillsDestination { /** * Required (defined) */ commodities: Array | null | undefined; /** * Required (defined) */ accounts: Array | null | undefined; } declare class BillService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Update approved flag for the given billIDs * * @param body approve action */ billActionApprove(body?: BillActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete given billIDs * * @param body */ billActionDelete(body?: BillActionDelete, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update export hold flag for the given billIDs * * @param body export hold action */ billActionExportHold(body?: BillActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run the bill split processor on the given list of bills. Optional note can be provided. Optional batch settings can be provided that will allow custom batchcode and bill headers for the destination bills * * @param body */ billActionSplit(body?: BillActionSplit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update all headers for a given list of bills If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bill audits won't be fired * * @param body Bill header update action */ billActionUpdateHeaders(body?: BillActionHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update void flag for the given billIDs * * @param body Void action */ billActionVoid(body?: BillActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each record in the request body, update the bill payment details. * * @param body List of Bill payment details */ billPaymentDetails(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the import file, update the bill payment details. * The import file needs to be a comma separated file. All lines are data lines (No header line allowed). The file structure is as follows- Bill Id (required), Check Number (required), Check Date YYYYMMDD format (required), Pay Status (upto 10 characters- do not use commas) (required), Cleared Date YYYYMMDD format (optional), Accounting Period YYYYMM (optional), comment (optional) - comment will be ignored. Example data:12345,7098,20210801,Procesed,20210806,202107,July bill paid via AP For this request, please use application/octet-stream as Content-Type and include your file as binary in the body of the request. /// * @param body Binary data containing the file contents */ billPaymentDetailsFile(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Cleans a single bill. The dirty flag of the bill is not taken into account. * * @param billId */ cleanABill(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Cleans all dirty bills, and any bills created outside of version 7. * */ cleanDirtyBills(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new bill * Creates a bill. The created bill gets audited. If any audits fail, the bill will get flagged. If the audit setting for any of the failed audits is set to Fail and Hold, the bill will be set as \"Hold from Accounting Export\" If saveAsResolved property is set to true, the flagged bill will be automatically resolved and Released for Accounting Export * @param saveAsResolved Controls whether or not any failed audits automatically get marked as resolved * @param comment Optional comment to explain why the audit is being auto resolved * @param body */ createBill(saveAsResolved?: boolean, comment?: string, body?: BillCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Persist an payment event for several bills * * @param body Payment event creation payload */ createBillPaymentEvent(body?: BillPaymentEventCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the request body which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param body Distribution information */ distributeAccountChargesToMeters(body?: DistributeAccountChargesToBillsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a bill custom field * * @param billId The id of the bill * @param udfId The id of the custom field */ downloadBillCustomFieldFile(billId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing bill * If enabled, audits will be processed for the edited bill. If specified, any issues previously resolved will be reopened. Below are some clarifications regarding the rules for editing an existing bill: * Bills which are marked as \"void\" may not be edited * Users without UpdateApprovedBills.Edit permission may not edit bills marked as \"Approved\" * Users without ExportBills.Edit permission may not edit bills exported to AP or GL * Bills must have at least one line item * If configured, required bill headers will be enforced * @param billId * @param body */ editBill(billId: number, body?: BillEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a bill * * @param billId The id of the bill * @param body The list of udf values being edited */ editBillCustomFields(billId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the text of a standard EnergyCAP bill export ini file for AP, GL and Payment purposes. Payment details will be included in the profile if workflow settings for the bill export are configured to include payment details. * * @param exportMode Specifies whether the profile should be for AP, GL or Payment. Pass in \"AP\" for AP Profile, \"GL\" for GL Profile or \"Payment\" for Payment Profile. If this is not included in the request, it defaults to AP. */ exportBillProfile(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves text of a standard EnergyCAP bill export file for AP, GL and payment purposes. Maximum of 10000 bills can be processed at one time. Only bills with the following conditions are included in the export file: 1) approved bills (if the approval system is enabled in workflow settings) 2) bill is in a closed batch (if after batch or after batch approval is set in the workflow settings) 3) bill is not held for export 4) bill is not void 5) bill is within the user's topmost setting. 6) bill in not already exported * * @param body */ exportBills(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a JSON array of bill details. * * @param body List of bill IDs */ exportBillsAsJson(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill history for an account * * @param accountId accountId to get bill history for * @param billingPeriod required: billingPeriod in yyyymm format to return history from * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getAccountBillHistory(accountId: number, billingPeriod?: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylines(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one bill * * @param billId The bill identifier */ getBill(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill account meter record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterActualByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter calendarized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterCalendarizedByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter normalized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterNormalizedByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter statistics record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterStatisticsByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActual(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatistics(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one bill's bodylines * * @param billId The bill identifier */ getBillBodylines(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a bill * * @param billId The id of the bill */ getBillCustomFields(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data necessary to load the bill entry screen * * @param accountId * @param beginDate * @param batchId */ getBillEntryData(accountId: number, beginDate?: Date, batchId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all data necessary to load the bill entry screen * * @param billId */ getBillEntryDataByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill history from starting at the billId billing period * * @param billId billId to get bill history for * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getBillHistory(billId: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of bill line type mappings * */ getBillLineTypeMappings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the payment events for a bill * * @param billId Identifier for the bill */ getBillPaymentEvents(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBills(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bills * * @param body List of Bill Ids to be used to determine the commodities to be matched on the destination accounts. */ getPossibleDestinationAccounts(body?: ListIds, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the set of bills to the specified batch The bills being moved could be in an open, pending or closed batch The specified batch should be an open or pending batch All the bills being moved should be in the same batch Moving from a pending to an open will cause the bills to get un-voided Moving from an open/closed to a pending will cause the bills to get voided If bills were in a closed batch, and downstream processes had already run, those processes will not get reversed * * @param batchId Batch to move to * @param body List of bills to be moved to the new batch */ moveBatch(batchId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the list of given bills to the specified destination account and meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. * * @param body DTO containing a list of Bill Ids, the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope cateogory and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. */ moveBillsToAccount(body?: BillActionMove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action. Custom bill actions are setup as webhooks * * @param body */ processBillCustomAction(body?: BillActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates reversal bills for the given bill ids considering multiple open batch options. * * @param body */ reverseBillsWithMultipleOpenBatchOptions(body?: BillReversalRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param body */ setBillAccrualExclusion(body?: BillAccrualExclusionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Marks one or more bills as unexported. * * @param body An array of bill ids to be marked as unexported and export mode */ unexportBills(body?: BillUnexport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Marks one or more bills as unexported. The bills to be unexported are selected based on the guid passed in. The guid is generated when bills are exported via the bill export end point, and the guid is returned in the header of the response in a field named Ec-Guid. * * @param billExportGuid The identifier for the bills to be unexported */ unexportBillsByGuid(billExportGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Upload a file representing a bill image. The bill image file extension must match the settings in system data 'webbillimageext'. * * @param billId The Bill ID associated with the file being uploaded. * @param fileName The name of the file containing the bill image * @param body Binary data containing the bill image */ uploadBillImage(billId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update approved flag for the given billIDs * * @param body approve action */ billActionApproveWithHttpInfo(body?: BillActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete given billIDs * * @param body */ billActionDeleteWithHttpInfo(body?: BillActionDelete, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update export hold flag for the given billIDs * * @param body export hold action */ billActionExportHoldWithHttpInfo(body?: BillActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run the bill split processor on the given list of bills. Optional note can be provided. Optional batch settings can be provided that will allow custom batchcode and bill headers for the destination bills * * @param body */ billActionSplitWithHttpInfo(body?: BillActionSplit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update all headers for a given list of bills If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bill audits won't be fired * * @param body Bill header update action */ billActionUpdateHeadersWithHttpInfo(body?: BillActionHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update void flag for the given billIDs * * @param body Void action */ billActionVoidWithHttpInfo(body?: BillActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each record in the request body, update the bill payment details. * * @param body List of Bill payment details */ billPaymentDetailsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the import file, update the bill payment details. * The import file needs to be a comma separated file. All lines are data lines (No header line allowed). The file structure is as follows- Bill Id (required), Check Number (required), Check Date YYYYMMDD format (required), Pay Status (upto 10 characters- do not use commas) (required), Cleared Date YYYYMMDD format (optional), Accounting Period YYYYMM (optional), comment (optional) - comment will be ignored. Example data:12345,7098,20210801,Procesed,20210806,202107,July bill paid via AP For this request, please use application/octet-stream as Content-Type and include your file as binary in the body of the request. /// * @param body Binary data containing the file contents */ billPaymentDetailsFileWithHttpInfo(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Cleans a single bill. The dirty flag of the bill is not taken into account. * * @param billId */ cleanABillWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Cleans all dirty bills, and any bills created outside of version 7. * */ cleanDirtyBillsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new bill * Creates a bill. The created bill gets audited. If any audits fail, the bill will get flagged. If the audit setting for any of the failed audits is set to Fail and Hold, the bill will be set as \"Hold from Accounting Export\" If saveAsResolved property is set to true, the flagged bill will be automatically resolved and Released for Accounting Export * @param saveAsResolved Controls whether or not any failed audits automatically get marked as resolved * @param comment Optional comment to explain why the audit is being auto resolved * @param body */ createBillWithHttpInfo(saveAsResolved?: boolean, comment?: string, body?: BillCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Persist an payment event for several bills * * @param body Payment event creation payload */ createBillPaymentEventWithHttpInfo(body?: BillPaymentEventCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the request body which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param body Distribution information */ distributeAccountChargesToMetersWithHttpInfo(body?: DistributeAccountChargesToBillsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a bill custom field * * @param billId The id of the bill * @param udfId The id of the custom field */ downloadBillCustomFieldFileWithHttpInfo(billId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing bill * If enabled, audits will be processed for the edited bill. If specified, any issues previously resolved will be reopened. Below are some clarifications regarding the rules for editing an existing bill: * Bills which are marked as \"void\" may not be edited * Users without UpdateApprovedBills.Edit permission may not edit bills marked as \"Approved\" * Users without ExportBills.Edit permission may not edit bills exported to AP or GL * Bills must have at least one line item * If configured, required bill headers will be enforced * @param billId * @param body */ editBillWithHttpInfo(billId: number, body?: BillEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a bill * * @param billId The id of the bill * @param body The list of udf values being edited */ editBillCustomFieldsWithHttpInfo(billId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the text of a standard EnergyCAP bill export ini file for AP, GL and Payment purposes. Payment details will be included in the profile if workflow settings for the bill export are configured to include payment details. * * @param exportMode Specifies whether the profile should be for AP, GL or Payment. Pass in \"AP\" for AP Profile, \"GL\" for GL Profile or \"Payment\" for Payment Profile. If this is not included in the request, it defaults to AP. */ exportBillProfileWithHttpInfo(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves text of a standard EnergyCAP bill export file for AP, GL and payment purposes. Maximum of 10000 bills can be processed at one time. Only bills with the following conditions are included in the export file: 1) approved bills (if the approval system is enabled in workflow settings) 2) bill is in a closed batch (if after batch or after batch approval is set in the workflow settings) 3) bill is not held for export 4) bill is not void 5) bill is within the user's topmost setting. 6) bill in not already exported * * @param body */ exportBillsWithHttpInfo(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a JSON array of bill details. * * @param body List of bill IDs */ exportBillsAsJsonWithHttpInfo(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill history for an account * * @param accountId accountId to get bill history for * @param billingPeriod required: billingPeriod in yyyymm format to return history from * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getAccountBillHistoryWithHttpInfo(accountId: number, billingPeriod?: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylinesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one bill * * @param billId The bill identifier */ getBillWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterActualByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter calendarized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterCalendarizedByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter normalized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterNormalizedByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter statistics record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterStatisticsByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActualWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatisticsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one bill's bodylines * * @param billId The bill identifier */ getBillBodylinesWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get custom field values for a bill * * @param billId The id of the bill */ getBillCustomFieldsWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all data necessary to load the bill entry screen * * @param accountId * @param beginDate * @param batchId */ getBillEntryDataWithHttpInfo(accountId: number, beginDate?: Date, batchId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data necessary to load the bill entry screen * * @param billId */ getBillEntryDataByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill history from starting at the billId billing period * * @param billId billId to get bill history for * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getBillHistoryWithHttpInfo(billId: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of bill line type mappings * */ getBillLineTypeMappingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the payment events for a bill * * @param billId Identifier for the bill */ getBillPaymentEventsWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bills * * @param body List of Bill Ids to be used to determine the commodities to be matched on the destination accounts. */ getPossibleDestinationAccountsWithHttpInfo(body?: ListIds, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the set of bills to the specified batch The bills being moved could be in an open, pending or closed batch The specified batch should be an open or pending batch All the bills being moved should be in the same batch Moving from a pending to an open will cause the bills to get un-voided Moving from an open/closed to a pending will cause the bills to get voided If bills were in a closed batch, and downstream processes had already run, those processes will not get reversed * * @param batchId Batch to move to * @param body List of bills to be moved to the new batch */ moveBatchWithHttpInfo(batchId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the list of given bills to the specified destination account and meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. * * @param body DTO containing a list of Bill Ids, the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope cateogory and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. */ moveBillsToAccountWithHttpInfo(body?: BillActionMove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action. Custom bill actions are setup as webhooks * * @param body */ processBillCustomActionWithHttpInfo(body?: BillActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates reversal bills for the given bill ids considering multiple open batch options. * * @param body */ reverseBillsWithMultipleOpenBatchOptionsWithHttpInfo(body?: BillReversalRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param body */ setBillAccrualExclusionWithHttpInfo(body?: BillAccrualExclusionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Marks one or more bills as unexported. * * @param body An array of bill ids to be marked as unexported and export mode */ unexportBillsWithHttpInfo(body?: BillUnexport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Marks one or more bills as unexported. The bills to be unexported are selected based on the guid passed in. The guid is generated when bills are exported via the bill export end point, and the guid is returned in the header of the response in a field named Ec-Guid. * * @param billExportGuid The identifier for the bills to be unexported */ unexportBillsByGuidWithHttpInfo(billExportGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Upload a file representing a bill image. The bill image file extension must match the settings in system data 'webbillimageext'. * * @param billId The Bill ID associated with the file being uploaded. * @param fileName The name of the file containing the bill image * @param body Binary data containing the bill image */ uploadBillImageWithHttpInfo(billId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCategoryResponse { /** * The cost category identifier Required (defined) */ costCategoryId: number | null | undefined; /** * Name of the cost category Required (defined) */ costCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountBillAccountChargeSplitSettingsResponse { /** * The account identifier */ accountId: number | null | undefined; /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; /** * Split account charges with a bill line type assigned to the cost categories */ costCategories: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountChargeSplitMethodRequest { /** * During bill import a bill's account charges will be distributed to the account's meters either by \"Use\" or \"Cost\" null means the charges will not be distributed One of 'Use', 'Cost' Required (defined) */ splitBillChargesMethod: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountChargeSplitMethodResponse { /** * During bill import a bill's account charges will be distributed to the account's meters either by \"Use\" or \"Cost\" null means the charges will not be distributed */ splitBillChargesMethod: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountChargeSplitSettingResponse { /** * The account identifier Account properties will be null when the setting applies to all accounts for a vendor If there is a specific account defined this setting will override the vendor settings */ accountId: number | null | undefined; /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; /** * Split account charges with a bill line type assigned to the cost categories */ costCategories: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillAccountChargeSplitSettingsResponse { billAccountChargeSplitMethod: BillAccountChargeSplitMethodResponse | null | undefined; /** * During bill import a bill's account charges will be distributed to the account's meters based on the account, vendor, and cost category */ billAccountChargeSplitSettings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorBillAccountChargeSplitSettingsResponse { /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code that the caption maps to */ vendorCode: string | null | undefined; /** * The vendor info that the caption maps to */ vendorInfo: string | null | undefined; /** * Split account charges with a bill line type assigned the cost categories */ costCategories: Array | null | undefined; } declare class BillAccountChargeSplitService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a specific account's setting to split account charges on bill import * * @param accountId Account identifier */ deleteAccountBillAccountChargeSplitSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a specific vendor's setting to split account charges on bill import * * @param vendorId Vendor identifier */ deleteVendorBillAccountChargeSplitSettings(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a specific account's setting to split account charges on bill import If a rule does not currently exist for this account it is created otherwise it is updated * * @param accountId Account identifier * @param body */ editAccountBillAccountChargeSplitSettings(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the method used to split account charges on bill import * * @param body Method used to split account charges on bill import */ editBillAccountChargeSplitMethod(body?: BillAccountChargeSplitMethodRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a specific vendor's setting to split account charges on bill import If a rule does not currently exist for this vendor it is created otherwise it is updated * * @param vendorId Vendor identifier * @param body */ editVendorBillAccountChargeSplitSettings(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a specific account's settings to split account charges on bill import * * @param accountId Account identifier */ getAccountBillAccountChargeSplitSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the method used to split account charges on bill import * */ getBillAccountChargeSplitMethod(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettings(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a specific vendor's settings to split account charges on bill import * * @param vendorId Vendor identifier */ getVendorBillAccountChargeSplitSettings(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a specific account's setting to split account charges on bill import * * @param accountId Account identifier */ deleteAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a specific vendor's setting to split account charges on bill import * * @param vendorId Vendor identifier */ deleteVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a specific account's setting to split account charges on bill import If a rule does not currently exist for this account it is created otherwise it is updated * * @param accountId Account identifier * @param body */ editAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the method used to split account charges on bill import * * @param body Method used to split account charges on bill import */ editBillAccountChargeSplitMethodWithHttpInfo(body?: BillAccountChargeSplitMethodRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a specific vendor's setting to split account charges on bill import If a rule does not currently exist for this vendor it is created otherwise it is updated * * @param vendorId Vendor identifier * @param body */ editVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific account's settings to split account charges on bill import * * @param accountId Account identifier */ getAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the method used to split account charges on bill import * */ getBillAccountChargeSplitMethodWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettingsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific vendor's settings to split account charges on bill import * * @param vendorId Vendor identifier */ getVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines details for a dynamic percentage split of use, cost, or both based on the use or cost values of the meters in the destination meter group. */ declare class DynamicPercentageBillSplit { /** * ID of a meter group to receive the results of the split bill. Required */ destinationMeterGroupId: number | null; /** * Value to distribute to the destination meters. Required One of 'use', 'cost', 'useAndCost' */ sourceValueToSplit: string | null; /** * Value to define how dynamic percentages are calculated. Required One of 'use', 'cost' */ destinationShareValue: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FixedPercentage { /** * Destination account ID Required Topmost (CostCenter) */ destinationAccountId: number | null; /** * Destination meter ID The DestinationMeterId commodity must match the commodity Required Topmost (LogicalDevice) */ destinationMeterId: number | null; /** * Fixed percentage to apply in bill split for this account and meter Pass the percentage value For example 50.5% should be 50.5 Max scale of 8 Required */ splitPercentage: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FloorAreaSplit { /** * Destination account ID There must be an existing relationship between the DestinationAccountId and DestinationMeterId Required Topmost (CostCenter) */ destinationAccountId: number | null; /** * Destination meter ID There must be an existing relationship between the DestinationAccountId and DestinationMeterId Required Topmost (LogicalDevice) */ destinationMeterId: number | null; /** * Weighting factor to apply in floor area bill split for this account and meter Max scale of 8 Required Must be between 0 and 1.7976931348623157E+308 */ weightingFactor: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines details for available types of bill split distributions. Only one of the properties may be populated. */ declare class BillSplitDetailsRequest { /** * Populate if setting up a fixed percentage split. You cannot split to the same account and meter combination multiple times within a single version. The destination account cannot be the same as the master account Cannot be Empty NULL Valid Required (defined) Only one of FixedPercentageSplit, FloorAreaSplit, DynamicPercentageSplit can be set */ fixedPercentageSplit: Array | null | undefined; /** * Populate if setting up a dynamic percentage split based on the building floor area with weighting factor applied. You cannot split the same account and meter multiple times within a single version. You cannot split to the same account and meter combination multiple times within a single version. The destination account cannot be the same as the master account Cannot be Empty NULL Valid Required (defined) Only one of FixedPercentageSplit, FloorAreaSplit, DynamicPercentageSplit can be set */ floorAreaSplit: Array | null | undefined; dynamicPercentageSplit: DynamicPercentageBillSplit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountChildWithType { accountType: AccountTypeChild | null | undefined; /** * */ accountId: number | null | undefined; /** * */ accountCode: string | null | undefined; /** * */ accountInfo: string | null | undefined; vendor: VendorChild | null | undefined; /** * */ active: boolean | null | undefined; /** * */ hasCalculatedMeter: boolean | null | undefined; /** * */ hasSplitParentMeter: boolean | null | undefined; /** * */ hasSplitChildMeter: boolean | null | undefined; /** * */ isSubAccount: boolean | null | undefined; /** * */ hasSubAccount: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributionVersionResponse { /** * Identifier for the version */ versionId: number | null | undefined; /** * Name given to a version */ versionInfo: string | null | undefined; /** * The chargeback type. Either \"Split\" or \"Calculation\" */ chargebackType: string | null | undefined; /** * Begin period for the version */ beginPeriod: number | null | undefined; /** * End period for the version null value means continuing indefinitely */ endPeriod: number | null | undefined; account: AccountChildWithType | null | undefined; meter: MeterChild | null | undefined; workflow: ChargebackWorkflowStepChild | null | undefined; /** * Do any bills exist that were created by this version? A version cannot be deleted if there are any existing bills that were created using this version */ hasBills: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupChild { /** * The meter group identifier */ meterGroupId: number | null | undefined; /** * The meter group code */ meterGroupCode: string | null | undefined; /** * The meter group info */ meterGroupInfo: string | null | undefined; /** * Indicates if this meter group is an autogroup */ autoGroup: boolean | null | undefined; /** * Indicates if this meter group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines details for a dynamic percentage split of use, cost, or both based on the use or cost values of the meters in the destination meter group. */ declare class DynamicPercentageBillSplitResponse { destinationMeterGroup: MeterGroupChild | null | undefined; /** * Value to distribute to the destination meters \"use\", \"cost\", or \"useAndCost\" */ sourceValueToSplit: string | null | undefined; /** * Value to define how dynamic percentages are calculated. \"use\" or \"cost\" */ destinationShareValue: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillSplitPlaceSizeChild { /** * */ placeSizeId: number | null | undefined; /** * */ beginDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; /** * */ value: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceChildWithFloorArea { currentFloorArea: BillSplitPlaceSizeChild | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FixedPercentageResponse { destinationAccount: AccountChildWithType | null | undefined; destinationMeter: MeterChild | null | undefined; destinationPlace: PlaceChildWithFloorArea | null | undefined; /** * Fixed percentage to apply in bill split for this account and meter */ splitPercentage: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FloorAreaSplitResponse { destinationAccount: AccountChildWithType | null | undefined; destinationMeter: MeterChild | null | undefined; destinationPlace: PlaceChildWithFloorArea | null | undefined; /** * Weighting factor to apply in floor area bill split for this account and meter */ weightingFactor: number | null | undefined; /** * Fixed percentage to apply in bill split for this account and meter */ splitPercentage: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Details of the bill split FixedPercentageSplit, FloorAreaSplit, and DynamicPercentageSplit are mutually exclusive Only 1 of these properties will have a value */ declare class BillSplitDetailsResponse { version: DistributionVersionResponse | null | undefined; /** * Populate if setting up a fixed percentage split. */ fixedPercentageSplit: Array | null | undefined; /** * Populate if setting up a dynamic percentage split based on the building floor area with weighting factor applied. */ floorAreaSplit: Array | null | undefined; dynamicPercentageSplit: DynamicPercentageBillSplitResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillSplitParentDetailsResponse { splitParentAccount: AccountChild | null | undefined; splitParentMeter: MeterChild | null | undefined; /** * First billing period that the bill split was active for */ beginPeriod: number | null | undefined; /** * Last billing period that the bill split was active for */ endPeriod: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackTaskVersionResponse { /** * The specific version id within the task we are reporting on */ versionId: number | null | undefined; /** * The number of bills created for this version within the task */ numberOfBillsCreated: number | null | undefined; /** * Error that may have occurred when running this version within the task */ errorMessage: string | null | undefined; /** * The billids of all the destination bills created by this version within the task */ destinationBillIds: Array | null | undefined; /** * If this was a bill split task, then ID of the bill that was split by this version within the task */ sourceBillId: number | null | undefined; /** * Identifier for the task */ taskId: number | null | undefined; workflow: ChargebackWorkflowStepChild | null | undefined; /** * Begin date when the task started */ taskBegin: Date | null | undefined; /** * End date when the task ended */ taskEnd: Date | null | undefined; user: UserChild | null | undefined; /** * The billing period the task was run for */ billingPeriod: number | null | undefined; batch: BatchChild | null | undefined; /** * The task's settings */ settings: any | null | undefined; /** * User comments on the task */ comment: string | null | undefined; /** * Current status of the task */ status: string | null | undefined; /** * The chargeback type. Either \"Split\" or \"Calculation\" */ chargebackType: string | null | undefined; reversedBy: UserChild | null | undefined; /** * The date when all bills generated by the task were voided or deleted */ reversedDate: Date | null | undefined; /** * The number of bills that are currently analyzing within the task */ numberOfAnalyzingBills: number | null | undefined; /** * The number of unresolved flags on bills within the task */ numberOfUnresolvedFlags: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributionVersionManage { /** * Version id to update VersionId must exist on the account and meter relationship being updated Required (defined) Only one of VersionId, CopyVersionId can be set */ versionId: number | null | undefined; /** * An existing version id on this account meter to copy A new version will be created and all instructions will be copied to the new version CopyVersionId chargeback type must match the chargeback type being managed (Either \"Split\" or \"Calculation\"). CopyVersionId must exist on the account and meter relationship being updated Required (defined) Only one of VersionId, CopyVersionId can be set */ copyVersionId: number | null | undefined; /** * Name given to the version Name must be unique for a particular account and meter Required Must be between 0 and 64 characters */ name: string | null; /** * Workflow step this version will belong to The workflow step type must match the chargeback type being managed (Either \"Split\" or \"Calculation\") Required (defined) */ workflowStepId: number | null | undefined; /** * Begin period for the version in the format YYYYMM Cannot overlap any existing versions on this account and meter for the chargeback type being managed Required Valid billing period between 190001 and 300001 */ beginPeriod: number | null; /** * End period for the version in the format YYYYMM null value means continuing indefinitely Cannot overlap any existing versions on this account and meter for the chargeback type being managed Valid billing period between 190001 and 300001 NULL Valid Must be greater than or equal to BeginPeriod Required (defined) */ endPeriod: number | null | undefined; } declare class BillSplitService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get bill split parent information for an account * * @param accountId ID of the account */ getAccountBillSplitParentDetails(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all chargeback tasks with details for a specific version on an account and meter * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitChargebackTaskByVersion(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get details for a bill split distribution * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitDetails(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of bill split versions on this account and meter relationship * * @param accountId ID of the account to get all assigned bill split versions * @param meterId ID of the meter to get all assigned bill split versions */ getBillSplitVersionHistory(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions on an account * * @param accountId ID of the account to get all assigned bill split versions */ getBillSplits(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill split parent information for a meter * * @param meterId ID of the meter */ getMeterBillSplitParentDetails(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage details for a bill split distribution * * @param accountId ID of the master account * @param meterId ID of the master meter * @param versionId ID of the version to update bill split details * @param body Definition of details for bill split */ manageBillSplitDetails(accountId: number, meterId: number, versionId: number, body?: BillSplitDetailsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage a bill split's version history All bill split versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a bill split version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account whose bill split versions will be updated * @param meterId ID of the meter whose bill split versions will be updated * @param body List of bill split distribution versions to add or edit */ manageBillSplitVersionHistory(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill split parent information for an account * * @param accountId ID of the account */ getAccountBillSplitParentDetailsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all chargeback tasks with details for a specific version on an account and meter * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitChargebackTaskByVersionWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get details for a bill split distribution * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions on this account and meter relationship * * @param accountId ID of the account to get all assigned bill split versions * @param meterId ID of the meter to get all assigned bill split versions */ getBillSplitVersionHistoryWithHttpInfo(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of bill split versions on an account * * @param accountId ID of the account to get all assigned bill split versions */ getBillSplitsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get bill split parent information for a meter * * @param meterId ID of the meter */ getMeterBillSplitParentDetailsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage details for a bill split distribution * * @param accountId ID of the master account * @param meterId ID of the master meter * @param versionId ID of the version to update bill split details * @param body Definition of details for bill split */ manageBillSplitDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: BillSplitDetailsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage a bill split's version history All bill split versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a bill split version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account whose bill split versions will be updated * @param meterId ID of the meter whose bill split versions will be updated * @param body List of bill split distribution versions to add or edit */ manageBillSplitVersionHistoryWithHttpInfo(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillCalendarizedHistory { /** * Billing Period (YYYYMM) */ billingPeriod: number | null | undefined; /** * Calendarized Month */ month: number | null | undefined; /** * Calendarized Year */ year: number | null | undefined; /** * Is this period within the last year */ current: boolean | null | undefined; /** * Account ID */ accountId: number | null | undefined; /** * Meter ID */ meterId: number | null | undefined; /** * Use per day (native) */ usePerDay: number | null | undefined; /** * Use unit name (native) */ useUnit: string | null | undefined; /** * Cost per day */ costPerDay: number | null | undefined; /** * Unit cost */ unitCost: number | null | undefined; /** * Cost unit name */ costUnit: string | null | undefined; /** * Demand (native) */ demand: number | null | undefined; /** * Demand unit name (native) */ demandUnit: string | null | undefined; /** * Actual Demand (native) */ actualDemand: number | null | undefined; /** * Actual Demand unit name (native) */ actualDemandUnit: string | null | undefined; /** * Billed Demand (native) */ billedDemand: number | null | undefined; /** * Billed Demand unit name (native) */ billedDemandUnit: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillViewAddressChild { /** * The address type identifier */ addressTypeId: number | null | undefined; /** * The line 1 of the address */ line1: string | null | undefined; /** * The line 2 of the address */ line2: string | null | undefined; /** * The line 2 of the address */ line3: string | null | undefined; /** * The city of the address */ city: string | null | undefined; /** * The state of the address */ state: string | null | undefined; /** * The country of the address */ country: string | null | undefined; /** * The postal code of the address */ postalCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillViewVendorChild { /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; address: BillViewAddressChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillViewAccountChild { /** * */ accountId: number | null | undefined; /** * */ accountCode: string | null | undefined; /** * */ accountInfo: string | null | undefined; /** * */ auditEnabled: boolean | null | undefined; accountType: AccountTypeChild | null | undefined; address: BillViewAddressChild | null | undefined; vendor: BillViewVendorChild | null | undefined; generalLedger: GeneralLedgerChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillViewMeterChild { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * The meter's serial number */ serialNumber: string | null | undefined; rate: RateChild | null | undefined; place: PlaceChild | null | undefined; generalLedger: GeneralLedgerChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BodylineChild { /** * The bodyline identifier */ bodyLineId: number | null | undefined; /** * The account identifier */ accountId: number | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The display order */ displayOrder: number | null | undefined; /** * The caption */ caption: string | null | undefined; /** * The bodyline's value */ value: number | null | undefined; /** * */ valueIsInfoOnly: boolean | null | undefined; /** * The cost attributed to the bodyline */ cost: number | null | undefined; /** * Is the cost value counted towards the overall total cost or info only */ costIsInfoOnly: boolean | null | undefined; valueUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; observationType: ObservationTypeChild | null | undefined; generalLedger: GeneralLedgerChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillViewResponse { /** * The bill identifier */ billId: number | null | undefined; /** * Indicates if the bill has been voided */ void: boolean | null | undefined; /** * Indicates if the bill is from a vendor */ fromVendor: boolean | null | undefined; /** * The method used to create the bill Automatic, Manual, Estimated, Simulated, Accrual, or Adjustment */ creationMethod: string | null | undefined; /** * Indicates if the bill is an accrual */ accrual: boolean | null | undefined; /** * Indicates if the bill is a reversed accrual */ accrualReversed: boolean | null | undefined; batch: BatchChild | null | undefined; /** * The date the batch was closed */ batchEndDate: Date | null | undefined; /** * Do y'all need to have a batch code? */ hideBatchCode: boolean | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the bill was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Indicates if the bill has been approved */ approved: boolean | null | undefined; /** * The date and time the bill was approved */ approveDate: Date | null | undefined; approvedBy: UserChild | null | undefined; /** * Indicates if the bill has been split */ hasBeenSplit: boolean | null | undefined; /** * The date and time the bill was split */ wasSplitDate: Date | null | undefined; /** * Indicates if the bill is being withheld from bill exports */ exportHold: boolean | null | undefined; /** * Indicates if the bill has been ap exported */ apExported: boolean | null | undefined; /** * The date and time the bill was ap exported */ apExportDate: Date | null | undefined; apExportedBy: UserChild | null | undefined; /** * Indicates if the bill has been gl exported */ glExported: boolean | null | undefined; glExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to gl */ glExportDate: Date | null | undefined; /** * Indicates if the bill has been exported to bill payment */ paymentExported: boolean | null | undefined; paymentExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to bill payment */ paymentExportDate: Date | null | undefined; /** * The number of the check that the bill was paid with */ checkNumber: string | null | undefined; /** * The date and time of the check */ checkDate: Date | null | undefined; /** * The payment status of the bill */ payStatus: string | null | undefined; /** * The date when funds were withdrawn */ fundsWithdrawnDate: Date | null | undefined; /** * The date and time that the check cleared */ clearedDate: Date | null | undefined; /** * The payment type of the bill. For example, Check, VCard, and ACH. */ paymentType: string | null | undefined; /** * The net amount of the payment event of the bill */ paymentAmount: number | null | undefined; /** * The API URL that can be used to download the file of the payment voucher */ paymentVoucher: string | null | undefined; /** * The API URL that can be used to download the file of the check image */ checkImage: string | null | undefined; /** * The method used to upload the bill to BillCAPture */ bcAcquisitionMethod: string | null | undefined; /** * The date and time the bill was received by BillCAPture */ bcReceived: Date | null | undefined; /** * The date and time the bill was sent to the processor */ bcSentToProcessing: Date | null | undefined; /** * The date and time the bill completed processing */ bcReturnedFromProcessing: Date | null | undefined; /** * The date and time the bill was finished processing in BillCAPture */ bcProcessingComplete: Date | null | undefined; account: BillViewAccountChild | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's number of days */ days: number | null | undefined; /** * The bill's accounting period */ accountPeriod: number | null | undefined; /** * The bill's accounting period name */ accountPeriodName: string | null | undefined; /** * Is account period required? */ hideAccountPeriod: boolean | null | undefined; /** * Is account year required? What is it? */ hideAccountYear: boolean | null | undefined; /** * The bill's total cost in the system currency. The system currency is the reporting/global currency unit. */ totalCost: number | null | undefined; /** * The bill's total cost in the source currency. The source currency is the native currency unit. */ totalSourceCost: number | null | undefined; costConversion: CostConversion | null | undefined; /** * The bill's balance */ balance: number | null | undefined; /** * Indicates if the bill is estimated */ estimated: boolean | null | undefined; /** * Is estimated flag required? */ hideEstimated: boolean | null | undefined; /** * The date of the billing statement */ statementDate: Date | null | undefined; /** * Is statement date required? */ hideStatementDate: boolean | null | undefined; /** * The date and time the bill is due */ dueDate: Date | null | undefined; /** * Is due date required? */ hideDueDate: boolean | null | undefined; /** * The bill's invoice number */ invoiceNumber: string | null | undefined; /** * Is Invoice Number Required? */ hideInvoiceNumber: boolean | null | undefined; /** * The bill's control code */ controlCode: string | null | undefined; /** * Is control code required? */ hideControlCode: boolean | null | undefined; /** * The fully qualified url to the bill image */ billImageUrl: string | null | undefined; /** * Bill note */ billNote: string | null | undefined; /** * The bill's next reading date */ nextReading: Date | null | undefined; /** * Is next reading date required? */ hideNextReading: boolean | null | undefined; /** * Bill ID for the bill on this account that immediately precedes this bill (used for navigating back to the prior bill) */ priorBillId: number | null | undefined; /** * Bill ID for the bill on this account that immediately follows this bill (used for navigating to the next bill) */ nextBillId: number | null | undefined; /** * The bill history */ billHistory: Array | null | undefined; /** * The list of meters on the bill */ meters: Array | null | undefined; /** * The list of body lines on the bill */ bodyLines: Array | null | undefined; /** * The list of account-meter summaries on the bill */ billAccountMeters: Array | null | undefined; /** * Calendarized history information for the account */ calendarizedHistory: Array | null | undefined; reversalDetails: BillReversal | null | undefined; /** * Indicates whether this bill is excluded from accruals or not */ excludedFromAccruals: boolean | null | undefined; /** * Indicates whether this bill is currently being analyzed */ analyzing: boolean | null | undefined; /** * The latest date the payment was canceled */ paymentCanceledDate: Date | null | undefined; } declare class BillViewService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves properties for bill view * * @param billId The bill identifier */ getBillView(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves properties for bill view * * @param billId The bill identifier */ getBillViewWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetCreate { /** * The budget name Max length of 50 Required */ budgetInfo: string | null; /** * The notes attached to this budget Max length of 255 */ note: string | null | undefined; /** * The fiscal year this budget represents Required */ budgetFiscalYear: number | null; /** * Number of years of data to include in the budget calculations Required */ numberOfDataYears: number | null; /** * The last period that should be included in the budget calculations (inclusive) Required */ dataYearsEndPeriod: number | null; /** * The calendarization method this budget will use Required One of '1', '2' Case sensitive */ budgetPeriodTypeId: number | null; /** * The type of data this budget will use in its calculations. If BudgetPeriodTypeId is set to 2 (Accounting Period), this must be set to 1 (Billing Period) Required One of '2', '1' Case sensitive */ budgetDataTypeId: number | null; /** * The method used to calculate the baseline budget values. If NumberOfDataYears is 1, this value is ignored and the data from the selected year is used Required One of '2', '3', '4', '1' Case sensitive */ budgetUsageMethodId: number | null; /** * Flag to indicate if inactive accounts should be included in the budget calculations Required */ includeInactiveAccounts: boolean | null; /** * Flag to indicate if inactive meters should be included in the budget calculations Required */ includeInactiveMeters: boolean | null; /** * Flag to indicate if inactive account/meter relationships should be included in the budget calculations Required */ includeInactiveAccountMeters: boolean | null; /** * Flag to indicate if internal chargeback bills should be included in the budget calculations Required */ includeChargebackBills: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetDataType { /** * The budget data type identifier */ budgetDataTypeId: number | null | undefined; /** * The budget data type name */ budgetDataTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetEdit { /** * The budget name Must be between 0 and 50 characters Required (defined) */ budgetInfo: string | null | undefined; /** * Notes for the budget Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetPeriodType { /** * The budget period type identifier */ budgetPeriodTypeId: number | null | undefined; /** * The budget period type name */ budgetPeriodTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetUsageMethod { /** * The budget usage method identifier */ budgetUsageMethodId: number | null | undefined; /** * The budget usage method name */ budgetUsageMethodInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TaskChild { /** * Identifier for the Task */ taskId: number | null | undefined; /** * GUID for the Task */ taskGUId: string | null | undefined; /** * Status of the task */ status: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetResponse { /** * The budget identifier */ budgetId: number | null | undefined; /** * The budget name */ budgetInfo: string | null | undefined; /** * The budget fiscal year */ budgetYear: number | null | undefined; /** * The number of versions associated with this budget */ numberOfVersions: number | null | undefined; /** * The highest version number associated with this budget */ maxVersionNumber: number | null | undefined; createdBy: UserChild | null | undefined; /** * The date when the version was created */ createdDate: Date | null | undefined; /** * The total budget of the active version */ activeTotalBudget: number | null | undefined; /** * Notes for the budget */ notes: string | null | undefined; budgetPeriodType: BudgetPeriodType | null | undefined; budgetDataType: BudgetDataType | null | undefined; /** * Number of years used to generate the budget */ yearsOfData: number | null | undefined; /** * Ending period for the budget */ endPeriod: number | null | undefined; budgetUsageMethod: BudgetUsageMethod | null | undefined; /** * Should the budget include inactive accounts */ includeInactiveAccounts: boolean | null | undefined; /** * Should the budget include inactive meters */ includeInactiveMeters: boolean | null | undefined; /** * Should the budget include inactive account meters */ includeInactiveAccountMeters: boolean | null | undefined; /** * Should the budget include chargeback bills */ includeChargebackBills: boolean | null | undefined; taskData: TaskChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetVersionCreate { /** * The budget version the new version will be based off of Required */ baseBudgetVersionId: number | null; /** * Name of the new budget version Required */ budgetVersionInfo: string | null; /** * Notes for the new budget version */ budgetVersionNote: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetVersionEdit { /** * The budget version name Must be between 0 and 50 characters Required (defined) */ budgetVersionInfo: string | null | undefined; /** * Notes for the budget Must be between 0 and 255 characters Required (defined) */ notes: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetVersionResponse { /** * The budget version identifier */ budgetVersionId: number | null | undefined; /** * The budget identifier */ budgetId: number | null | undefined; /** * The budget version name */ budgetVersionInfo: string | null | undefined; /** * The budget version number */ versionNumber: number | null | undefined; /** * If this is the active budget version */ active: boolean | null | undefined; /** * Flag that shows if this budget version has been modified beyond its initial state using budget worksheets */ hasBeenModified: boolean | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date when the version was modified */ modifiedDate: Date | null | undefined; /** * The total budget of the budget version */ totalBudget: number | null | undefined; /** * Notes for the budget */ notes: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose value DTO */ declare class ValueWithUnit { /** * Value */ value: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetVersionSummary { /** * Period */ period: number | null | undefined; use: ValueWithUnit | null | undefined; /** * The cost */ cost: number | null | undefined; /** * The average unit cost */ averageUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetVersionSummaryResponse { budgetVersion: BudgetVersionResponse | null | undefined; total: BudgetVersionSummary | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } declare class BudgetService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a budget * * @param body Data representing the budget being created */ createBudget(body?: BudgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a budget version * * @param budgetId The identifier for the budget to create the version on * @param body Data representing the budgetVersion being created */ createBudgetVersion(budgetId: number, body?: BudgetVersionCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a budget * * @param budgetId The identifier for the budget being deleted */ deleteBudget(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being deleted */ deleteBudgetVersion(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a budget * * @param budgetId The identifier for the budget being edited * @param body Data representing the budget being edited */ editBudget(budgetId: number, body?: BudgetEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param body Data representing the budgetVersion being edited */ editBudgetVersion(budgetId: number, versionId: number, body?: BudgetVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the budget by ID * * @param budgetId The identifier for the budget being retrieved */ getBudget(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of available budget data types * */ getBudgetDataTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of budget period types * */ getBudgetPeriodTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of available budget usage methods * */ getBudgetUsageMethods(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific version for a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved */ getBudgetVersion(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the summary for a specific version on a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param commodityId The optional commodity filter */ getBudgetVersionSummary(budgetId: number, versionId: number, commodityId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the versions for a specified budget * * @param budgetId The identifier for the budget to retrieve all versions */ getBudgetVersions(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the budgets * */ getBudgets(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Sets a budget version as active, and all other versions as inactive. * * @param budgetId The identifier for the budget * @param versionId The identifier for the version to set as active */ setBudgetVersionActive(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a budget * * @param body Data representing the budget being created */ createBudgetWithHttpInfo(body?: BudgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a budget version * * @param budgetId The identifier for the budget to create the version on * @param body Data representing the budgetVersion being created */ createBudgetVersionWithHttpInfo(budgetId: number, body?: BudgetVersionCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a budget * * @param budgetId The identifier for the budget being deleted */ deleteBudgetWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being deleted */ deleteBudgetVersionWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a budget * * @param budgetId The identifier for the budget being edited * @param body Data representing the budget being edited */ editBudgetWithHttpInfo(budgetId: number, body?: BudgetEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param body Data representing the budgetVersion being edited */ editBudgetVersionWithHttpInfo(budgetId: number, versionId: number, body?: BudgetVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the budget by ID * * @param budgetId The identifier for the budget being retrieved */ getBudgetWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of available budget data types * */ getBudgetDataTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of budget period types * */ getBudgetPeriodTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of available budget usage methods * */ getBudgetUsageMethodsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a specific version for a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved */ getBudgetVersionWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the summary for a specific version on a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param commodityId The optional commodity filter */ getBudgetVersionSummaryWithHttpInfo(budgetId: number, versionId: number, commodityId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the versions for a specified budget * * @param budgetId The identifier for the budget to retrieve all versions */ getBudgetVersionsWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the budgets * */ getBudgetsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Sets a budget version as active, and all other versions as inactive. * * @param budgetId The identifier for the budget * @param versionId The identifier for the version to set as active */ setBudgetVersionActiveWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SubtractRequest { /** * Meters in this list will have their use or cost subtracted during bill calculation Required (defined) Only one of SubtractMeterIds, SubtractMeterGroupIds can be set */ subtractMeterIds: Array | null | undefined; /** * Distinct meters from these meter groups will have their use or cost subtracted together during the bill calculation System auto groups cannot be used Required (defined) Only one of SubtractMeterIds, SubtractMeterGroupIds can be set */ subtractMeterGroupIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SumRequest { /** * Meters in this list will have their use or cost added together during the bill calculation Required (defined) Only one of SumMeterIds, SumMeterGroupIds can be set */ sumMeterIds: Array | null | undefined; /** * Distinct meters from these meter groups will have their use or cost added together during the bill calculation System auto groups cannot be used Required (defined) Only one of SumMeterIds, SumMeterGroupIds can be set */ sumMeterGroupIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Adding/subtracting calculation involving meters and/or meter groups You must pass in at least 1 thing to sum or subtract */ declare class CalculationRequest { sum: SumRequest | null | undefined; subtract: SubtractRequest | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CalendarizedSumRequest { /** * Meters in this list will have their use or cost added together during the bill calculation Cannot be Empty Required */ sumMeterIds: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Adding calculation involving meters You must pass in at least 1 thing to sum */ declare class CalendarizedCalculationRequest { sum: CalendarizedSumRequest | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines a meter whose use or cost will be copied when calculating a bill The meter may have a commodity which is different than the destination meter When doing the calculation we will sum the use or cost across all accounts this meter is associated with for the billing period begin run */ declare class CopyMeterRequest { /** * Meter from which use or cost will be copied Required Topmost (LogicalDevice) */ meterId: number | null; /** * Percentage of use or cost to copy Pass the percentage value For example 50.5% should be 50.5 Required Max scale of 8 */ percentage: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Fixed amount per unit to apply during bill calculation */ declare class FixedUnitCostRequest { /** * Fixed unit cost Required Max scale of 8 */ unitCost: number | null; /** * Unit to which unit cost is applied Required */ unitId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines how use is calculated for a calculated bill distribution */ declare class CalculatedBillCostRequest { /** * Apply the meter's current rate when calculating bill cost \"true\" is the only valid value for this property One of 'True' Case sensitive Required (defined) Only one of UseCurrentMetersRateSchedule, FixedUnitCost, UnitCostMeterId, FixedAmount, CopyCostFromMeter, CostCalculation, CalendarizedCostCalculation can be set */ useCurrentMetersRateSchedule: boolean | null | undefined; fixedUnitCost: FixedUnitCostRequest | null | undefined; /** * MeterId from where to get the unit cost Required (defined) Only one of UseCurrentMetersRateSchedule, FixedUnitCost, UnitCostMeterId, FixedAmount, CopyCostFromMeter, CostCalculation, CalendarizedCostCalculation can be set */ unitCostMeterId: number | null | undefined; /** * Use a fixed amount for bill cost Max scale of 2 NULL Valid Required (defined) Only one of UseCurrentMetersRateSchedule, FixedUnitCost, UnitCostMeterId, FixedAmount, CopyCostFromMeter, CostCalculation, CalendarizedCostCalculation can be set */ fixedAmount: number | null | undefined; copyCostFromMeter: CopyMeterRequest | null | undefined; costCalculation: CalculationRequest | null | undefined; calendarizedCostCalculation: CalendarizedCalculationRequest | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SubtractResponse { /** * Meters in this list will have their use or cost subtracted during bill calculation */ subtractMeters: Array | null | undefined; /** * Distinct meters from these meter groups will have their use or cost subtracted together during the bill calculation */ subtractMeterGroups: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SumResponse { /** * Meters in this list will have their use or cost added together during the bill calculation */ sumMeters: Array | null | undefined; /** * Distinct meters from these meter groups will have their use or cost added together during the bill calculation */ sumMeterGroups: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Adding/subtracting calculation involving meters and/or meter groups For each type (sum or subtract), expect only one of the properties to be populated (e.g. if SumMeters has values, then SumMeterGroups should not) */ declare class CalculationResponse { sum: SumResponse | null | undefined; subtract: SubtractResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Adding calendarized calculation involving meters */ declare class CalendarizedCalculationResponse { /** * Addition calculation involving meters */ calendarizedSum: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines an account and meter whose use or cost will be copied when calculating a bill */ declare class CopyFromMeterResponse { meter: MeterChild | null | undefined; /** * Percentage of use or cost to copy */ percentage: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Fixed amount per unit to apply during bill calculation */ declare class FixedAmountResponse { /** * Fixed amount */ amount: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateChildResponse { /** * */ rateId: number | null | undefined; /** * */ name: string | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Definition of how a calculated bill will get its cost */ declare class CalculatedBillCostResponse { rateSchedule: RateChildResponse | null | undefined; fixedUnitCost: FixedAmountResponse | null | undefined; unitCostFromMeter: MeterChild | null | undefined; /** * Use a fixed amount for bill cost */ fixedAmount: number | null | undefined; copyCostFromMeter: CopyFromMeterResponse | null | undefined; costCalculation: CalculationResponse | null | undefined; calendarizedCostCalculation: CalendarizedCalculationResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FixedDemandRequest { /** * Fixed demand amount Required Max scale of 6 */ fixedDemandAmount: number | null; /** * Unit to which demand is applied Required */ unitId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CalculatedBillDemandRequest { /** * Use channel data readings to calculate bill demand Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedDemand, UseWatticsDataPoint can be set */ readingsChannelId: number | null | undefined; /** * Use ESA channel data readings to calculate bill demand Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedDemand, UseWatticsDataPoint can be set */ readingsEsaChannelId: number | null | undefined; fixedDemand: FixedDemandRequest | null | undefined; /** * Use SmartAnalytics (Wattics) data readings to calculate bill demand Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedDemand, UseWatticsDataPoint can be set */ useWatticsDataPoint: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ObservationRule { /** * The observation rule identifier */ observationRuleId: number | null | undefined; /** * The observation rule code */ observationRuleCode: string | null | undefined; /** * The observation rule info */ observationRuleInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelChildWithObservationType { type: ObservationTypeChild | null | undefined; rule: ObservationRule | null | undefined; /** * The channel code Combines observationTypeCode:unitCode:observationMethodCode:observationRuleCode:interval in minutes */ channelCode: string | null | undefined; /** * The channel identifier */ channelId: number | null | undefined; /** * The channel interval in seconds. Monthly = 2592000 Weekly = 604800 Daily = 86400 Hourly = 3600 Thirty_Minutes = 1800 Fifteen_Minutes = 900 */ interval: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelChildWithObservationType { /** * */ esaChannelId: number | null | undefined; /** * */ interval: number | null | undefined; /** * */ esaChannelInfo: string | null | undefined; type: ObservationTypeChild | null | undefined; rule: ObservationRule | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WatticsDataPointChild { /** * The identifier for a SmartAnalytics (Wattics) meter */ watticsDataPointId: number | null | undefined; /** * The name for a SmartAnalytics (Wattics) meter */ watticsDataPointInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CalculatedBillDemandResponse { readingsFromChannel: ChannelChildWithObservationType | null | undefined; readingsFromEsaChannel: EsaChannelChildWithObservationType | null | undefined; fixedDemand: FixedAmountResponse | null | undefined; readingsFromWatticsDataPoint: WatticsDataPointChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Definition of how a calculated bill will get its use */ declare class CalculatedBillUseResponse { readingsFromChannel: ChannelChildWithObservationType | null | undefined; readingsFromEsaChannel: EsaChannelChildWithObservationType | null | undefined; fixedAmount: FixedAmountResponse | null | undefined; copyUseFromMeter: CopyFromMeterResponse | null | undefined; useCalculation: CalculationResponse | null | undefined; calendarizedUseCalculation: CalendarizedCalculationResponse | null | undefined; readingsFromWatticsDataPoint: WatticsDataPointChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Representation of a generic \"empty\" bodyline which is not associated with a specific bill or template */ declare class GenericBodylineResponse { observationType: ObservationTypeChild | null | undefined; /** * The caption */ caption: string | null | undefined; /** * The calculation type for the line item. Either \"Fixed\", \"Percentage\", or \"Subtotal\" */ calculationType: string | null | undefined; /** * The bodyline's value */ value: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Response object containing all the details related to calculated bill setup for a meter. Includes use, cost, meter line items, and account line items. */ declare class CalculatedBillDetailsResponse { version: DistributionVersionResponse | null | undefined; use: CalculatedBillUseResponse | null | undefined; cost: CalculatedBillCostResponse | null | undefined; demand: CalculatedBillDemandResponse | null | undefined; /** * Additional meter bodylines to be added to the bill The line items are returned in the correct display order */ meterLineItems: Array | null | undefined; /** * Additional account bodylines to be added to the bill The line items are returned in the correct display order */ accountLineItems: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FixedUseRequest { /** * Fixed use amount Required Max scale of 6 */ fixedUseAmount: number | null; /** * Unit to which use is applied Required */ unitId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Defines how use is calculated for a calculated bill distribution */ declare class CalculatedBillUseRequest { /** * Use monthly channel data readings to calculate bill use Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedAmount, CopyUseFromMeter, UseCalculation, CalendarizedUseCalculation, UseWatticsDataPoint can be set */ readingsChannelId: number | null | undefined; /** * Use ESA channel data readings to calculate bill use Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedAmount, CopyUseFromMeter, UseCalculation, CalendarizedUseCalculation, UseWatticsDataPoint can be set */ readingsEsaChannelId: number | null | undefined; fixedAmount: FixedUseRequest | null | undefined; copyUseFromMeter: CopyMeterRequest | null | undefined; useCalculation: CalculationRequest | null | undefined; calendarizedUseCalculation: CalendarizedCalculationRequest | null | undefined; /** * Use SmartAnalytics (Wattics) data readings to calculate bill use One of 'True' Case sensitive Required (defined) Only one of ReadingsChannelId, ReadingsEsaChannelId, FixedAmount, CopyUseFromMeter, UseCalculation, CalendarizedUseCalculation, UseWatticsDataPoint can be set */ useWatticsDataPoint: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Representation of a generic \"empty\" bodyline which is not associated with a specific bill or template */ declare class GenericBodylineRequest { /** * The observation type For account body lines the observation type must be a charge type Required when CalculationType is set to Fixed, or Percentage */ observationTypeId: number | null | undefined; /** * The caption Must be between 0 and 100 characters Required when CalculationType is set to Fixed, or Percentage, or Subtotal */ caption: string | null | undefined; /** * The calculation type for the line item One of 'Fixed', 'Percentage', 'Subtotal' Required (defined) */ calculationType: string | null | undefined; /** * The bodyline's value When CalculationType is Fixed. Precision max is 2 When CalculationType is Percentage. Precision max is 8 Required when CalculationType is set to Fixed, or Percentage */ value: number | null | undefined; } declare class CalculatedBillService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get calculated bill account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getAccountLineItems(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated cost details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillCost(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated demand details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDemand(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * All details related to calculated bill setup including use, cost, meter line items, and account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDetails(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated use details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillUse(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all chargeback tasks with details for a specific version on an account and meter * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getCalculatedBillChargebackTaskByVersion(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions on this account and meter relationship * * @param accountId ID of the account to get all assigned calculated bill versions * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillVersionHistory(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions on a meter * * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated bill meter line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getMeterLineItems(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill account line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the account line items. */ manageAccountLineItems(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's cost If cost does not exist on the distribution it will be added If one exists it will be saved as the option sent in Since cost is required for the calculated bill distribution to work. One option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its cost */ manageCalculateBillCost(accountId: number, meterId: number, versionId: number, body?: CalculatedBillCostRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage calculated bill's demand If demand does not exist on the distribution it will be added If one exists it will be saved as the option sent in If the dto sends null for both (channel and fixed), then demand will get cleared * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its demand */ manageCalculateBillDemand(accountId: number, meterId: number, versionId: number, body?: CalculatedBillDemandRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage calculated bill's use * If use does not exist on the distribution it will be added * If use already exists it will be saved as the option sent in and any existing inputs will be deleted * Since use is required for the calculated bill distribution to work, one option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its use */ manageCalculateBillUse(accountId: number, meterId: number, versionId: number, body?: CalculatedBillUseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage a calculated bill's version history All calculated bill versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a calculated bill version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param body List of calculated bill distribution versions to add or edit */ manageCalculatedBillVersionHistory(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill meter line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the meter line items */ manageMeterLineItems(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Forces all Account and Meter Chargeback flags in the system to be recalculated * */ recalculateChargebackFlags(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated bill account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getAccountLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get calculated cost details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillCostWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated demand details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDemandWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * All details related to calculated bill setup including use, cost, meter line items, and account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated use details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillUseWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all chargeback tasks with details for a specific version on an account and meter * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getCalculatedBillChargebackTaskByVersionWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions on this account and meter relationship * * @param accountId ID of the account to get all assigned calculated bill versions * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillVersionHistoryWithHttpInfo(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions on a meter * * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get calculated bill meter line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getMeterLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage calculated bill account line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the account line items. */ manageAccountLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage calculated bill's cost If cost does not exist on the distribution it will be added If one exists it will be saved as the option sent in Since cost is required for the calculated bill distribution to work. One option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its cost */ manageCalculateBillCostWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillCostRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's demand If demand does not exist on the distribution it will be added If one exists it will be saved as the option sent in If the dto sends null for both (channel and fixed), then demand will get cleared * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its demand */ manageCalculateBillDemandWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillDemandRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's use * If use does not exist on the distribution it will be added * If use already exists it will be saved as the option sent in and any existing inputs will be deleted * Since use is required for the calculated bill distribution to work, one option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its use */ manageCalculateBillUseWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillUseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage a calculated bill's version history All calculated bill versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a calculated bill version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param body List of calculated bill distribution versions to add or edit */ manageCalculatedBillVersionHistoryWithHttpInfo(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage calculated bill meter line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the meter line items */ manageMeterLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Forces all Account and Meter Chargeback flags in the system to be recalculated * */ recalculateChargebackFlagsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelVersionRequest { /** * The channel multiplier Required Must be between 0 and 999999999999999 Max scale of 16, max precision of 38 */ multiplier: number | null; /** * The channel's unit of measure Required */ unitCode: string | null; /** * The channel's observation rule. Possible values include \"Odometer\" and \"Trip\" Required One of 'Odometer', 'Trip' */ observationRule: string | null; /** * The channel's max reading Required Must be between 0 and 999999999999999 Max scale of 16, max precision of 38 */ maximumReading: number | null; /** * List of user defined/custom fields and values for this version If the Udfs list is null or empty no values are assigned If a udf is omitted no value is assigned to that udf To remove a value from an existing Udf, pass in the UdfId and set the Value to null */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelCreate { /** * The interval of the channel in minutes 15 = FifteenMinute, 30 = ThirtyMinute, 60 = Hourly, 1440 = Daily, 10080 = Weekly, 43200 = Monthly Required One of '15', '30', '60', '1440', '10080', '43200' Case sensitive */ intervalMinutes: number | null; /** * The observation type of the channel Required */ observationTypeCode: string | null; /** * Description of the channel Must be between 0 and 4000 characters */ channelDescription: string | null | undefined; /** * The import identifier for the channel Must be between 0 and 255 characters */ channelImportId: string | null | undefined; channelVersion: ChannelVersionRequest | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelEdit { /** * The interval of the channel. The interval is measured in minutes Standard intervals are 15 = FifteenMinute, 30 = ThirtyMinute, 60 = Hourly, 1440 = Daily, 10080 = Weekly, 43200 = Monthly Required Must be between 1 and 2147483647 */ intervalMinutes: number | null; /** * The observation type of the channel Required */ observationTypeCode: string | null; /** * Description of the channel Must be between 0 and 4000 characters Required (defined) */ channelDescription: string | null | undefined; /** * The import identifier for the channel. Must be between 0 and 255 characters Required (defined) */ channelImportId: string | null | undefined; channelVersion: ChannelVersionRequest | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelVersionResponse { /** * The channel version identifier */ channelVersionId: number | null | undefined; /** * The channel multiplier */ multiplier: number | null | undefined; unit: UnitChild | null | undefined; observationRule: ObservationRule | null | undefined; /** * The channel's max reading */ maximumReading: number | null | undefined; /** * Date this channel version started to be used */ beginDate: Date | null | undefined; /** * Date this channel version stopped being used */ endDate: Date | null | undefined; /** * List of user defined/custom fields and values for this version */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteChild { /** * The route identifier */ routeId: number | null | undefined; /** * The route info */ routeInfo: string | null | undefined; /** * The route code */ routeCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Class derived from MeterChildDTO - has this meter's import id and route information /// */ declare class MeterChildIncludeMeterImportIdAndRoute { /** * Meter's import id */ meterImportId: string | null | undefined; route: RouteChild | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelResponse { /** * The channel identifier */ channelId: number | null | undefined; /** * The interval of the channel. The interval is measured in minutes */ intervalMinutes: number | null | undefined; observationType: ObservationTypeChild | null | undefined; /** * Description of the channel */ channelDescription: string | null | undefined; /** * The import identifier for the channel. */ channelImportId: string | null | undefined; /** * Indicates if the channel has readings */ hasReadings: boolean | null | undefined; /** * Date of the earliest reading for the channel */ firstReadingDate: Date | null | undefined; /** * Date of the most recent reading for the channel */ lastReadingDate: Date | null | undefined; /** * List of channel versions Versions include channel settings that may change over time */ channelVersions: Array | null | undefined; /** * Indicates if the channel is a part of a distribution */ isUsedOnDistribution: boolean | null | undefined; meter: MeterChildIncludeMeterImportIdAndRoute | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelVersionWithBeginDateRequest { /** * Date the channel version started to be used Must be between 12/30/1899 and 12/31/2099 */ beginDate: Date | null | undefined; /** * The channel multiplier Required Must be between 0 and 999999999999999 Max scale of 16, max precision of 38 */ multiplier: number | null; /** * The channel's unit of measure Required */ unitCode: string | null; /** * The channel's observation rule. Possible values include \"Odometer\" and \"Trip\" Required One of 'Odometer', 'Trip' */ observationRule: string | null; /** * The channel's max reading Required Must be between 0 and 999999999999999 Max scale of 16, max precision of 38 */ maximumReading: number | null; /** * List of user defined/custom fields and values for this version If the Udfs list is null or empty no values are assigned If a udf is omitted no value is assigned to that udf To remove a value from an existing Udf, pass in the UdfId and set the Value to null */ udfs: Array | null | undefined; } declare class ChannelService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to add the version to * @param body */ createChannelVersion(meterId: number, channelId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates and assigns a channel to a meter * * @param meterId Id of the meter to link the channel to * @param body Data representing the channel being created */ createMeterChannel(meterId: number, body?: ChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a channel version There must always be one version on a channel If you try and delete the only version on a channel an exception will occur * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to delete */ deleteChannelVersion(meterId: number, channelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a meter's channel All readings linked to this channel will also be deleted. A channel that is part of a distribution cannot be deleted. * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to delete */ deleteMeterChannel(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a channel version custom field * * @param meterId * @param channelId * @param versionId * @param udfId */ downloadChannelVersionCustomFieldFile(meterId: number, channelId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to update * @param body */ editChannelVersion(meterId: number, channelId: number, versionId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates a meter's channel If a channel version exists and is not passed into the request body it will continue to exist and no data will be changed. To delete a specific channel version call DELETE meter/{meterId}/channel/{channelId}/version/{versionId} * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to update * @param body */ editMeterChannel(meterId: number, channelId: number, body?: ChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a channel and its channel versions linked to a meter * * @param meterId Id of the linked meter to retrieve the channel information for * @param channelId Id of the channel to retrieve information for */ getMeterChannel(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all channel and channel versions linked to a meter * * @param meterId Id of the meter to retrieve the channel information for */ getMeterChannels(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to add the version to * @param body */ createChannelVersionWithHttpInfo(meterId: number, channelId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates and assigns a channel to a meter * * @param meterId Id of the meter to link the channel to * @param body Data representing the channel being created */ createMeterChannelWithHttpInfo(meterId: number, body?: ChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a channel version There must always be one version on a channel If you try and delete the only version on a channel an exception will occur * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to delete */ deleteChannelVersionWithHttpInfo(meterId: number, channelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a meter's channel All readings linked to this channel will also be deleted. A channel that is part of a distribution cannot be deleted. * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to delete */ deleteMeterChannelWithHttpInfo(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a channel version custom field * * @param meterId * @param channelId * @param versionId * @param udfId */ downloadChannelVersionCustomFieldFileWithHttpInfo(meterId: number, channelId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to update * @param body */ editChannelVersionWithHttpInfo(meterId: number, channelId: number, versionId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a meter's channel If a channel version exists and is not passed into the request body it will continue to exist and no data will be changed. To delete a specific channel version call DELETE meter/{meterId}/channel/{channelId}/version/{versionId} * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to update * @param body */ editMeterChannelWithHttpInfo(meterId: number, channelId: number, body?: ChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a channel and its channel versions linked to a meter * * @param meterId Id of the linked meter to retrieve the channel information for * @param channelId Id of the channel to retrieve information for */ getMeterChannelWithHttpInfo(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all channel and channel versions linked to a meter * * @param meterId Id of the meter to retrieve the channel information for */ getMeterChannelsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class QuickFilter { /** * Required */ caption: string | null; /** * Required */ operator: string | null; /** * Required */ value: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * The settings used to run the chargeback processor */ declare class ChargebackProcessorSettings { /** * Optional Filters. These will aid in identifying the distributions that should be processed TODO:List applicable filters */ filters: Array | null | undefined; /** * Billing Period to be processed Required Valid billing period between 190001 and 300001 */ billingPeriod: number | null; /** * Optional Start Date for Bill being generated. Only used for Calculate Bill and that too when use is not from sub-meter reading The bills generated will inherit bill headers (accounting period, invoice number, control code, etc ) from the batch Must be between 1899-12-31 and 3000-01-01 */ startDateForBill: Date | null | undefined; /** * Optional End Date for Bill being generated. Only used for Calculate Bill and that too when use is not from sub-meter reading The bills generated will inherit bill headers (accounting period, invoice number, control code, etc ) from the batch Must be greater than StartDateForBill Must be between 1899-12-31 and 3000-01-01 */ endDateForBill: Date | null | undefined; /** * Optional note/comment */ note: string | null | undefined; batchSettings: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackProcessorSettingsWithoutFilters { /** * Billing Period to be processed Required Valid billing period between 190001 and 300001 */ billingPeriod: number | null; /** * Optional Start Date for Bill being generated. Only used for Calculate Bill and that too when use is not from sub-meter reading The bills generated will inherit bill headers (accounting period, invoice number, control code, etc ) from the batch Must be between 1899-12-31 and 3000-01-01 */ startDateForBill: Date | null | undefined; /** * Optional End Date for Bill being generated. Only used for Calculate Bill and that too when use is not from sub-meter reading The bills generated will inherit bill headers (accounting period, invoice number, control code, etc ) from the batch Must be greater than StartDateForBill Must be between 1899-12-31 and 3000-01-01 */ endDateForBill: Date | null | undefined; /** * Optional note/comment */ note: string | null | undefined; batchSettings: BatchCreate | null | undefined; } declare class ChargebackEngineService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Process one or more Bill Split distributions for a specific billing period * * @param body */ executeBillSplitProcessor(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process one or more Calculated Bill distributions for a specific billing period * * @param body */ executeCalculateBillProcessor(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process distributions assigned to a chargeback workflow for a specific billing period. If settings are not provided, the last month will be processed. * * @param chargebackWorkflowId The chargeback workflow id * @param body The processor settings */ executeProcessorByWorkflow(chargebackWorkflowId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process distributions assigned to a chargeback workflow step for a specific billing period * * @param chargebackWorkflowStepId The chargeback workflow step id. * @param body The other processor settings. */ executeProcessorByWorkflowStep(chargebackWorkflowStepId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process one or more Bill Split distributions for a specific billing period * * @param body */ executeBillSplitProcessorWithHttpInfo(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process one or more Calculated Bill distributions for a specific billing period * * @param body */ executeCalculateBillProcessorWithHttpInfo(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process distributions assigned to a chargeback workflow for a specific billing period. If settings are not provided, the last month will be processed. * * @param chargebackWorkflowId The chargeback workflow id * @param body The processor settings */ executeProcessorByWorkflowWithHttpInfo(chargebackWorkflowId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Process distributions assigned to a chargeback workflow step for a specific billing period * * @param chargebackWorkflowStepId The chargeback workflow step id. * @param body The other processor settings. */ executeProcessorByWorkflowStepWithHttpInfo(chargebackWorkflowStepId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackTaskRequest { /** * Comment to add to the task Required */ comment: string | null; } declare class ChargebackTaskService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param taskId Identifier for the chargeback task */ deleteChargebackTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a chargeback task with details * * @param taskId Identifier for the chargeback task */ getChargebackTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a chargeback task's error log as an EXCEL file * * @param taskId Identifier for the chargeback task */ getChargebackTaskErrorFile(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all chargeback tasks with details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getChargebackTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a chargeback task's comment * * @param taskId Identifier for the chargeback task to update * @param body Data representing the comment */ updateChargebackTask(taskId: number, body?: ChargebackTaskRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param taskId Identifier for the chargeback task */ voidChargebackTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param taskId Identifier for the chargeback task */ deleteChargebackTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a chargeback task with details * * @param taskId Identifier for the chargeback task */ getChargebackTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a chargeback task's error log as an EXCEL file * * @param taskId Identifier for the chargeback task */ getChargebackTaskErrorFileWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all chargeback tasks with details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getChargebackTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update a chargeback task's comment * * @param taskId Identifier for the chargeback task to update * @param body Data representing the comment */ updateChargebackTaskWithHttpInfo(taskId: number, body?: ChargebackTaskRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param taskId Identifier for the chargeback task */ voidChargebackTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AssignVersionsToStep { /** * List of calculated bill or bill split version IDs to assign to a chargeback workflow step Required (defined) */ calculateBillVersionIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowStepCreate { /** * Name given to the chargeback workflow step Required Must be between 0 and 64 characters */ chargebackWorkflowStepInfo: string | null; /** * Description for the chargeback workflow step Required Must be between 0 and 255 characters */ chargebackWorkflowStepDescription: string | null; /** * The chargeback type that can be assign to this chargeback workflow step. One of 'Split', 'Calculation' */ chargebackWorkflowStepType: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowCreate { /** * Name given to the chargeback workflow Required Must be between 0 and 64 characters */ chargebackWorkflowInfo: string | null; /** * List of chargeback workflow steps with details Order of the steps in the list determines the steps in the workflow. Cannot be Empty */ chargebackWorkflowSteps: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillingPeriodCostUnitChild { /** * The total cost. */ cost: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillingPeriodUseUnitChild { /** * The total common use. */ use: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillingPeriodUseCostChild { /** * The billing period that the data represents. Will be the current billing period, the same year prior billing period, or the same period prior year billing period. */ billingPeriod: number | null | undefined; /** * The number of bills in the current billing period. */ numberOfBillsInPeriod: number | null | undefined; /** * The number of bills in the current billing period that were generated by this workflow step. */ numberOfBillsInPeriodFromWorkflowStep: number | null | undefined; use: BillingPeriodUseUnitChild | null | undefined; cost: BillingPeriodCostUnitChild | null | undefined; /** * The unit cost for the specified billing period. */ unitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This data is not currently being used, it has been included for completeness. */ declare class BillingPeriodCostUnitDeltaChild { /** * The change in total cost from the current billing period. */ delta: number | null | undefined; /** * The total cost. */ cost: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillingPeriodUseUnitDeltaChild { /** * The change in common use from the current billing period. */ delta: number | null | undefined; /** * The total common use. */ use: number | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillingPeriodUseCostDeltaChild { /** * The billing period that the data represents. Will be the current billing period, the same year prior billing period, or the same period prior year billing period. */ billingPeriod: number | null | undefined; use: BillingPeriodUseUnitDeltaChild | null | undefined; cost: BillingPeriodCostUnitDeltaChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowDigestSplitChild { meter: MeterChild | null | undefined; currentPeriod: BillingPeriodUseCostChild | null | undefined; priorPeriod: BillingPeriodUseCostDeltaChild | null | undefined; priorYear: BillingPeriodUseCostDeltaChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This class inherits all of the billing period summary properties for a source meter and adds a list of billing period summaries for each bill split destination meter. */ declare class ChargebackWorkflowDigestChild { /** * List of billing period summaries for meters that are children of a bill split source meter. This list will be null for calculated source meters. */ splits: Array | null | undefined; meter: MeterChild | null | undefined; currentPeriod: BillingPeriodUseCostChild | null | undefined; priorPeriod: BillingPeriodUseCostDeltaChild | null | undefined; priorYear: BillingPeriodUseCostDeltaChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowDigestResponse { chargebackWorkflowStep: ChargebackWorkflowStepChild | null | undefined; /** * The list of digest results for the latest task executed in the specified billing period. */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowStepEdit { /** * Identifier for the chargeback workflow step If calculateBillWorkflowStepId has a value it will be updated If calculateBillWorkflowStepId is null, a new step will be created Required (defined) */ chargebackWorkflowStepId: number | null | undefined; /** * Name given to the chargeback workflow step Must be unique for a particular type (split or calculation) across all workflows Required Must be between 0 and 64 characters */ chargebackWorkflowStepInfo: string | null; /** * Description for the chargeback workflow step Required Must be between 0 and 255 characters */ chargebackWorkflowStepDescription: string | null; /** * The chargeback type that can be assign to this chargeback workflow step. When editing a step you cannot change the type One of 'Split', 'Calculation' Required (defined) */ chargebackWorkflowStepType: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowEdit { /** * Name given to the chargeback workflow Required Must be between 0 and 64 characters */ chargebackWorkflowInfo: string | null; /** * List of chargeback workflow steps with details Order of the steps in the list determines the steps in the workflow. Cannot be Empty Required (defined) */ chargebackWorkflowSteps: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowStep { /** * Identifier for the chargeback workflow step */ chargebackWorkflowStepId: number | null | undefined; /** * Name given to the chargeback workflow step */ chargebackWorkflowStepInfo: string | null | undefined; /** * Description for the chargeback workflow step */ chargebackWorkflowStepDescription: string | null | undefined; /** * The chargeback type that can be assign to this chargeback workflow step. Either \"Split\" or \"Calculation\" */ chargebackWorkflowStepType: string | null | undefined; /** * The order for this step within the chargeback workflow */ chargebackWorkflowStepOrder: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackWorkflowResponse { /** * List of workflow steps with details */ chargebackWorkflowSteps: Array | null | undefined; /** * Identifier for the chargeback workflow */ chargebackWorkflowId: number | null | undefined; /** * Name given to the chargeback workflow */ chargebackWorkflowInfo: string | null | undefined; } declare class ChargebackWorkflowService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Assign a list of bill split or calculate bill versions to a chargeback workflow step of the same type * * @param chargebackWorkflowStepId ID of the chargeback workflow step to which the versions will be assigned * @param billingPeriod The billing period to validate that the provided versions are effective * @param body The chargeback versions to assign to the provided chargeback workflow step */ assignVersionsToStep(chargebackWorkflowStepId: number, billingPeriod: number, body?: AssignVersionsToStep, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a chargeback workflow * * @param body Definition for chargeback workflow */ createChargebackWorkflow(body?: ChargebackWorkflowCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ deleteChargebackWorkflow(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by a chargeback workflow step If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ deleteChargebackWorkflowSteps(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id * @param body Definition for chargeback workflow */ editChargebackWorkflow(chargebackWorkflowId: number, body?: ChargebackWorkflowEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ getChargebackWorkflow(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a digest of all bills by meter for all meters involved in a chargeback workflow step for a given billing period. * * @param chargebackWorkflowStepId The id of the chargeback workflow step. * @param billingPeriod The billing period of the digest. */ getChargebackWorkflowDigest(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a single chargeback workflow step * * @param chargebackWorkflowStepId Workflow step ID */ getChargebackWorkflowStep(chargebackWorkflowStepId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of chargeback workflow steps * * @param chargebackWorkflowType Pass either \"split\" or \"calculation\" to filter workflow steps */ getChargebackWorkflowSteps(chargebackWorkflowType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of chargeback workflows * */ getChargebackWorkflows(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by a chargeback workflow step for a particular billing period If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ voidChargebackWorkflowSteps(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Assign a list of bill split or calculate bill versions to a chargeback workflow step of the same type * * @param chargebackWorkflowStepId ID of the chargeback workflow step to which the versions will be assigned * @param billingPeriod The billing period to validate that the provided versions are effective * @param body The chargeback versions to assign to the provided chargeback workflow step */ assignVersionsToStepWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod: number, body?: AssignVersionsToStep, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a chargeback workflow * * @param body Definition for chargeback workflow */ createChargebackWorkflowWithHttpInfo(body?: ChargebackWorkflowCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ deleteChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills created by a chargeback workflow step If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ deleteChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id * @param body Definition for chargeback workflow */ editChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, body?: ChargebackWorkflowEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ getChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a digest of all bills by meter for all meters involved in a chargeback workflow step for a given billing period. * * @param chargebackWorkflowStepId The id of the chargeback workflow step. * @param billingPeriod The billing period of the digest. */ getChargebackWorkflowDigestWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single chargeback workflow step * * @param chargebackWorkflowStepId Workflow step ID */ getChargebackWorkflowStepWithHttpInfo(chargebackWorkflowStepId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of chargeback workflow steps * * @param chargebackWorkflowType Pass either \"split\" or \"calculation\" to filter workflow steps */ getChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of chargeback workflows * */ getChargebackWorkflowsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Void all bills created by a chargeback workflow step for a particular billing period If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ voidChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CollectionRequest { /** * The collection code Required Must be between 0 and 32 characters */ collectionCode: string | null; /** * The collection info Required Must be between 0 and 50 characters */ collectionInfo: string | null; /** * The identifier for the parent of the collection. The parent is the collection directly above the current collection on the collections and emission sources tree Required */ parentCollectionId: number | null; collectionIcon: Icon | null | undefined; /** * The collection note Must be between 0 and 255 characters */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CollectionEmissionSourceChild { /** * The emission source identifier */ emissionSourceId: number | null | undefined; /** * The emission source code */ emissionSourceCode: string | null | undefined; /** * The emission source info */ emissionSourceInfo: string | null | undefined; /** * Whether the emission source is active or not */ active: boolean | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CollectionResponse { /** * The collection identifier */ collectionId: number | null | undefined; /** * The collection code */ collectionCode: string | null | undefined; /** * The collection info */ collectionInfo: string | null | undefined; /** * The collection description */ note: string | null | undefined; collectionIcon: Icon | null | undefined; parent: CollectionChild | null | undefined; /** * An array of child collections */ collections: Array | null | undefined; /** * An array of child emission sources */ emissionSources: Array | null | undefined; } declare class CollectionService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a collection * * @param body Data representing the collection being created */ createCollection(body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a collection * * @param collectionId The identifier for the collection being deleted */ deleteCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a collection custom field * * @param collectionId The id of the collection * @param udfId The id of the custom field */ downloadCollectionCustomFields(collectionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a collection * * @param collectionId The identifier for the collection being edited * @param body Data representing the collection being edited */ editCollection(collectionId: number, body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a collection * * @param collectionId The id of the collection * @param body The list of udf values being edited */ editCollectionCustomFields(collectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the collection by ID * * @param collectionId The identifier for the collection being retrieved */ getCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for a collection * * @param collectionId The id of the collection */ getCollectionCustomFields(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollections(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param parentCollectionId * @param body */ moveCollections(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a collection * * @param body Data representing the collection being created */ createCollectionWithHttpInfo(body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a collection * * @param collectionId The identifier for the collection being deleted */ deleteCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a collection custom field * * @param collectionId The id of the collection * @param udfId The id of the custom field */ downloadCollectionCustomFieldsWithHttpInfo(collectionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a collection * * @param collectionId The identifier for the collection being edited * @param body Data representing the collection being edited */ editCollectionWithHttpInfo(collectionId: number, body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a collection * * @param collectionId The id of the collection * @param body The list of udf values being edited */ editCollectionCustomFieldsWithHttpInfo(collectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the collection by ID * * @param collectionId The identifier for the collection being retrieved */ getCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a collection * * @param collectionId The id of the collection */ getCollectionCustomFieldsWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollectionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param parentCollectionId * @param body */ moveCollectionsWithHttpInfo(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityEditRequest { /** * The commodity info Required Must be between 0 and 32 characters */ commodityInfo: string | null; /** * Three letter abbreviation code to represent the commodity Required Must be between 1 and 3 characters */ abbreviation: string | null; /** * The commodity description Must be between 0 and 255 characters Required (defined) */ description: string | null | undefined; icon: Icon | null | undefined; /** * The commodity category identifier If the category is provided, the default use rollup unit and default demand rollup unit for that category will be used Required (defined) Only one of CommodityCategoryId, CommodityRollupUnitId can be set Only one of CommodityCategoryId, CommodityDemandRollupUnitId can be set */ commodityCategoryId: number | null | undefined; /** * The common use unit identifier for reporting purposes Ignored if a commodity category is provided and it has a rollup unit specified Required (defined) Only one of CommodityCategoryId, CommodityRollupUnitId can be set */ commodityRollupUnitId: number | null | undefined; /** * Indicates if the commodity should be included in Energy reporting Required (defined) */ includeInEnergyReporting: boolean | null | undefined; /** * The multiplier to convert from the commodity rollup unit to the energy use reporting unit Not required if commodity rollup unit is in the energy unit category Must be null when IncludeInEnergyReporting is set to False, case sensitive */ energyReportingUnitConversionMultiplier: number | null | undefined; /** * The common demand unit identifier for reporting purposes Ignored if a commodity category is provided and it has a demand rollup unit specified Required (defined) Only one of CommodityCategoryId, CommodityDemandRollupUnitId can be set */ commodityDemandRollupUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityRequest { /** * The commodity info Required Must be between 0 and 32 characters */ commodityInfo: string | null; /** * Three letter abbreviation code to represent the commodity Required Must be between 1 and 3 characters */ abbreviation: string | null; /** * The commodity description Must be between 0 and 255 characters */ description: string | null | undefined; icon: Icon | null | undefined; /** * The commodity category identifier If the category is provided, the default use rollup unit and default demand rollup unit for that category will be used Only one of CommodityCategoryId, CommodityRollupUnitId can be set Only one of CommodityCategoryId, CommodityDemandRollupUnitId can be set */ commodityCategoryId: number | null | undefined; /** * The common use unit identifier for reporting purposes Ignored if a commodity category is provided and it has a rollup unit specified Only one of CommodityCategoryId, CommodityRollupUnitId can be set */ commodityRollupUnitId: number | null | undefined; /** * Indicates if the commodity should be included in Energy reporting */ includeInEnergyReporting: boolean | null | undefined; /** * The multiplier to convert from the commodity rollup unit to the energy use reporting unit Not required if commodity rollup unit is in the energy unit category Must be null when IncludeInEnergyReporting is set to False, case sensitive */ energyReportingUnitConversionMultiplier: number | null | undefined; /** * The common demand unit identifier for reporting purposes Ignored if a commodity category is provided and it has a demand rollup unit specified Only one of CommodityCategoryId, CommodityDemandRollupUnitId can be set */ commodityDemandRollupUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityCategory { commonUseUnit: UnitChild | null | undefined; commonDemandUnit: UnitChild | null | undefined; /** * The commodity category id */ commodityCategoryId: number | null | undefined; /** * The commodity category info */ commodityCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityResponse { /** * The commodity identifier */ commodityId: number | null | undefined; /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * Three letter abbreviation code to represent the commodity */ abbreviation: string | null | undefined; /** * The commodity description */ description: string | null | undefined; icon: Icon | null | undefined; commodityCategory: CommodityCategory | null | undefined; useRollupUnit: UnitChild | null | undefined; demandRollupUnit: UnitChild | null | undefined; /** * Indicates if the commodity should be included in Energy reporting */ includeInEnergyReporting: boolean | null | undefined; /** * The multiplier to convert from the commodity rollup unit to the energy use reporting unit */ energyReportingUnitConversionMultiplier: number | null | undefined; /** * Indicates if the commodity is in use on a meter/emissions source */ inUse: boolean | null | undefined; /** * Indicates if the commodity is a system-level commodity */ isSystemCommodity: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UnitType { /** * */ unitTypeId: number | null | undefined; /** * */ unitTypeCode: string | null | undefined; /** * */ unitTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Unit { /** * */ unitId: number | null | undefined; /** * Must be between 0 and 16 characters */ unitCode: string | null | undefined; /** * Must be between 0 and 32 characters */ unitInfo: string | null | undefined; /** * Must be between 0 and 64 characters */ unitDisplayName: string | null | undefined; unitType: UnitType | null | undefined; } declare class CommodityService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a commodity * * @param body Data representing the commodity being created */ createCommodity(body?: CommodityRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a commodity * * @param commodityId The commodity Id */ deleteCommodity(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a commodity * * @param commodityId The commodity Id * @param body Data that will be used to update the commodity */ editCommodity(commodityId: number, body?: CommodityEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets the commodities If topmostcostcenter, topmostcollection, topmostplace or account filters are used then the commodities in use at or under that node will be returned. The inUse filter cannot be combined with the above filters. * * @param filter The filters */ getCommodities(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a commodity * * @param commodityId The commodity Id */ getCommodity(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns a list of units for a specific commodity and value type * * @param commodityId The specific commodity ID * @param valueType The unit type to search for. Not required. Valid values are 'use', 'demand', and 'cost'. */ getUnitsByCommodity(commodityId: number, valueType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a commodity * * @param body Data representing the commodity being created */ createCommodityWithHttpInfo(body?: CommodityRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a commodity * * @param commodityId The commodity Id */ deleteCommodityWithHttpInfo(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a commodity * * @param commodityId The commodity Id * @param body Data that will be used to update the commodity */ editCommodityWithHttpInfo(commodityId: number, body?: CommodityEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the commodities If topmostcostcenter, topmostcollection, topmostplace or account filters are used then the commodities in use at or under that node will be returned. The inUse filter cannot be combined with the above filters. * * @param filter The filters */ getCommoditiesWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a commodity * * @param commodityId The commodity Id */ getCommodityWithHttpInfo(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a list of units for a specific commodity and value type * * @param commodityId The specific commodity ID * @param valueType The unit type to search for. Not required. Valid values are 'use', 'demand', and 'cost'. */ getUnitsByCommodityWithHttpInfo(commodityId: number, valueType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityCategoryRequest { /** * The commodity category info Required Must be between 0 and 32 characters */ commodityCategoryInfo: string | null; /** * The default use unit for this category */ commonUseUnitId: number | null | undefined; /** * The default demand unit for this category */ commonDemandUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityCategoryResponse { /** * List of commodities under the category */ commodities: Array | null | undefined; commonUseUnit: UnitChild | null | undefined; commonDemandUnit: UnitChild | null | undefined; /** * The commodity category id */ commodityCategoryId: number | null | undefined; /** * The commodity category info */ commodityCategoryInfo: string | null | undefined; } declare class CommodityCategoryService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a commodity category * * @param body Data representing the commodity category being created */ createCommodityCategory(body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a commodity category * * @param commodityCategoryId The commodity category identifier */ deleteCommodityCategory(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a commodity category * * @param commodityCategoryId The commodity category identifier * @param body Data representing the commodity category being created */ editCommodityCategory(commodityCategoryId: number, body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets the commodity categories * */ getCommodityCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a commodity category by ID * * @param commodityCategoryId The commodity category identifier */ getCommodityCategory(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a commodity category * * @param body Data representing the commodity category being created */ createCommodityCategoryWithHttpInfo(body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a commodity category * * @param commodityCategoryId The commodity category identifier */ deleteCommodityCategoryWithHttpInfo(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a commodity category * * @param commodityCategoryId The commodity category identifier * @param body Data representing the commodity category being created */ editCommodityCategoryWithHttpInfo(commodityCategoryId: number, body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the commodity categories * */ getCommodityCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a commodity category by ID * * @param commodityCategoryId The commodity category identifier */ getCommodityCategoryWithHttpInfo(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityDigestActualYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityDigestActualYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityDigestActualYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityDigestActualYearlyResponse { globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } declare class CommodityDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data by commodities for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param commodityId The commodity to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getCommodityActualYearly(commodityId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by commodities for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param commodityId The commodity to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getCommodityActualYearlyWithHttpInfo(commodityId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCategoryEdit { /** * Name of the cost category Required Must be between 0 and 255 characters */ costCategoryInfo: string | null; } declare class CostCategoryService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits a cost category * * @param costCategoryId The identifier of the cost category to edit * @param body Object containing settings to change */ editCostCategory(costCategoryId: number, body?: CostCategoryEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all cost categories * */ getCostCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a cost category * * @param costCategoryId The identifier of the cost category to edit * @param body Object containing settings to change */ editCostCategoryWithHttpInfo(costCategoryId: number, body?: CostCategoryEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all cost categories * */ getCostCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterCreate { /** * The cost center code Required Must be between 0 and 32 characters */ costCenterCode: string | null; /** * The cost center info Required Must be between 0 and 32 characters */ costCenterInfo: string | null; /** * The identifier for the parent of the cost center. The parent is the cost center directly above the current cost center on the Accounts tree Required Topmost (CostCenter) */ parentCostCenterId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterAccountChild { /** * The account identifier */ accountId: number | null | undefined; /** * The account code */ accountCode: string | null | undefined; /** * The account info */ accountInfo: string | null | undefined; /** * Whether the account is active or not */ active: boolean | null | undefined; /** * Indicates whether the Account has a child calculated meter */ hasCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Account is a recipient of a split */ hasSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Account has a child split meter */ hasSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Account is a sub-account */ isSubAccount: boolean | null | undefined; /** * Indicates whether the Account has a sub-account */ hasSubAccount: boolean | null | undefined; accountType: AccountTypeChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterResponse { /** * The cost center identifier */ costCenterId: number | null | undefined; /** * The cost center code */ costCenterCode: string | null | undefined; /** * The cost center info */ costCenterInfo: string | null | undefined; parent: CostCenterChild | null | undefined; /** * An array of child cost centers */ costCenters: Array | null | undefined; /** * An array of child accounts */ accounts: Array | null | undefined; } declare class CostCenterService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a Cost Center * * @param body Data representing the cost center being created */ createCostCenter(body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a cost center * * @param costCenterId The identifier for the cost center being deleted */ deleteCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a cost center * * @param costCenterId The identifier for the cost center being edited * @param body Data representing the cost center being edited */ editCostCenter(costCenterId: number, body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the cost center by ID * * @param costCenterId The identifier for the cost center being retrieved */ getCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of costCenters to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of costCenterIds to move under the parentCostCenterId */ moveCostCenter(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a Cost Center * * @param body Data representing the cost center being created */ createCostCenterWithHttpInfo(body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a cost center * * @param costCenterId The identifier for the cost center being deleted */ deleteCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a cost center * * @param costCenterId The identifier for the cost center being edited * @param body Data representing the cost center being edited */ editCostCenterWithHttpInfo(costCenterId: number, body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the cost center by ID * * @param costCenterId The identifier for the cost center being retrieved */ getCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCentersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Move list of costCenters to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of costCenterIds to move under the parentCostCenterId */ moveCostCenterWithHttpInfo(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualMonthlyResponseCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualMonthlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of commodity monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualMonthlyResponse { /** * The costCenter code */ costCenterCode: string | null | undefined; /** * The costCenter info */ costCenterInfo: string | null | undefined; /** * The costCenter identifier */ costCenterId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data per commodity */ commodities: Array | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenterDigestActualYearlyResponse { /** * The costCenter code */ costCenterCode: string | null | undefined; /** * The costCenter info */ costCenterInfo: string | null | undefined; /** * The costCenter identifier */ costCenterId: number | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } declare class CostCenterDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getCostCenterActualMonthly(costCenterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearly(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getCostCenterActualMonthlyWithHttpInfo(costCenterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyWithHttpInfo(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Country { /** * */ countryId: number | null | undefined; /** * */ name: string | null | undefined; /** * */ alpha2Code: string | null | undefined; /** * */ possibleSpellings: Array | null | undefined; } declare class CountryService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves a list of all possible countries * */ getCountries(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of all possible countries * */ getCountriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CustomerResponse { /** * The customer identifier */ customerId: number | null | undefined; /** * The customer code */ customerCode: string | null | undefined; /** * The customer info */ customerInfo: string | null | undefined; address: AddressChild | null | undefined; } declare class CustomerService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves an array of customers. * * @param filter */ getCustomers(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of customers. * * @param filter */ getCustomersWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardCopy { /** * The Dashboard Title If null, this will default to the copied dashboard's name with ' - Copy' appended Must be between 0 and 255 characters */ dashboardInfo: string | null | undefined; /** * The dashboard description If null, this will default to the copied dashboard's description Must be between 0 and 255 characters */ description: string | null | undefined; /** * Flag to indicate if the dashboard is public If null, this will default to false */ public: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardCreate { /** * The Dashboard Title Required Must be between 0 and 255 characters */ dashboardInfo: string | null; /** * The dashboard description Must be between 0 and 255 characters */ description: string | null | undefined; /** * The dashboard type One of 'User', 'Map' */ type: string | null | undefined; /** * Flag to indicate if the dashboard is public */ public: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardEdit { /** * The Dashboard Title Required Must be between 0 and 255 characters */ dashboardInfo: string | null; /** * The dashboard description Must be between 0 and 255 characters Required (defined) */ description: string | null | undefined; /** * The dashboard type One of 'User', 'Map' Required (defined) */ type: string | null | undefined; /** * Flag to indicate if the dashboard is public Required */ public: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardGlobalSettingsEdit { /** * Flag to indicate if public-facing links to the application should be displayed Required (defined) */ showLinks: boolean | null | undefined; /** * Flag to indicate if title/description should be displayed Required (defined) */ showInfo: boolean | null | undefined; /** * Visibility of dashboard filter. Valid values are Show, Hide, or Fixed. If settings are applied to a Map dashboard, this is automatically set to Fixed, and any other filter settings are automatically nulled. Show - Filter controls will be show on the dashboard, filter can be temporarily set by anybody who can view the dashboard, including public viewers. Hide - Filter controls will be hidden, manual filtering will be disabled, dashboard will be filtered using the topmost place of the user who applies the settings Fixed - Filter controls will be hidden, dashboard will be filtered using the specified Topmost Place or Building Group. PlaceID or PlaceGroupID are required when this field is set to Fixed. One of 'Show', 'Hide', 'Fixed' */ globalFilterVisibility: string | null | undefined; /** * The Identifier for the Topmost Place the dashboard should filter by. Required when GlobalFilterVisibility is Fixed. Set to null if GlobalFilterVisibility is set to Show or Hide. Only one of PlaceID, PlaceGroupID can be set */ placeId: number | null | undefined; /** * The Identifier for the Building Group the dashboard should filter by. Required when GlobalFilterVisibility is Fixed. Set to null if GlobalFilterVisibility is set to Show or Hide. Only one of PlaceID, PlaceGroupID can be set */ placeGroupId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupChild { /** * The place group identifier */ placeGroupId: number | null | undefined; /** * The place group code */ placeGroupCode: string | null | undefined; /** * The place group info */ placeGroupInfo: string | null | undefined; /** * Indicates if this place group is an autogroup */ autoGroup: boolean | null | undefined; /** * Indicates if this place group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardGlobalSettings { /** * Flag to indicate if public-facing links to the application should be displayed */ showLinks: boolean | null | undefined; /** * Flag to indicate if title/description should be displayed */ showInfo: boolean | null | undefined; /** * Visibility of dashboard filter. Values are Show, Hide, or Fixed. Show - Filter controls are shown on the dashboard, filter can be temporarily set by anybody who can view the dashboard, including public viewers Hide - Filter controls are hidden, filter cannot be set, dashboard will be filtered using the topmost place of the user that creates the dashboard Fixed - Filter controls are hidden, a fixed filter is applied to the dashboard */ globalFilterVisibility: string | null | undefined; /** * If GlobalFilterVisibility is Fixed, this is the type of filter currently applied to this dashboard. Values are either TopmostPlace or BuildingGroup, or blank if GlobalFilterVisibility is not Fixed. TopmostPlace - Filters the dashboard by a topmost place BuildingGroup - Filters the dashboard by a building group */ globalFilterType: string | null | undefined; topmostPlace: PlaceChild | null | undefined; buildingGroup: PlaceGroupChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardResponse { /** * The dashboard identifier */ dashboardId: number | null | undefined; /** * The dashboard info */ dashboardInfo: string | null | undefined; /** * The dashboard description */ description: string | null | undefined; /** * The dashboard type */ type: string | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the dashboard was created */ createdDate: Date | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Flag to indicate if the dashboard is shared at all This means the dashboard is shared with everyone, shared with a user, or shared with a user group */ shared: boolean | null | undefined; /** * Flag to indicate if dashboard should show in the caller's tree */ visible: boolean | null | undefined; /** * The date and time of the last time this dashboard was viewed by the caller */ lastViewed: Date | null | undefined; /** * If the dashboard is public, this value holds the public key that allows the dashboard to be embedded */ key: string | null | undefined; /** * Flag to indicate if the dashboard is public */ public: boolean | null | undefined; dashboardGlobalSettings: DashboardGlobalSettings | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FilterEdit { /** * Data field ID for the filter Required */ fieldId: number | null; /** * Filter operator expressed as a string (e.g. \"equals\") Required */ operator: string | null; /** * Filter value */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MapDashboardSettingsRequest { /** * The title of the dashboard. Required Max length of 255 */ title: string | null; /** * The description of the dashboard. Max length of 255 Required (defined) */ description: string | null | undefined; /** * Flag to indicate if Cost data should be shown on the dashboard. Required (defined) */ showCost: boolean | null | undefined; /** * Flag to indicate if Use data should be shown on the dashboard. Required (defined) */ showUse: boolean | null | undefined; /** * Flag to indicate if Greenhouse Gas data should be shown on the dashboard. Required (defined) */ showGHG: boolean | null | undefined; /** * Filters to apply to the map. Required (defined) */ mapDashboardFilter: Array | null | undefined; /** * Set how commodities should be ordered for each data type. Applied individually to Cost, Use, and GHG Emissions. Highest - Order displayed commodities in order of Highest Cost/Use/GHG Emissions Lowest - Order displayed commodities in order Lowest Cost/Use/GHG Emissions Fixed - Select up to 5 fixed commodities to display. One of 'Highest', 'Lowest', 'Fixed' Required (defined) */ globalCommodityDisplay: string | null | undefined; /** * List of Commodities to display for each data type. Required if GlobalCommodityDisplay is Fixed, ignored otherwise. Maximum length of 5 items. Required when GlobalCommodityDisplay is set to Fixed List cannot be empty */ fixedCommodityIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MapDashboardSettingsResponse { /** * The title of the dashboard. Maximum length of 255 characters. */ title: string | null | undefined; /** * The description of the dashboard. Maximum length of 255 characters. */ description: string | null | undefined; /** * Flag to indicate if Cost data is shown on the dashboard. */ showCost: boolean | null | undefined; /** * Flag to indicate if Use data is shown on the dashboard. */ showUse: boolean | null | undefined; /** * Flag to indicate if Greenhouse Gas data is shown on the dashboard. */ showGHG: boolean | null | undefined; /** * Filters applied to the dashboard. */ mapDashboardFilters: Array | null | undefined; /** * Display order for commodities. Applied individually to Cost, Use, and GHG Emissions. Highest - Order displayed commodities in order of Highest Cost/Use/GHG Emissions Lowest - Order displayed commodities in order Lowest Cost/Use/GHG Emissions Fixed - Display up to 5 fixed commodities for each data type. */ globalCommodityDisplay: string | null | undefined; /** * List of Commodities to display for Cost, Use, and GHG, if applicable. Empty if GlobalCommodityDisplay is set to \"Highest\" or \"Lowest\". */ fixedCommodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ShareRequest { /** * Set to True to share the item everyone When true, SharedUsers and SharedUserGroups should be set to empty lists [] Required */ sharedWithEveryone: boolean | null; /** * The list of individual user ids an item should be shared with Should be an empty list [], when SharedWithEveryone is true Required */ sharedUserIds: Array | null; /** * The list of user group ids an item should be shared with Should be an empty list [], when SharedWithEveryone is true Required */ sharedUserGroupIds: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserGroupChild { /** * The user group identifier */ userGroupId: number | null | undefined; /** * The user group name */ userGroupName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ShareResponse { /** * True if the item is shared with everyone */ sharedWithEveryone: boolean | null | undefined; /** * The list of individual users an item has been assigned to be shared with This does NOT take into account users that are in a shared user group */ sharedUsers: Array | null | undefined; /** * The list of user groups an item has been assigned to be shared with */ sharedUserGroups: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecificWidgetResponse { /** * Specific widget identifier */ specificWidgetId: number | null | undefined; /** * User Widget title */ title: string | null | undefined; /** * Widget title */ widgetInfo: string | null | undefined; /** * Widget description */ description: string | null | undefined; /** * User Widget description */ userWidgetDescription: string | null | undefined; /** * Dashboard row */ row: number | null | undefined; /** * Dashboard column */ col: number | null | undefined; /** * Widget height */ height: number | null | undefined; /** * Widget width */ width: number | null | undefined; /** * Widget filters */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ToggleVisible { /** * Required (defined) */ visible: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetCreate { /** * Widget identifier Required */ widgetId: number | null; /** * Dashboard row Required */ row: number | null; /** * Dashboard column Required */ col: number | null; /** * Widget height Required */ height: number | null; /** * Widget width Required */ width: number | null; /** * Personal Widget title Must be between 0 and 600 characters Required */ title: string | null; /** * Personal Widget description Must be between 0 and 600 characters */ userWidgetDescription: string | null | undefined; /** * Widget filters */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetEdit { /** * Specific Widget identifier Required */ specificWidgetId: number | null; /** * Personal Widget title Must be between 0 and 600 characters Required */ title: string | null; /** * Dashboard row Required (defined) */ row: number | null | undefined; /** * Dashboard column Required (defined) */ col: number | null | undefined; /** * Widget height Required (defined) */ height: number | null | undefined; /** * Widget width Required (defined) */ width: number | null | undefined; /** * Personal Widget description Must be between 0 and 600 characters Required (defined) */ userWidgetDescription: string | null | undefined; /** * Widget filters Required (defined) */ filters: Array | null | undefined; } declare class DashboardService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Add a widget to a dashboard To add widgets to a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ addWidget(dashboardId: number, body?: WidgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Copy a dashboard To copy a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Request object */ copyDashboard(dashboardId: number, body?: DashboardCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a dashboard * * @param body */ createDashboard(body?: DashboardCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the visibility of a dashboard for the current user This must be a dashboard you can see Which means you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Set Visibility */ dashboardActionVisible(dashboardId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a dashboard To delete a dashboard you must have created it or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Specific dashboard */ deleteDashboard(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a dashboard To edit a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId * @param body */ editDashboard(dashboardId: number, body?: DashboardEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits the public display settings for a dashboard. Settings can only be applied to public dashboards. Filter settings cannot be applied to Map dashboards. To apply these settings, you must have the PublicDashboardsOrMaps Manage permission. You must also have either created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier for the dashboard to apply settings to. * @param body An object containing the settings to be applied. */ editDashboardSettings(dashboardId: number, body?: DashboardGlobalSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the shared users and user groups for a dashboard To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to [] You must have created the dashboard and have SharedDashboardsOrMaps Create permission or have DashboardAdministrator Manage permission and the dashboard must be shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Dashboard Identifier * @param body users and user groups to share the dashboard with */ editDashboardShare(dashboardId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reorder, edit, and delete specific widgets on a dashboard. To edit dashboard widgets you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ editDashboardWidgets(dashboardId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Applies display settings and filters to a map dashboard. These settings are specific to map dashboards, and cannot be applied to standard dashboards. To apply these settings, You must also have either: Created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier of the dashboard to apply these settings to * @param body Object containing the settings to be applied. */ editMapDashboardSettings(dashboardId: number, body?: MapDashboardSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a dashboard. For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard */ getDashboard(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the individual users and user groups a dashboard is shared with For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Dashboard Identifier */ getDashboardShare(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all widgets on a dashboard For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Dashboard Identifier */ getDashboardWidgets(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of dashboards. The array of dashboards can be filtered by a number of criteria. See the filter property for more details For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param filter */ getDashboards(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the current display settings and filters for a specific map dashboard. Cannot be used to retreive settings for a standard dashboard. * * @param dashboardId The identifier of the dashboard to get the settings of */ getMapDashboardSettings(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Add a widget to a dashboard To add widgets to a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ addWidgetWithHttpInfo(dashboardId: number, body?: WidgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Copy a dashboard To copy a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Request object */ copyDashboardWithHttpInfo(dashboardId: number, body?: DashboardCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a dashboard * * @param body */ createDashboardWithHttpInfo(body?: DashboardCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the visibility of a dashboard for the current user This must be a dashboard you can see Which means you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Set Visibility */ dashboardActionVisibleWithHttpInfo(dashboardId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a dashboard To delete a dashboard you must have created it or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Specific dashboard */ deleteDashboardWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a dashboard To edit a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId * @param body */ editDashboardWithHttpInfo(dashboardId: number, body?: DashboardEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits the public display settings for a dashboard. Settings can only be applied to public dashboards. Filter settings cannot be applied to Map dashboards. To apply these settings, you must have the PublicDashboardsOrMaps Manage permission. You must also have either created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier for the dashboard to apply settings to. * @param body An object containing the settings to be applied. */ editDashboardSettingsWithHttpInfo(dashboardId: number, body?: DashboardGlobalSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the shared users and user groups for a dashboard To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to [] You must have created the dashboard and have SharedDashboardsOrMaps Create permission or have DashboardAdministrator Manage permission and the dashboard must be shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Dashboard Identifier * @param body users and user groups to share the dashboard with */ editDashboardShareWithHttpInfo(dashboardId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reorder, edit, and delete specific widgets on a dashboard. To edit dashboard widgets you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ editDashboardWidgetsWithHttpInfo(dashboardId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Applies display settings and filters to a map dashboard. These settings are specific to map dashboards, and cannot be applied to standard dashboards. To apply these settings, You must also have either: Created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier of the dashboard to apply these settings to * @param body Object containing the settings to be applied. */ editMapDashboardSettingsWithHttpInfo(dashboardId: number, body?: MapDashboardSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a dashboard. For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard */ getDashboardWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the individual users and user groups a dashboard is shared with For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Dashboard Identifier */ getDashboardShareWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all widgets on a dashboard For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Dashboard Identifier */ getDashboardWidgetsWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of dashboards. The array of dashboards can be filtered by a number of criteria. See the filter property for more details For a dashboard to be returned you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param filter */ getDashboardsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets the current display settings and filters for a specific map dashboard. Cannot be used to retreive settings for a standard dashboard. * * @param dashboardId The identifier of the dashboard to get the settings of */ getMapDashboardSettingsWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class DataPointCreate { /** * The Data Point code Required Must be between 0 and 50 characters */ dataPointCode: string | null; /** * The Data Point name Required Must be between 0 and 50 characters */ dataPointInfo: string | null; /** * The place this Data Point is assigned to Topmost (Space) Required */ esaPlaceId: number | null; /** * The Commodity (type) of the Data Point Required */ commodityId: number | null; /** * The Data Point description Must be between 0 and 4000 characters */ dataPointDescription: string | null | undefined; /** * The identifier for the Data Point's time zone. If the place Data Point is under a site this must be left null or set to the same time zone as the site. */ dataPointTimeZoneId: number | null | undefined; /** * The serial number of the Data Point Must be between 0 and 255 characters */ serialNumber: string | null | undefined; /** * The model of the Data Point Must be between 0 and 50 characters */ model: string | null | undefined; /** * The import identifier of the Data Point Must be between 0 and 255 characters */ importId: string | null | undefined; /** * The latitude of the Data Point, if set it overrides the latitude of it's parent Place Must be between -90 and 90 Required when LongitudeOverride is set */ latitudeOverride: number | null | undefined; /** * The longitude of the Data Point, if set it overrides the longitude of it's parent Place Must be between -180 and 180 Required when LatitudeOverride is set */ longitudeOverride: number | null | undefined; /** * The manufacturer of the Data Point */ manufacturerId: number | null | undefined; /** * The primary use of the Data Point */ primaryUseId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataPointEdit { /** * Indicates if the data point is active Required (defined) */ active: boolean | null | undefined; /** * The Data Point code Required Must be between 0 and 50 characters */ dataPointCode: string | null; /** * The Data Point name Required Must be between 0 and 50 characters */ dataPointInfo: string | null; /** * The place this Data Point is assigned to Topmost (Space) Required */ esaPlaceId: number | null; /** * The Commodity (type) of the Data Point Required */ commodityId: number | null; /** * The Data Point description Must be between 0 and 4000 characters Required (defined) */ dataPointDescription: string | null | undefined; /** * The identifier for the Data Point's time zone. If the place Data Point is under a site this must be left null or set to the same time zone as the site. Required (defined) */ dataPointTimeZoneId: number | null | undefined; /** * The serial number of the Data Point Must be between 0 and 255 characters Required (defined) */ serialNumber: string | null | undefined; /** * The model of the Data Point Must be between 0 and 50 characters Required (defined) */ model: string | null | undefined; /** * The import identifier of the Data Point Must be between 0 and 255 characters Required (defined) */ importId: string | null | undefined; /** * The latitude of the Data Point, if set it overrides the latitude of it's parent Place Must be between -90 and 90 Required when LongitudeOverride is set */ latitudeOverride: number | null | undefined; /** * The longitude of the Data Point, if set it overrides the longitude of it's parent Place Must be between -180 and 180 Required when LatitudeOverride is set */ longitudeOverride: number | null | undefined; /** * The manufacturer of the Data Point Required (defined) */ manufacturerId: number | null | undefined; /** * The primary use of the Data Point Required (defined) */ primaryUseId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class EsaChannelChild { /** * The identifier for the channel */ channelId: number | null | undefined; /** * The channel interval */ interval: number | null | undefined; /** * The channel name */ channelInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class ManufacturerChild { /** * The identifier for the manufacturer */ manufacturerId: number | null | undefined; /** * The manufacturer name */ manufacturerInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PrimaryUseChild { /** * */ primaryUseId: number | null | undefined; /** * */ primaryUseCode: string | null | undefined; /** * */ primaryUseInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeZoneChild { /** * */ timeZoneId: number | null | undefined; /** * */ timeZoneCode: string | null | undefined; /** * */ timeZoneInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class DataPointResponse { /** * The identifier for the Data Point */ dataPointId: number | null | undefined; /** * The Data Point code */ dataPointCode: string | null | undefined; /** * The Data Point name */ dataPointInfo: string | null | undefined; /** * The Data Point description */ dataPointDescription: string | null | undefined; /** * Indicates whether the Data Point is active */ active: boolean | null | undefined; /** * The serial number of the Data Point */ serialNumber: string | null | undefined; /** * The model of the Data Point */ model: string | null | undefined; /** * The import identifier of the Data Point */ importId: string | null | undefined; /** * The latitude of the Data Point, if set it overrides the latitude of it's parent Place */ latitudeOverride: number | null | undefined; /** * The longitude of the Data Point, if set it overrides the longitude of it's parent Place */ longitudeOverride: number | null | undefined; commodity: CommodityChild | null | undefined; place: PlaceChild | null | undefined; dataPointTimeZone: TimeZoneChild | null | undefined; manufacturer: ManufacturerChild | null | undefined; primaryUse: PrimaryUseChild | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the Data Point was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification of the Data Point */ modifiedDate: Date | null | undefined; /** * An array of channels assigned to this Data Point */ channels: Array | null | undefined; /** * Indicates if the primary value channel on the datapoint has a summarization method of SUM */ isDataRolledUp: boolean | null | undefined; /** * Indicates if the Sentinel is active for primary value channels */ sentinelEnabled: boolean | null | undefined; /** * Provides some insight into the current Sentinel enabled status. */ sentinelStatus: DataPointResponse.SentinelStatusEnum; sentinelModifiedBy: UserChild | null | undefined; } declare namespace DataPointResponse { enum SentinelStatusEnum { NUMBER_1, NUMBER_2, NUMBER_3, NUMBER_4, NUMBER_5 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataPointSentinel { /** * Indicates if the data point sentinel is enabled Required (defined) */ sentinelEnabled: boolean | null | undefined; /** * The reason the sentinel was deactivated Must be null when SentinelEnabled is set to True, case sensitive Required (defined) */ sentinelDeactivatedReason: string | null | undefined; } declare class DataPointService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a data point * * @param body Data representing the data point being created */ createDataPoint(body?: DataPointCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a data point * * @param dataPointId The data point identifier */ deleteDataPoint(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a data point * * @param dataPointId The data point identifier * @param body Data representing the data point being edited */ editDataPoint(dataPointId: number, body?: DataPointEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits the data point sentinel configuration * * @param dataPointId * @param body The data point identifier */ enableSentinel(dataPointId: number, body?: DataPointSentinel, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a data point * * @param dataPointId The data point identifier */ getDataPoint(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPoints(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a data point * * @param body Data representing the data point being created */ createDataPointWithHttpInfo(body?: DataPointCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a data point * * @param dataPointId The data point identifier */ deleteDataPointWithHttpInfo(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a data point * * @param dataPointId The data point identifier * @param body Data representing the data point being edited */ editDataPointWithHttpInfo(dataPointId: number, body?: DataPointEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits the data point sentinel configuration * * @param dataPointId * @param body The data point identifier */ enableSentinelWithHttpInfo(dataPointId: number, body?: DataPointSentinel, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a data point * * @param dataPointId The data point identifier */ getDataPointWithHttpInfo(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPointsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionRecordRequest { /** * The Emission Source this record will be assigned to Required */ emissionSourceId: number | null; /** * The begin date for this record Required */ beginDate: Date | null; /** * The end date for this record Required Must be greater than BeginDate */ endDate: Date | null; /** * The supplier for this record Required (defined) */ vendorId: number | null | undefined; /** * The type of this record. Valid values are: 1 - Use 2 - Cost 3 - Direct/Offset Required One of '1', '2', '3' Case sensitive */ recordTypeId: number | null; /** * The scope category for this record Required */ scopeCategoryId: number | null; /** * The factor for this record Required */ factorId: number | null; /** * The use that is being tracked by this record. This value is required if RecordTypeId is set to 1 (Use) or 3 (Direct/Offset), but must be left null if RecordTypeId is set to 2 (Cost). Required when RecordTypeId is set to 1, or 3, case sensitive. Must be null when RecordTypeId is set to 2, case sensitive */ quantity: number | null | undefined; /** * The unit for the use being tracked by this record. This value is required if RecordTypeId is set to 1 (Use) or 3 (Direct/Offset), but must be left null if RecordTypeId is set to 2 (Cost). Required when RecordTypeId is set to 1, or 3, case sensitive. Must be null when RecordTypeId is set to 2, case sensitive */ quantityUnitId: number | null | undefined; /** * The cost for this record Required if RecordTypeId is set to 2 (Cost), otherwise it is optional. Required when RecordTypeId is set to 2, case sensitive. Required when CostUnitId is set */ cost: number | null | undefined; /** * The unit for this record's cost. Required if RecordTypeId is set to 2 (Cost), otherwise it is optional. Required when RecordTypeId is set to 2, case sensitive. Required when Cost is set */ costUnitId: number | null | undefined; /** * The note for this record Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; /** * The attachment for this record Must be between 0 and 260 characters Required (defined) */ attachment: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostConversionBase { /** * The conversion factor used to convert from the source cost unit to the system cost unit */ sourceToSystemConversionValue: number | null | undefined; /** * The date used to look up the currency conversion */ conversionDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionRecordType { /** * Id of the emission record type */ emissionRecordTypeId: number | null | undefined; /** * Name of the emission record type */ emissionRecordTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceChild { /** * The emission source identifier */ emissionSourceId: number | null | undefined; /** * The emission source code */ emissionSourceCode: string | null | undefined; /** * The emission source info */ emissionSourceInfo: string | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorChild { /** * The Factor Identifier */ factorId: number | null | undefined; /** * The Factor Info */ factorInfo: string | null | undefined; /** * The Factor Description */ factorDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGGroupEmissions { /** * The name of the greenhouse gas. */ groupInfo: string | null | undefined; /** * The total emissions for this gas, in CO2 Equivalent. */ totalEmissions: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGScopeCategoryChild { /** * The GHG Scope Category Identifier */ scopeCategoryId: number | null | undefined; /** * The GHG Scope Category Info */ scopeCategoryInfo: string | null | undefined; /** * The GHG Scope Category Description */ scopeCategoryDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionRecordResponse { /** * The record identifier */ emissionRecordId: number | null | undefined; /** * The bill identifier, if this record originated from a bill in UtilityManagement */ billId: number | null | undefined; emissionSource: EmissionSourceChild | null | undefined; vendor: VendorChild | null | undefined; /** * The start date for the record */ startDate: Date | null | undefined; /** * The end date for the record */ endDate: Date | null | undefined; /** * The bill's billing period, if this record originated from a bill in UtilityManagement */ billingPeriod: number | null | undefined; emissionRecordType: EmissionRecordType | null | undefined; scopeCategory: GHGScopeCategoryChild | null | undefined; factor: GHGFactorChild | null | undefined; quantity: ValueWithUnit | null | undefined; cost: ValueWithUnit | null | undefined; systemCost: ValueWithUnit | null | undefined; costConversion: CostConversionBase | null | undefined; /** * The total GHG emissions for this record in kgCO2e. */ totalEmissions: number | null | undefined; /** * The GHG emissions for this record, split by greenhouse gas type */ emissionValues: Array | null | undefined; /** * The note for this record */ note: string | null | undefined; /** * The attachment for this record */ attachment: string | null | undefined; createdBy: UserChild | null | undefined; /** * The date this record was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date this record was last modified */ modifiedDate: Date | null | undefined; /** * The emission record creation method */ creationMethod: string | null | undefined; } declare class EmissionRecordService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create an emission record * * @param body Data representing the record being created */ createEmissionRecord(body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an emission record * * @param emissionRecordId The Id of the emission record to delete */ deleteEmissionRecord(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an emission record * * @param emissionRecordId The Id of the emission record to edit * @param body Data representing the emission record being edited */ editEmissionRecord(emissionRecordId: number, body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve an emission record by ID * * @param emissionRecordId The Id of the emission record to retrieve */ getEmissionRecord(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecords(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create an emission record * * @param body Data representing the record being created */ createEmissionRecordWithHttpInfo(body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an emission record * * @param emissionRecordId The Id of the emission record to delete */ deleteEmissionRecordWithHttpInfo(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an emission record * * @param emissionRecordId The Id of the emission record to edit * @param body Data representing the emission record being edited */ editEmissionRecordWithHttpInfo(emissionRecordId: number, body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve an emission record by ID * * @param emissionRecordId The Id of the emission record to retrieve */ getEmissionRecordWithHttpInfo(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecordsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGDefaultFactor { /** * The Greenhouse Gas Factor identifier Required when FactorType is set to specific factor Must be null when FactorType is set to use meter address */ factorId: number | null | undefined; /** * The Greenhouse Gas Factor type. The valid values for this field are \"use meter address\" or \"specific factor\" Required One of 'use meter address', 'specific factor' */ factorType: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceCreate { /** * The default scope category for the emission source Required */ defaultScopeCategoryId: number | null; defaultEmissionFactor: GHGDefaultFactor | null; /** * The emission source code Required Must be between 0 and 32 characters */ emissionSourceCode: string | null; /** * The emission source info Required Must be between 0 and 64 characters */ emissionSourceInfo: string | null; /** * The emission source's commodity Required */ commodityId: number | null; /** * The collection to which the emission source belongs Required Topmost (Collection) */ collectionId: number | null; /** * The emission source note Must be between 0 and 255 characters */ note: string | null | undefined; address: AddressChildBase | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceEdit { /** * Is the emission source active Required */ active: boolean | null; /** * The default scope category for the emission source Required */ defaultScopeCategoryId: number | null; defaultEmissionFactor: GHGDefaultFactor | null; /** * The emission source code Required Must be between 0 and 32 characters */ emissionSourceCode: string | null; /** * The emission source info Required Must be between 0 and 64 characters */ emissionSourceInfo: string | null; /** * The emission source's commodity Required */ commodityId: number | null; /** * The collection to which the emission source belongs Required Topmost (Collection) */ collectionId: number | null; /** * The emission source note Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; address: AddressChildBase | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasFactorAndScopeCategoryPairCreate { factor: GHGDefaultFactor | null | undefined; /** * The Scope Category ID to use for this Factor/Category Pairing Required (defined) */ scopeCategoryId: number | null | undefined; /** * Flag to indicate if this Factor and Category should be considered the default for this Emission Source Required (defined) */ isDefault: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceFactorCategoryBulkUpdate { /** * A list of emission source IDs to apply the specified factor/category pairs to Required (defined) */ emissionSourceIds: Array | null | undefined; /** * A list of factor/category pairs to apply to the specified emission sources Required (defined) */ factorCategoryPairs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceMultiFactorCreate { /** * A list of Factor and Scope Category pairings to be attached to this Emission Source */ scopeCategoryEmissionFactorPairs: Array | null | undefined; /** * The emission source code Required Must be between 0 and 32 characters */ emissionSourceCode: string | null; /** * The emission source info Required Must be between 0 and 64 characters */ emissionSourceInfo: string | null; /** * The emission source's commodity Required */ commodityId: number | null; /** * The collection to which the emission source belongs Required Topmost (Collection) */ collectionId: number | null; /** * The emission source note Must be between 0 and 255 characters */ note: string | null | undefined; address: AddressChildBase | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceMultiFactorEdit { /** * Is the emission source active Required (defined) */ isActive: boolean | null | undefined; /** * A list of Factor and Scope Category pairings to be attached to this Emission Source Required (defined) */ scopeCategoryEmissionFactorPairs: Array | null | undefined; /** * The emission source code Required Must be between 0 and 32 characters */ emissionSourceCode: string | null; /** * The emission source info Required Must be between 0 and 64 characters */ emissionSourceInfo: string | null; /** * The emission source's commodity Required */ commodityId: number | null; /** * The collection to which the emission source belongs Required Topmost (Collection) */ collectionId: number | null; /** * The emission source note Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; address: AddressChildBase | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasFactorChild { /** * The identifier for this factor */ factorId: number | null | undefined; /** * The code for this factor */ factorCode: string | null | undefined; /** * The name of this factor */ factorInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasScopeCategoryChild { /** * The identifier for this Scope Category */ scopeCategoryId: number | null | undefined; /** * The name of this Scope Category */ scopeCategoryInfo: string | null | undefined; /** * The description of this Scope Category */ scopeCategoryDescription: string | null | undefined; /** * The Scope this Scope Category belongs to */ scopeId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasFactorAndScopeCategoryPair { /** * Flag to indicate if this pair is the default Factor/Category pair for an Emission Source */ isDefaultFactor: boolean | null | undefined; scopeCategory: GHGasScopeCategoryChild | null | undefined; factor: GHGasFactorChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterLink { /** * The identifier for a Meter */ meterId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceMultiFactorResponse { /** * The pairs of Scope Categories and Emission Factors assigned to this Emission Source */ scopeCategoryEmissionFactorPairs: Array | null | undefined; /** * The emission source identifier */ emissionSourceId: number | null | undefined; /** * The emission source code */ emissionSourceCode: string | null | undefined; /** * The emission source info */ emissionSourceInfo: string | null | undefined; collection: CollectionChild | null | undefined; commodity: CommodityChild | null | undefined; address: AddressChild | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the emission source was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification of the emission source */ modifiedDate: Date | null | undefined; /** * The emission source description */ note: string | null | undefined; /** * Indicates whether the emission source is active */ active: boolean | null | undefined; meter: MeterLink | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceResponse { defaultScopeCategory: GHGScopeCategoryChild | null | undefined; defaultEmissionFactor: GHGFactorChild | null | undefined; /** * The emission source identifier */ emissionSourceId: number | null | undefined; /** * The emission source code */ emissionSourceCode: string | null | undefined; /** * The emission source info */ emissionSourceInfo: string | null | undefined; collection: CollectionChild | null | undefined; commodity: CommodityChild | null | undefined; address: AddressChild | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the emission source was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification of the emission source */ modifiedDate: Date | null | undefined; /** * The emission source description */ note: string | null | undefined; /** * Indicates whether the emission source is active */ active: boolean | null | undefined; meter: MeterLink | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterLinkRequest { /** * The identifier for a Meter. Set to null to remove the link. Topmost (Meter) Required (defined) */ meterId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateSkippedResult { /** * Required (defined) */ skipped: number | null | undefined; /** * Required (defined) */ skippedEntityIds: Array | null | undefined; /** * Required (defined) */ selected: number | null | undefined; /** * Required (defined) */ updated: number | null | undefined; } declare class EmissionSourceService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an emissions source * * @param body Data representing the emission source being created */ createEmissionSource(body?: EmissionSourceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emission source * * @param body Data representing the emission source being created */ createEmissionSourceWithMultiFactors(body?: EmissionSourceMultiFactorCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an emissions source * * @param emissionSourceId The identifier for the emission source being deleted * @param deleteRecords Should this cascade to delete any records associated with this emissions source */ deleteEmissionSource(emissionSourceId: number, deleteRecords?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a emissions source custom field * * @param emissionSourceId The id of the emissions source * @param udfId The id of the custom field */ downloadEmissionSourceCustomFields(emissionSourceId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emissions source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSource(emissionSourceId: number, body?: EmissionSourceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a emissions source * * @param emissionSourceId The id of the emissions source * @param body The list of udf values being edited */ editEmissionSourceCustomFields(emissionSourceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Assigns the specified scope category and factor pairings to the specified emission sources. If one or more of the factors provided cannot be applied to the emission source, that emission source will be skipped. * * @param body */ editEmissionSourceFactorCategoriesBulk(body?: EmissionSourceFactorCategoryBulkUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emission source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithMultiFactors(emissionSourceId: number, body?: EmissionSourceMultiFactorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit meter data in an Emission Source * * @param emissionSourceId The Emission Source identifier * @param body Meter data to assign to the Emission Source */ editMeterLink(emissionSourceId: number, body?: MeterLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the emissions source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSource(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for an emissions source * * @param emissionSourceId The id of the emissions source */ getEmissionSourceCustomFields(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an emission source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithMultiFactors(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSources(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param parentCollectionId * @param body */ moveEmissionSources(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Resets the scope category and factor pairings of the specified emission sources to their commodity default. If no default exists for an emission source's commodity, that emission source will be skipped. * * @param body */ resetEmissionSourceFactorCategoriesBulk(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emissions source * * @param body Data representing the emission source being created */ createEmissionSourceWithHttpInfo(body?: EmissionSourceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an emission source * * @param body Data representing the emission source being created */ createEmissionSourceWithMultiFactorsWithHttpInfo(body?: EmissionSourceMultiFactorCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an emissions source * * @param emissionSourceId The identifier for the emission source being deleted * @param deleteRecords Should this cascade to delete any records associated with this emissions source */ deleteEmissionSourceWithHttpInfo(emissionSourceId: number, deleteRecords?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a emissions source custom field * * @param emissionSourceId The id of the emissions source * @param udfId The id of the custom field */ downloadEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an emissions source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithHttpInfo(emissionSourceId: number, body?: EmissionSourceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a emissions source * * @param emissionSourceId The id of the emissions source * @param body The list of udf values being edited */ editEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Assigns the specified scope category and factor pairings to the specified emission sources. If one or more of the factors provided cannot be applied to the emission source, that emission source will be skipped. * * @param body */ editEmissionSourceFactorCategoriesBulkWithHttpInfo(body?: EmissionSourceFactorCategoryBulkUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an emission source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithMultiFactorsWithHttpInfo(emissionSourceId: number, body?: EmissionSourceMultiFactorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit meter data in an Emission Source * * @param emissionSourceId The Emission Source identifier * @param body Meter data to assign to the Emission Source */ editMeterLinkWithHttpInfo(emissionSourceId: number, body?: MeterLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the emissions source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for an emissions source * * @param emissionSourceId The id of the emissions source */ getEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an emission source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithMultiFactorsWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param parentCollectionId * @param body */ moveEmissionSourcesWithHttpInfo(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Resets the scope category and factor pairings of the specified emission sources to their commodity default. If no default exists for an emission source's commodity, that emission source will be skipped. * * @param body */ resetEmissionSourceFactorCategoriesBulkWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VemChatCreate { /** * VEM Chat name / chat title. This is a required field. When AllowChatTitleGeneration = true, this field will be used as fallback if title generation fails. Must be between 0 and 50 characters Required */ vemChatInfo: string | null; /** * Allow automatic generation of chat title based on the first prompt. */ allowChatTitleGeneration: boolean | null | undefined; /** * First prompt / user message to start the chat. This is a required field when AllowChatTitleGeneration = true. It's ignored otherwise. Required when AllowChatTitleGeneration is set to True, case sensitive. */ firstPrompt: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VemChatEdit { /** * VEM Chat name / chat title Must be between 0 and 50 characters Required */ vemChatInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VemChatMessageCreate { /** * VEM chat message content Required */ content: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VemChatMessageResponse { /** * The identifier for the VEM chat message */ vemChatMessageId: number | null | undefined; /** * Full message content */ content: string | null | undefined; /** * Date/time offset representing when VEM chat message was sent */ createdDate: Date | null | undefined; /** * VEM Chat message role. 1-User, 2-Assistant, 3-Error. Must be a valid value for VemChatMessageRole: User = 1, Assistant = 2, Error = 3 */ vemChatMessageRole: VemChatMessageResponse.VemChatMessageRoleEnum; } declare namespace VemChatMessageResponse { enum VemChatMessageRoleEnum { NUMBER_1, NUMBER_2, NUMBER_3 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VemChatResponse { /** * The identifier for the VEM chat */ vemChatId: number | null | undefined; /** * VEM Chat name / chat title */ vemChatInfo: string | null | undefined; /** * Date/time offset representing when VEM chat was created */ createdDate: Date | null | undefined; } declare class EnergyManagerService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a VEM chat for the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param body */ createChat(body?: VemChatCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new message in the specified chat and streams the response to the client. Since chat history is persisted, it manages response ID internally. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * This method processes the user's message asynchronously and streams the response directly to the client. The response is sent as plain text with no caching, and the connection is kept alive during the streaming process. * @param chatId The identifier of the chat where the message will be created. * @param body An object containing the details of the message to be created, including its content. */ createMessage(chatId: number, body?: VemChatMessageCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a VEM chat. Chat needs to belong the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId */ deleteChat(chatId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a VEM chat. Chat needs to belong the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId * @param body */ editChat(chatId: number, body?: VemChatEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all VEM chat messages for a given chat ID. Chat needs to be active (not deleted) and belong to the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId Chat id identifier */ getUserChatMessages(chatId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all VEM chats created by the user making the request. It filters out inactive/deleted chats. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * */ getUserChats(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a VEM chat for the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param body */ createChatWithHttpInfo(body?: VemChatCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new message in the specified chat and streams the response to the client. Since chat history is persisted, it manages response ID internally. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * This method processes the user's message asynchronously and streams the response directly to the client. The response is sent as plain text with no caching, and the connection is kept alive during the streaming process. * @param chatId The identifier of the chat where the message will be created. * @param body An object containing the details of the message to be created, including its content. */ createMessageWithHttpInfo(chatId: number, body?: VemChatMessageCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a VEM chat. Chat needs to belong the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId */ deleteChatWithHttpInfo(chatId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a VEM chat. Chat needs to belong the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId * @param body */ editChatWithHttpInfo(chatId: number, body?: VemChatEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all VEM chat messages for a given chat ID. Chat needs to be active (not deleted) and belong to the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param chatId Chat id identifier */ getUserChatMessagesWithHttpInfo(chatId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all VEM chats created by the user making the request. It filters out inactive/deleted chats. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * */ getUserChatsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectCreate { /** * The place identifier */ placeId: number | null | undefined; /** * The energy project code Required Must be between 0 and 128 characters */ energyProjectCode: string | null; /** * The energy project info Required Must be between 0 and 128 characters */ energyProjectInfo: string | null; /** * The energy project installation begin date */ installationBeginDate: Date | null | undefined; /** * The energy project installation end date Must be greater than InstallationBeginDate */ installationEndDate: Date | null | undefined; /** * The energy project installation cost */ installationCost: number | null | undefined; /** * The energy project type code Required */ energyProjectTypeCode: string | null; /** * The rebate amount of energy project */ utilityRebate: number | null | undefined; /** * The funding source of the project */ fundingSource: string | null | undefined; /** * The project manager of the energy project */ projectManager: string | null | undefined; /** * The miscellaneous note about the project */ note: string | null | undefined; /** * The energy savings amount */ energySavings: number | null | undefined; /** * The energy savings unit code */ energySavingsUnitCode: string | null | undefined; /** * The cost savings amount */ costSavings: number | null | undefined; /** * The cost savings unit code */ costSavingsUnitCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectEdit { /** * The place identifier Required (defined) */ placeId: number | null | undefined; /** * The energy project code Required Must be between 0 and 128 characters */ energyProjectCode: string | null; /** * The energy project info Required Must be between 0 and 128 characters */ energyProjectInfo: string | null; /** * The energy project installation begin date Required (defined) */ installationBeginDate: Date | null | undefined; /** * The energy project installation end date Must be greater than InstallationBeginDate Required (defined) */ installationEndDate: Date | null | undefined; /** * The energy project installation cost Required (defined) */ installationCost: number | null | undefined; /** * The energy project type code Required */ energyProjectTypeCode: string | null; /** * The rebate amount of energy project Required (defined) */ utilityRebate: number | null | undefined; /** * The funding source of the project Required (defined) */ fundingSource: string | null | undefined; /** * The project manager of the energy project Required (defined) */ projectManager: string | null | undefined; /** * The miscellaneous note about the project Required (defined) */ note: string | null | undefined; /** * The energy savings amount Required (defined) */ energySavings: number | null | undefined; /** * The energy savings unit code Required (defined) */ energySavingsUnitCode: string | null | undefined; /** * The cost savings amount Required (defined) */ costSavings: number | null | undefined; /** * The cost savings unit code Required (defined) */ costSavingsUnitCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostSavingsUnit { /** * The cost savings unit identifier */ costSavingsUnitId: number | null | undefined; /** * The cost savings unit code */ costSavingsUnitCode: string | null | undefined; /** * The cost savings unit information */ costSavingsUnitInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostSavingsChild { /** * The cost savings amount */ costSavings: number | null | undefined; costSavingsUnit: CostSavingsUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectPlaceChild { /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectType { /** * The energy project type identifier */ energyProjectTypeId: number | null | undefined; /** * The energy project type code */ energyProjectTypeCode: string | null | undefined; /** * The energy project type info */ energyProjectTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergySavingsUnit { /** * The energy savings unit identifier */ energySavingsUnitId: number | null | undefined; /** * The energy savings unit code */ energySavingsUnitCode: string | null | undefined; /** * The energy savings unit information */ energySavingsUnitInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergySavingsChild { /** * The energy savings amount */ energySavings: number | null | undefined; energySavingsUnit: EnergySavingsUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectResponse { /** * The energy project identifier */ energyProjectId: number | null | undefined; /** * The energy project code */ energyProjectCode: string | null | undefined; /** * The energy project info */ energyProjectInfo: string | null | undefined; /** * The energy project installation begin date */ installationBeginDate: Date | null | undefined; /** * The energy project installation end date */ installationEndDate: Date | null | undefined; /** * The energy project installation cost */ installationCost: number | null | undefined; /** * The rebate amount of energy project */ utilityRebate: number | null | undefined; /** * The funding source of the project */ fundingSource: string | null | undefined; /** * The project manager of the energy project */ projectManager: string | null | undefined; /** * The miscellaneous note about the project */ note: string | null | undefined; energySavings: EnergySavingsChild | null | undefined; costSavings: CostSavingsChild | null | undefined; place: EnergyProjectPlaceChild | null | undefined; energyProjectType: EnergyProjectType | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyProjectTypeCreate { /** * The energy project type code Required Must be between 0 and 16 characters */ energyProjectTypeCode: string | null; /** * The energy project type info Required Must be between 0 and 32 characters */ energyProjectTypeInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ProjectManagerResponse { /** * The full name of project manager */ projectManagerFullName: string | null | undefined; /** * The code for project manager */ projectManagerCode: string | null | undefined; } declare class EnergyProjectService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an Energy Project * * @param body Data representing the Energy project being created */ createEnergyProject(body?: EnergyProjectCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a energy project type * * @param body */ createEnergyProjectType(body?: EnergyProjectTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an Energy Project * * @param projectId The identifier for the energy project being deleted */ deleteEnergyProject(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a energy project custom field * * @param energyProjectId The id of the energy project * @param udfId The id of the custom field */ downloadEnergyProjectCustomFields(energyProjectId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an Energy Project * * @param projectId The identifier for the energy project being edited * @param body */ editEnergyProject(projectId: number, body?: EnergyProjectEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a energy project * * @param energyProjectId The id of the energy project * @param body The list of udf values being edited */ editEnergyProjectCustomFields(energyProjectId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an energy project * * @param projectId The identifier for the energy project to retrieve */ getEnergyProject(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for a energy project * * @param energyProjectId The id of the energy project */ getEnergyProjectCustomFields(energyProjectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the energy project managers * * @param query */ getEnergyProjectManager(query?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all the energy project types * */ getEnergyProjectTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an Energy Project * * @param body Data representing the Energy project being created */ createEnergyProjectWithHttpInfo(body?: EnergyProjectCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a energy project type * * @param body */ createEnergyProjectTypeWithHttpInfo(body?: EnergyProjectTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an Energy Project * * @param projectId The identifier for the energy project being deleted */ deleteEnergyProjectWithHttpInfo(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a energy project custom field * * @param energyProjectId The id of the energy project * @param udfId The id of the custom field */ downloadEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an Energy Project * * @param projectId The identifier for the energy project being edited * @param body */ editEnergyProjectWithHttpInfo(projectId: number, body?: EnergyProjectEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a energy project * * @param energyProjectId The id of the energy project * @param body The list of udf values being edited */ editEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get an energy project * * @param projectId The identifier for the energy project to retrieve */ getEnergyProjectWithHttpInfo(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a energy project * * @param energyProjectId The id of the energy project */ getEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the energy project managers * * @param query */ getEnergyProjectManagerWithHttpInfo(query?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all the energy project types * */ getEnergyProjectTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountConnectionStatusResponse { /** * When true this database is connectable to Portfolio Manager */ connectable: boolean | null | undefined; /** * Whether some other database is registered to portfolio manager or not */ otherDatabaseRegistered: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PmCommodityChild { /** * Commodity code from Portfolio Manager */ pmCommodityCode: string | null | undefined; /** * When true, auto-created Portfolio Manager meters will be of this commodity */ isDefault: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarCommodityMeterTypeMappingChild { /** * The unit code in Portfolio Manager */ pmUnitCode: string | null | undefined; /** * When true, auto-created Portfolio Manager meters of this commodity are serviced \"by delivery\" rather than \"by metering\" */ isDelivery: boolean | null | undefined; /** * List of supported Portfolio Manager commodities for this ECAP Commodity Every entry includes the commodity code and whether the commodity is the default for Portfolio Manager */ suportedPmCommoditiesWithDefault: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarCommodityMeterTypeMapping { submissionUnit: UnitChild | null | undefined; portfolioManagerCommodityMapping: EnergyStarCommodityMeterTypeMappingChild | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; commodityIcon: Icon | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceMetricsRequest { /** * The begin period for updating ENERGY STAR metrics Required Valid billing period between 190001 and 300001 */ beginPeriod: number | null; /** * The end period for updating ENERGY STAR metrics If null, metrics will only be retrieved for the period specified in BeginPeriod */ endPeriod: number | null | undefined; /** * List of place identifiers to for which to update metrics Required Cannot be Empty */ placeIds: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceSubmissionStatusChild { /** * The submission period */ submissionPeriod: number | null | undefined; /** * The submission period display name. Only populated if the submission period has a custom name. */ submissionPeriodDisplayName: string | null | undefined; /** * The submission status: Submitted - submission has been made for this place and submission period Incomplete - no submission has been made for this place and submission period, and current billing data is incomplete Ready - no submission has been made for this place and submission period, and current billing data is complete */ submissionStatus: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceSizeChild { /** * The identifier for this PlaceSize record */ placeSizeId: number | null | undefined; /** * The effective start date for this place size record */ beginDate: Date | null | undefined; /** * The effective end date for this place size record */ endDate: Date | null | undefined; /** * The value of the current place size record */ value: number | null | undefined; /** * The identifier for the unit this place size is measured in */ unitId: number | null | undefined; /** * The code for the unit this place size is measured in Must be between 0 and 16 characters Must be between 0 and 16 characters */ unitCode: string | null | undefined; /** * The name of the unit this place size is measured in Must be between 0 and 32 characters Must be between 0 and 32 characters */ unitInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SubmissionTypeResponse { /** * The identifier for the submission type */ submissionTypeId: number | null | undefined; /** * The name of the submission type */ submissionTypeName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceSubmissionStatusResponse { /** * The place identifier */ placeId: number | null | undefined; /** * The place name */ placeInfo: string | null | undefined; /** * The place code */ placeCode: string | null | undefined; placeSubmissionType: SubmissionTypeResponse | null | undefined; placeSize: PlaceSizeChild | null | undefined; /** * The list of submission periods and the submission status for each period */ placeSubmissionStatus: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPmMeter { /** * The Portfolio Manager meter identifier */ pmMeterId: number | null | undefined; /** * The Portfolio Manager meter name */ pmMeterName: string | null | undefined; /** * The Portfolio Manager commodity */ pmCommodityCode: string | null | undefined; /** * The Portfolio Manager unit of measure */ pmUnitCode: string | null | undefined; meter: MeterChild | null | undefined; unit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPmProperty { /** * The Portfolio Manager property identifier null when not linked to a portfolio manager property */ pmPropertyId: number | null | undefined; /** * The Portfolio Manager property name null when not linked to a portfolio manager property */ pmPropertyName: string | null | undefined; /** * The Portfolio Manager property use type null when not linked to a portfolio manager property */ pmPropertyUseType: string | null | undefined; /** * The Portfolio Manager floor area null when not linked to portfolio manager property */ pmFloorArea: number | null | undefined; /** * The Portfolio Manager floor area units null when not linked to a portfolio manager property */ pmFloorAreaUnits: string | null | undefined; place: PlaceChild | null | undefined; placeSize: PlaceSizeChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarSettingsRequest { /** * The user name of the Portfolio Manager account to link. Not required if account already registered. Must be between 0 and 128 characters */ pmUserName: string | null | undefined; /** * The earliest period to submit Valid billing period between 190001 and 300001 Required */ earliestSubmissionPeriod: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarSettingsResponse { /** * Full name of Portfolio Account Manager */ pmAccountManagerFullName: string | null | undefined; /** * User name of Portfolio Account Manager */ pmAccountManagerUserName: string | null | undefined; /** * The earliest period to submit */ earliestSubmissionPeriod: number | null | undefined; /** * Number of Portfolio Manager properties that are not linked to any buildings in EnergyCAP */ unlinkedPropertyCount: number | null | undefined; /** * Number of Portfolio Manager properties that are linked to a building in EnergyCAP */ linkedPropertyCount: number | null | undefined; /** * True if this client is configured for ENERGY STAR and Portfolio manager is available. False indicates an issue. EnergyStarConfigurationErrorMessage will contain details */ isEnergyStarAvailable: boolean | null | undefined; /** * If IsEnergystarAvailable is false, this reports the error */ energyStarConfigurationErrorMessage: string | null | undefined; /** * True if running offline mode or if ENERGY STAR has been disabled for this client, false otherwise */ isEnergyStarDisabled: boolean | null | undefined; /** * True if ENERGY STAR has been configured */ isEnergyStarConfigured: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarSubmissionPlaceChild { /** * The place identifier Required */ placeId: number | null; /** * The list of submission periods to include in the submission Required Cannot be Empty */ submissionPeriods: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * NOTE: this class also serves as a representation of EnergyStarTask.settings */ declare class EnergyStarSubmissionRequest { /** * List of places/submission periods to include in ENERGY STAR submission Required Cannot be Empty */ places: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This class represents a date period (YYYYMM) which could be an accounting period or a billing/calendar period. */ declare class NamedPeriod { /** * Name of the period to be displayed Should be empty if billing period */ periodName: string | null | undefined; /** * Value of the period in format (YYYYPP) PP may be a calendar month (e.g. 01-12) but it could be an accounting period (e.g. 01-13) */ period: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarTaskPlaceChild { building: PlaceChild | null | undefined; /** * The list of submission or metrics periods for the task */ taskPeriods: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarTaskResponse { /** * The task identifier */ energyStarTaskId: number | null | undefined; /** * The task type */ taskType: string | null | undefined; /** * The date the submission was initiated */ beginDate: Date | null | undefined; user: UserChild | null | undefined; /** * The number of buildings in the submission */ numberOfPlaces: number | null | undefined; /** * Status for the submission portion of the task */ submissionTaskStatus: string | null | undefined; /** * Status for the metrics retrieval portion of the task */ metricsRetrievalTaskStatus: string | null | undefined; /** * Filename of the log containing errors encountered during submission Will be null if this task is only for metrics retrieval or if there were no errors during submission */ submissionLogFileName: string | null | undefined; /** * Filename of the log containing errors or alerts encountered during metrics retrieval */ metricsRetrievalLogFileName: string | null | undefined; submissionType: SubmissionTypeResponse | null | undefined; /** * The list of buildings/submission periods in the submission */ places: Array | null | undefined; } declare class EnergyStarService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Accept any pending property and meter share requests from ENERGY STAR Portfolio Manager * */ acceptPropertyAndMeterSharingRequests(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Automatically submit billing data to ENERGY STAR By default calendarized bill data for a 13-month period (excludes current and last month) in the \"Ready\" state for all buildings setup to automatically submit to ENERGY STAR will be submitted If 13 months is not preferred, set up the owner's systemdata key called \"EnergyStarAutoSubmitNumOfMonths\" with an integer value representing the preferred number of months For example - Today is 25th Nov 2021 - all calendarized data for Sep 2020 through Sep 2021 will be submitted The buildings submitted will be within the user's topmost place No data prior to the earliest period to submit set up in ENERGY STAR settings will ever be submitted * */ autoSubmitToEnergyStar(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Initiate (create) a submission of place data to ENERGY STAR * * @param body */ createEnergyStarSubmission(body?: EnergyStarSubmissionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit settings for ENERGY STAR submissions * * @param body ENERGY STAR settings */ editEnergyStarSettings(body?: EnergyStarSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all commodities and, if configured, their mappings in ENERGY STAR * */ getEnergyStarCommodityMappings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get settings for ENERGY STAR submissions * */ getEnergyStarSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the submission status for places by submission period. Places that do not match the filter criteria will not be returned. NOTE: Deleting/voiding bills that have already been submitted will not cause submission status to change from \"submitted\". * Returned submission status: Submitted - submission has been made for this place and submission period and no bills have been created or modified since the last submission No Data - no submission has been made for this place and submission period and current submission period has no billing data Incomplete - no submission has been made for this place and submission period and current billing data is incomplete (some meters may not have data or some days in submission period may not have data) Ready - no submission has been made for this place and submission period and current billing data is complete (every meter has data for every day of this period), or submission has been made but billing data has been added or modified since the last submission * @param submissionBeginPeriod The beginning submission period to select * @param submissionEndPeriod The ending submission period to select; set equal to beginning submission period get one period * @param filter API filter string containing conditions */ getEnergyStarSubmissionStatusList(submissionBeginPeriod: number, submissionEndPeriod: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an ENERGY STAR task with its details * * @param energyStarTaskId */ getEnergyStarTask(energyStarTaskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the connection status for a Portfolio Manager account and database * * @param pmUserName User name used to log in to Portfolio Manager */ getPMConnectionStatus(pmUserName?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get list of Portfolio Manager properties * * @param includeOnlyUnlinked Include only unlinked properties * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerProperties(includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Portfolio Manager property * * @param pmPropertyId Portfolio Manager property identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerProperty(pmPropertyId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get list of Portfolio Manager meters for a property * * @param pmPropertyId Portfolio Manager property identifier * @param includeOnlyUnlinked Include only unlinked meters * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmMeterId and PmMeterName from Portfolio Manager. PmCommodityCode and PmUnitCode will be null. */ getPortfolioManagerPropertyMeters(pmPropertyId: number, includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink owner from portfolio manager account * * @param deleteData If true, delete EnergyStar metrics and score. False by default */ unlinkOwnerFromPortfolioManager(deleteData?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update ENERGY STAR metrics for the places matching the request criteria. * * @param body Periods and list of place identifiers for which to update metrics */ updateEnergyStarMetrics(body?: EnergyStarPlaceMetricsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Accept any pending property and meter share requests from ENERGY STAR Portfolio Manager * */ acceptPropertyAndMeterSharingRequestsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Automatically submit billing data to ENERGY STAR By default calendarized bill data for a 13-month period (excludes current and last month) in the \"Ready\" state for all buildings setup to automatically submit to ENERGY STAR will be submitted If 13 months is not preferred, set up the owner's systemdata key called \"EnergyStarAutoSubmitNumOfMonths\" with an integer value representing the preferred number of months For example - Today is 25th Nov 2021 - all calendarized data for Sep 2020 through Sep 2021 will be submitted The buildings submitted will be within the user's topmost place No data prior to the earliest period to submit set up in ENERGY STAR settings will ever be submitted * */ autoSubmitToEnergyStarWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Initiate (create) a submission of place data to ENERGY STAR * * @param body */ createEnergyStarSubmissionWithHttpInfo(body?: EnergyStarSubmissionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit settings for ENERGY STAR submissions * * @param body ENERGY STAR settings */ editEnergyStarSettingsWithHttpInfo(body?: EnergyStarSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all commodities and, if configured, their mappings in ENERGY STAR * */ getEnergyStarCommodityMappingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get settings for ENERGY STAR submissions * */ getEnergyStarSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the submission status for places by submission period. Places that do not match the filter criteria will not be returned. NOTE: Deleting/voiding bills that have already been submitted will not cause submission status to change from \"submitted\". * Returned submission status: Submitted - submission has been made for this place and submission period and no bills have been created or modified since the last submission No Data - no submission has been made for this place and submission period and current submission period has no billing data Incomplete - no submission has been made for this place and submission period and current billing data is incomplete (some meters may not have data or some days in submission period may not have data) Ready - no submission has been made for this place and submission period and current billing data is complete (every meter has data for every day of this period), or submission has been made but billing data has been added or modified since the last submission * @param submissionBeginPeriod The beginning submission period to select * @param submissionEndPeriod The ending submission period to select; set equal to beginning submission period get one period * @param filter API filter string containing conditions */ getEnergyStarSubmissionStatusListWithHttpInfo(submissionBeginPeriod: number, submissionEndPeriod: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get an ENERGY STAR task with its details * * @param energyStarTaskId */ getEnergyStarTaskWithHttpInfo(energyStarTaskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the connection status for a Portfolio Manager account and database * * @param pmUserName User name used to log in to Portfolio Manager */ getPMConnectionStatusWithHttpInfo(pmUserName?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get list of Portfolio Manager properties * * @param includeOnlyUnlinked Include only unlinked properties * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerPropertiesWithHttpInfo(includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a Portfolio Manager property * * @param pmPropertyId Portfolio Manager property identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerPropertyWithHttpInfo(pmPropertyId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get list of Portfolio Manager meters for a property * * @param pmPropertyId Portfolio Manager property identifier * @param includeOnlyUnlinked Include only unlinked meters * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmMeterId and PmMeterName from Portfolio Manager. PmCommodityCode and PmUnitCode will be null. */ getPortfolioManagerPropertyMetersWithHttpInfo(pmPropertyId: number, includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Unlink owner from portfolio manager account * * @param deleteData If true, delete EnergyStar metrics and score. False by default */ unlinkOwnerFromPortfolioManagerWithHttpInfo(deleteData?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update ENERGY STAR metrics for the places matching the request criteria. * * @param body Periods and list of place identifiers for which to update metrics */ updateEnergyStarMetricsWithHttpInfo(body?: EnergyStarPlaceMetricsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Environment { /** * */ buildDate: Date | null | undefined; /** * */ version: string | null | undefined; } declare class EnvironmentService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * */ environment(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ environmentWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelVersionCreate { /** * Indicates the channel observation rule Demand channels cannot have the odometer observation rule Required Must be a valid value for ObservationRuleEnum: Odometer = 1, Trip = 2 */ observationRuleId: EsaChannelVersionCreate.ObservationRuleIdEnum; /** * The channel multiplier Must be between -9999999999999 and 9999999999999 Required Max scale of 15, max precision of 30 */ multiplier: number | null; /** * The channel offset Exclusive to the Trip observation rule Must be between -9999999999999 and 9999999999999 Max scale of 15, max precision of 30 */ offset: number | null | undefined; /** * The channel unit identifier. It cannot be a Money unit type. Required */ unitId: number | null; /** * Indicates if the final value is always positive */ isValuePositive: boolean | null | undefined; /** * The channel Odometer Rollover Value. Exclusive to the Odometer observation rule If not provided, the default 999999999999999 is used Must be between 0 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rolloverValue: number | null | undefined; /** * The channel Odometer Rollover Allowance. Exclusive to the Odometer observation rule If not provided, the default 0.1 is used Must be between 0 and 1 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rollbackAllowance: number | null | undefined; /** * The channel Minimum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ minimumReading: number | null | undefined; /** * The channel Maximum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ maximumReading: number | null | undefined; /** * The formula that should be used to calculate the channel's values. Should only be provided when channel's IsCalculated property equals true. */ formula: string | null | undefined; } declare namespace EsaChannelVersionCreate { enum ObservationRuleIdEnum { NUMBER_1, NUMBER_2 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelCreate { /** * The DatapointId identifier Required */ dataPointId: number | null; esaChannelVersion: EsaChannelVersionCreate | null | undefined; /** * The channel type identifier Required */ observationTypeId: number | null; /** * The channel interval identifier One of '5', '10', '15', '30', '60', '1440', '10080', '43200' Case sensitive Required when IsCalculated is set to False, case sensitive. Must be null when IsCalculated is set to True, case sensitive */ intervalMinutes: number | null | undefined; /** * The name of the ESA channel Max length of 50 Required */ channelInfo: string | null; /** * The channel summarization method identifier Required */ summarizationMethodId: number | null; /** * The channel import identifier Max length of 255 */ channelImportId: string | null | undefined; /** * If the channel is primary value */ isPrimaryValue: boolean | null | undefined; /** * If the channel is demand value */ isPrimaryDemand: boolean | null | undefined; /** * The channel description Max length of 255 */ channelDescription: string | null | undefined; /** * Indicates whether or not this is a calculated channel with a formula. When IsCalculated is true, the formula will need to be provided in channel version. Conversions from Non-Calculated Channel to Calculated Channel: If the channel has no readings, If the channel has only one version, If the channel is not in other formulas Conversions from Calculated Channel to Non-Calculated Channel: If the channel has no readings */ isCalculated: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelVersionEdit { /** * Date and time that this channel version is valid from. The valid period is exclusive of the beginDate. The time zone of this date will match the data point's time zone. Therefore, if any time zone information is provided, it will be ignored. */ beginDate: Date | null | undefined; /** * Indicates the channel observation rule Demand channels cannot have the odometer observation rule Required Must be a valid value for ObservationRuleEnum: Odometer = 1, Trip = 2 */ observationRuleId: EsaChannelVersionEdit.ObservationRuleIdEnum; /** * The channel multiplier Must be between -9999999999999 and 9999999999999 Required Max scale of 15, max precision of 30 */ multiplier: number | null; /** * The channel offset Exclusive to the Trip observation rule Must be between -9999999999999 and 9999999999999 Max scale of 15, max precision of 30 */ offset: number | null | undefined; /** * The channel unit identifier. It cannot be a Money unit type. Required */ unitId: number | null; /** * Indicates if the final value is always positive */ isValuePositive: boolean | null | undefined; /** * The channel Odometer Rollover Value. Exclusive to the Odometer observation rule If not provided, the default 999999999999999 is used Must be between 0 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rolloverValue: number | null | undefined; /** * The channel Odometer Rollover Allowance. Exclusive to the Odometer observation rule If not provided, the default 0.1 is used Must be between 0 and 1 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rollbackAllowance: number | null | undefined; /** * The channel Minimum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ minimumReading: number | null | undefined; /** * The channel Maximum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ maximumReading: number | null | undefined; /** * The formula that should be used to calculate the channel's values. Should only be provided when channel's IsCalculated property equals true. */ formula: string | null | undefined; } declare namespace EsaChannelVersionEdit { enum ObservationRuleIdEnum { NUMBER_1, NUMBER_2 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelEdit { /** * The channel type identifier Required */ observationTypeId: number | null; /** * The channel interval identifier One of '5', '10', '15', '30', '60', '1440', '10080', '43200' Case sensitive Required when IsCalculated is set to False, case sensitive. Must be null when IsCalculated is set to True, case sensitive */ intervalMinutes: number | null | undefined; /** * The name of the ESA channel Max length of 50 Required */ channelInfo: string | null; /** * The channel summarization method identifier Required */ summarizationMethodId: number | null; /** * The channel import identifier Max length of 255 Required (defined) */ channelImportId: string | null | undefined; /** * If the channel is primary value Required (defined) */ isPrimaryValue: boolean | null | undefined; /** * If the channel is demand value Required (defined) */ isPrimaryDemand: boolean | null | undefined; /** * The channel description Max length of 255 Required (defined) */ channelDescription: string | null | undefined; /** * Indicates whether or not this is a calculated channel with a formula. When IsCalculated is true, the formula will need to be provided in channel version. Conversions from Non-Calculated Channel to Calculated Channel: If the channel has no readings, If the channel has only one version, If the channel is not in other formulas Conversions from Calculated Channel to Non-Calculated Channel: If the channel has no readings Required (defined) */ isCalculated: boolean | null | undefined; esaChannelVersion: EsaChannelVersionEdit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataPointChildWithParentAndImportId { parentPlace: PlaceChild | null | undefined; /** * The import identifier for the data point */ dataPointImportId: string | null | undefined; /** * The data point identifier */ dataPointId: number | null | undefined; /** * The data point code */ dataPointCode: string | null | undefined; /** * The data point info */ dataPointInfo: string | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the data point is Active */ active: boolean | null | undefined; /** * Indicates whether the data point is a calculated data point */ isCalculatedDataPoint: boolean | null | undefined; /** * The data point's current serial number */ serialNumber: string | null | undefined; /** * Indicates if the primary value channel on the datapoint has a summarization method of SUM */ isDataRolledUp: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelVersionResponse { /** * The channel version identifier */ channelVersionId: number | null | undefined; /** * The channel multiplier */ multiplier: number | null | undefined; /** * The channel offset */ offset: number | null | undefined; unit: UnitChild | null | undefined; observationRule: ObservationRule | null | undefined; /** * The channel's minimum reading */ minimumReading: number | null | undefined; /** * The channel's maximum reading */ maximumReading: number | null | undefined; /** * Date and time that this channel version is valid from. The valid period is exclusive of the beginDate. */ beginDate: Date | null | undefined; /** * Date and time that this channel version is valid until. The valid period is inclusive of the endDate. */ endDate: Date | null | undefined; /** * Indicates if the channel final value is always positive */ isValuePositive: boolean | null | undefined; /** * The channel's rollover value */ rolloverValue: number | null | undefined; /** * The channel's roll back allowance */ rollbackAllowance: number | null | undefined; /** * The formula that should be used in calculated channels. */ formula: string | null | undefined; /** * Formula, but with the input Channels and Meters referenced by ChannelInfo (name) instead of by ID. */ resolvedFormula: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Class derived from MeterChildDTO - has this meter's parent place information /// */ declare class MeterChildIncludePlace { parentPlace: PlaceChild | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SummarizationMethod { /** * The summarization method identifier */ summarizationMethodId: number | null | undefined; /** * The name of the summarization method */ summarizationMethodInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelResponse { observationType: ObservationTypeChild | null | undefined; /** * Description of the channel */ channelDescription: string | null | undefined; /** * The import identifier for the channel. */ channelImportId: string | null | undefined; /** * Indicates if the channel has readings */ hasReadings: boolean | null | undefined; /** * DateTimeOffset of the earliest Reading for the Channel. For Calculated Channels, this is the first Summarized Reading. For all other Channels, this is the first Processed Reading. The DateTimeOffset will always be a valid time in the Meter's Time Zone. If the offset is removed, it will be the local date and time, in the Meter's Time Zone. */ firstReadingDate: Date | null | undefined; /** * DateTimeOffset of the most recent Reading for the Channel. For Calculated Channels, this is the most recent Summarized Reading. For all other Channels, this is the most recent Processed Reading. The DateTimeOffset will always be a valid time in the Meter's Time Zone. If the offset is removed, it will be the local date and time, in the Meter's Time Zone. */ lastReadingDate: Date | null | undefined; lastReadingValue: ValueWithUnit | null | undefined; /** * Indicates if the channel is the primary value channel for the data point */ isPrimaryValue: boolean | null | undefined; /** * Indicates if the channel is the primary demand channel for the data point */ isPrimaryDemand: boolean | null | undefined; /** * Indicates if the channel is calculated */ isCalculated: boolean | null | undefined; /** * Indicates if the channel can be converted from calculated to non-calculated or vice-versa From Non-Calculated to Calculated: If the channel has no readings, If the channel has only one version, If the channel is not in other formulas From Calculated to Non-Calculated: If the channel has no readings */ isCalculatedConvertible: boolean | null | undefined; summarizationMethod: SummarizationMethod | null | undefined; /** * List of channel versions Versions include channel settings that may change over time */ channelVersions: Array | null | undefined; dataPoint: DataPointChildWithParentAndImportId | null | undefined; meter: MeterChildIncludePlace | null | undefined; /** * The identifier for the channel */ channelId: number | null | undefined; /** * The channel interval */ interval: number | null | undefined; /** * The channel name */ channelInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaChannelVersionCreateWithBeginDate { /** * Date and time that this channel version is valid from. The valid period is exclusive of the beginDate. The time zone of this date will match the data point's time zone. Therefore, if any time zone information is provided, it will be ignored. */ beginDate: Date | null | undefined; /** * Indicates the channel observation rule Demand channels cannot have the odometer observation rule Required Must be a valid value for ObservationRuleEnum: Odometer = 1, Trip = 2 */ observationRuleId: EsaChannelVersionCreateWithBeginDate.ObservationRuleIdEnum; /** * The channel multiplier Must be between -9999999999999 and 9999999999999 Required Max scale of 15, max precision of 30 */ multiplier: number | null; /** * The channel offset Exclusive to the Trip observation rule Must be between -9999999999999 and 9999999999999 Max scale of 15, max precision of 30 */ offset: number | null | undefined; /** * The channel unit identifier. It cannot be a Money unit type. Required */ unitId: number | null; /** * Indicates if the final value is always positive */ isValuePositive: boolean | null | undefined; /** * The channel Odometer Rollover Value. Exclusive to the Odometer observation rule If not provided, the default 999999999999999 is used Must be between 0 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rolloverValue: number | null | undefined; /** * The channel Odometer Rollover Allowance. Exclusive to the Odometer observation rule If not provided, the default 0.1 is used Must be between 0 and 1 Max scale of 15, max precision of 30 NULL Valid Must be null when ObservationRuleId is set to Trip, case sensitive */ rollbackAllowance: number | null | undefined; /** * The channel Minimum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ minimumReading: number | null | undefined; /** * The channel Maximum Computed Reading Must be between -999999999999999 and 999999999999999 Max scale of 15, max precision of 30 NULL Valid */ maximumReading: number | null | undefined; /** * The formula that should be used to calculate the channel's values. Should only be provided when channel's IsCalculated property equals true. */ formula: string | null | undefined; } declare namespace EsaChannelVersionCreateWithBeginDate { enum ObservationRuleIdEnum { NUMBER_1, NUMBER_2 } } declare class EsaChannelService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an ESA channel * * @param body Data representing the ESA channel being created */ createEsaChannel(body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel version being created */ createEsaChannelVersion(esaChannelId: number, body?: EsaChannelVersionCreateWithBeginDate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA channel * * @param esaChannelId The ESA channel identifier */ deleteEsaChannel(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel being edited */ editEsaChannel(esaChannelId: number, body?: EsaChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier * @param body Data representing the ESA channel version being edited */ editEsaChannelVersion(esaChannelId: number, versionId: number, body?: EsaChannelVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an ESA channel * * @param esaChannelId The ESA channel identifier */ getEsaChannel(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier */ getEsaChannelVersion(esaChannelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all ESA channel version for a specified ESA channel * * @param esaChannelId */ getEsaChannelVersions(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannels(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA channel * * @param body Data representing the ESA channel being created */ createEsaChannelWithHttpInfo(body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel version being created */ createEsaChannelVersionWithHttpInfo(esaChannelId: number, body?: EsaChannelVersionCreateWithBeginDate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an ESA channel * * @param esaChannelId The ESA channel identifier */ deleteEsaChannelWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel being edited */ editEsaChannelWithHttpInfo(esaChannelId: number, body?: EsaChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier * @param body Data representing the ESA channel version being edited */ editEsaChannelVersionWithHttpInfo(esaChannelId: number, versionId: number, body?: EsaChannelVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA channel * * @param esaChannelId The ESA channel identifier */ getEsaChannelWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier */ getEsaChannelVersionWithHttpInfo(esaChannelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all ESA channel version for a specified ESA channel * * @param esaChannelId */ getEsaChannelVersionsWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannelsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaPlaceSizeCreate { /** * The begin date for the place size Required */ beginDate: Date | null; /** * The place size value Required Must be between 0 and 2147483647 */ value: number | null; /** *

The place size's unit code

Options are: SQFEET for Square Feet, SQMETER for Square Meters, HECTARE, SQKILOMETER for Square Kilometers, SQMILE for Square Miles, SQYARD for Square Yards, and ACRE.

One of 'SQFEET', 'SQMETER', 'HECTARE', 'SQKILOMETER', 'SQMILE', 'SQYARD', 'ACRE' Case sensitive Must be between 0 and 16 characters Required (defined) */ unitCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EditEsaPlaceSizesRequest { /** * Required (defined) */ calculateArea: boolean | null | undefined; /** * Must be null when CalculateArea is set to True, case sensitive Required (defined) */ placeSizes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaPlaceCreate { /** * The place code. Required Must be between 0 and 32 characters Not ROOT */ placeCode: string | null; /** * The place info. Required Must be between 0 and 50 characters */ placeInfo: string | null; /** * The identifier for the parent of the place. The parent is the place directly above the current place. Topmost (Space) Required */ parentPlaceId: number | null; /** * The identifier for the place type. Required */ placeTypeId: number | null; /** * The identifier for the place's primary use. If this is a site and PrimaryUseId is null this will be set to Unknown (PrimaryUseId 55). Not valid for Spaces. */ primaryUseId: number | null | undefined; /** * The date and time the place was built. Not valid for Spaces. */ buildDate: Date | null | undefined; address: AddressChild | null | undefined; /** * The code for the weather station the place is assigned to. Not valid for Spaces. Must be between 0 and 32 characters */ weatherStationCode: string | null | undefined; /** * A description of the place. Must be between 0 and 4000 characters */ placeDescription: string | null | undefined; /** * The name of the place's image. Not valid for Spaces. */ imageFilename: string | null | undefined; /** * The time zone identifier. Not valid for Spaces. */ timeZoneId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaPlaceDataRollupRequest { /** * The IDs of the Places to be updated. Each ID should appear no more than once. Cannot be Empty Required (defined) */ placeIds: Array | null | undefined; /** * A flag indicating whether or not this Place's summary totals should \"roll up\". - i.e. whether they should contribute to the Place's parent's (and other ancestors') Required (defined) */ dataRollup: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaPlaceEdit { /** * The place code. Required Must be between 0 and 32 characters Not ROOT */ placeCode: string | null; /** * The place info. Required Must be between 0 and 50 characters */ placeInfo: string | null; /** * The identifier for the parent of the place. The parent is the place directly above the current place. Topmost (Space) Required */ parentPlaceId: number | null; /** * The identifier for the place type. Required */ placeTypeId: number | null; /** * The identifier for the place's primary use. If this is a site and PrimaryUseId is null this will be set to Unknown (PrimaryUseId 55). Not valid for Spaces. Required (defined) */ primaryUseId: number | null | undefined; /** * The date and time the place was built. Not valid for Spaces. Required (defined) */ buildDate: Date | null | undefined; address: AddressChild | null | undefined; /** * The code for the weather station the place is assigned to. Not valid for Spaces. Must be between 0 and 32 characters Required (defined) */ weatherStationCode: string | null | undefined; /** * A description of the place. Must be between 0 and 4000 characters Required (defined) */ placeDescription: string | null | undefined; /** * The name of the place's image. Not valid for Spaces. Required (defined) */ imageFilename: string | null | undefined; /** * The time zone identifier. Not valid for Spaces. Required (defined) */ timeZoneId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataPointChild { /** * The data point identifier */ dataPointId: number | null | undefined; /** * The data point code */ dataPointCode: string | null | undefined; /** * The data point info */ dataPointInfo: string | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the data point is Active */ active: boolean | null | undefined; /** * Indicates whether the data point is a calculated data point */ isCalculatedDataPoint: boolean | null | undefined; /** * The data point's current serial number */ serialNumber: string | null | undefined; /** * Indicates if the primary value channel on the datapoint has a summarization method of SUM */ isDataRolledUp: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarRatingChild { /** * The date the score was received */ ratingDate: Date | null | undefined; /** * The year and month for the ENERGY STAR score */ calendarPeriod: number | null | undefined; /** * The ENERGY STAR score */ rating: number | null | undefined; /** * The weather-normalized property energy use intensity (kBtu/ft²) */ siteEnergyUseIntensity: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkCategoryResponse { /** * Benchmark Category Id */ benchmarkCategoryId: number | null | undefined; /** * Benchmark Category Info */ benchmarkCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkValue { /** * Indicator for which benchmark factor Required (defined) */ benchmarkValueId: number | null | undefined; /** * Effective Date for the benchmark factor Required (defined) */ effectiveDate: Date | null | undefined; /** * End Date for the benchmark factor Required (defined) */ endDate: Date | null | undefined; /** * Value set for the benchmark factor Required (defined) */ value: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LatestBenchmarkValue { benchmarkValue: BenchmarkValue | null | undefined; /** * Indicator for which benchmark factor */ benchmarkIndicator: number | null | undefined; /** * benchmark info */ benchmarkInfo: string | null | undefined; benchmarkCategory: BenchmarkCategoryResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleChild { /** * The ID of this Schedule record. */ scheduleId: number | null | undefined; /** * Information about this schedule. This can be thought of as a name. For example, \"24/7\". */ scheduleInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WatticsSite { /** * The identifier for a SmartAnalytics (Wattics) site */ watticsSiteId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherStationChild { /** * Weather Station Id */ stationId: number | null | undefined; /** * Weather Station Code */ stationCode: string | null | undefined; /** * Weather Station Name */ stationInfo: string | null | undefined; /** * City the weather station is located */ city: string | null | undefined; /** * State the weather station is located */ state: string | null | undefined; /** * Country the weather station is located */ country: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaPlaceResponse { parent: PlaceChild | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * The date and time the place was created */ createdDate: Date | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time of the most recent modification to the place */ modifiedDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; address: AddressChild | null | undefined; /** * The date and time the place was built */ buildDate: Date | null | undefined; primaryUse: PrimaryUseChild | null | undefined; weatherStation: WeatherStationChild | null | undefined; size: PlaceSizeChild | null | undefined; benchmark1: LatestBenchmarkValue | null | undefined; benchmark2: LatestBenchmarkValue | null | undefined; benchmark3: LatestBenchmarkValue | null | undefined; /** * Tells whether energy star is enabled for the given place */ energyStarEnabled: boolean | null | undefined; energyStarRating: EnergyStarRatingChild | null | undefined; /** * An array of child places. A child place is one directly beneath the current place */ places: Array | null | undefined; /** * An array of child meters. A child meter is one directly beneath the current place */ meters: Array | null | undefined; /** * An array of child data points. A child data point is one directly beneath the current place */ dataPoints: Array | null | undefined; contact: ContactChild | null | undefined; /** * A description of the place */ placeDescription: string | null | undefined; watticsSite: WatticsSite | null | undefined; /** * Tells whether the place area is calculated from its children (TODO: Use 'Area' instead of 'Size'? Would be inconsistent with Size property in DTO) */ isSizeCalculated: boolean | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. Currently only supported by ESA. */ isDataRolledUp: boolean | null | undefined; sizeInReportingUnit: PlaceSizeChild | null | undefined; /** * The name of the place's image. Currently only supported by ESA. */ imageFilename: string | null | undefined; timeZone: TimeZoneChild | null | undefined; /** * The place's schedules */ schedules: Array | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceSizeResponse { /** * The identifier for the current place */ placeId: number | null | undefined; /** * The code for the current place */ placeCode: string | null | undefined; /** * The name of the current place */ placeInfo: string | null | undefined; /** * The identifier for this PlaceSize record */ placeSizeId: number | null | undefined; /** * The effective start date for this place size record */ beginDate: Date | null | undefined; /** * The effective end date for this place size record */ endDate: Date | null | undefined; /** * The value of the current place size record */ value: number | null | undefined; /** * The identifier for the unit this place size is measured in */ unitId: number | null | undefined; /** * The code for the unit this place size is measured in Must be between 0 and 16 characters */ unitCode: string | null | undefined; /** * The name of the unit this place size is measured in Must be between 0 and 32 characters */ unitInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DayOfWeek { /** * Day of the week as represented by a number */ dayOfWeekNumber: number | null | undefined; /** * Day of the week name */ dayOfWeekName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleDay { /** * The ID of this ScheduleDay record. */ scheduleDayId: number | null | undefined; dayOfWeek: DayOfWeek | null | undefined; /** * The time of day that this schedule begins. It is serialized as a \"HH:MM:SS\" string. For example, \"09:00:00\". */ beginTime: string | null | undefined; /** * The time of day that this schedule ends. It is serialized as a \"HH:MM:SS\" string. For example, \"17:29:59\". */ endTime: string | null | undefined; /** * Indicates whether the record represents an opening period of 24 hours. - i.e. starting at \"00:00:00\" and finishing at \"23:59:59\" */ is24Hours: boolean | null | undefined; /** * Indicates whether the record represents being closed for the entire day. If this is `true` then BeginTime and EndTime will both be null. */ isClosed: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleResponse { /** * A longer description of this schedule. For example, \"9-5, Mon-Fri\". */ scheduleDescription: string | null | undefined; /** * A list of 7 ScheduleDay records, each of which defines the open hours for a single day of the week. They are returned in order, beginning with Sunday and ending with Saturday. */ scheduleDays: Array | null | undefined; createdBy: UserChild | null | undefined; /** * The date when the schedule was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date when the version was schedule */ modifiedDate: Date | null | undefined; /** * The ID of this Schedule record. */ scheduleId: number | null | undefined; /** * Information about this schedule. This can be thought of as a name. For example, \"24/7\". */ scheduleInfo: string | null | undefined; } declare class EsaPlaceService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Set and Reset the data Rollup from esa place * * @param body The list of placeIds and If the Rollup is true or false */ bulkEditDataRollup(body?: EsaPlaceDataRollupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA place * * @param body Data representing the ESA place being created */ createEsaPlace(body?: EsaPlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA place * * @param placeId The identifier for the ESA place being deleted */ deleteEsaPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA place * * @param placeId The identifier for the ESA place being edited * @param body Data representing the ESA place being edited */ editEsaPlace(placeId: number, body?: EsaPlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manages the schedules of a place * * @param placeId The place identifier * @param body A list of schedule identifiers to assign */ editEsaPlaceSchedules(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manages the version history for a single ESA place. This endpoint handles Creating, Editing, and Deleting place sizes for ESA places in bulk. * * @param placeId * @param body */ editEsaPlaceSizeHistory(placeId: number, body?: EditEsaPlaceSizesRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA place by place ID * * @param placeId The identifier for the ESA place being retrieved */ getEsaPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the current sizes of all of an ESA place's children. If a place has no children, nothing is returned. * * @param placeId */ getEsaPlaceChildrenSizes(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the schedules of a place * * @param placeId The place identifier */ getEsaPlaceSchedules(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the entire size history of an ESA place by ID * * @param placeId */ getEsaPlaceSizeHistory(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of places to be under a parent place * * @param parentPlaceId The identifier for the new parent place * @param body List of place identifiers to move */ moveEsaPlace(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Set and Reset the data Rollup from esa place * * @param body The list of placeIds and If the Rollup is true or false */ bulkEditDataRollupWithHttpInfo(body?: EsaPlaceDataRollupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA place * * @param body Data representing the ESA place being created */ createEsaPlaceWithHttpInfo(body?: EsaPlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an ESA place * * @param placeId The identifier for the ESA place being deleted */ deleteEsaPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA place * * @param placeId The identifier for the ESA place being edited * @param body Data representing the ESA place being edited */ editEsaPlaceWithHttpInfo(placeId: number, body?: EsaPlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manages the schedules of a place * * @param placeId The place identifier * @param body A list of schedule identifiers to assign */ editEsaPlaceSchedulesWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manages the version history for a single ESA place. This endpoint handles Creating, Editing, and Deleting place sizes for ESA places in bulk. * * @param placeId * @param body */ editEsaPlaceSizeHistoryWithHttpInfo(placeId: number, body?: EditEsaPlaceSizesRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an ESA place by place ID * * @param placeId The identifier for the ESA place being retrieved */ getEsaPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the current sizes of all of an ESA place's children. If a place has no children, nothing is returned. * * @param placeId */ getEsaPlaceChildrenSizesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets the schedules of a place * * @param placeId The place identifier */ getEsaPlaceSchedulesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the entire size history of an ESA place by ID * * @param placeId */ getEsaPlaceSizeHistoryWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Move list of places to be under a parent place * * @param parentPlaceId The identifier for the new parent place * @param body List of place identifiers to move */ moveEsaPlaceWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingDelete { /** * The identifier for the ESA channel of the reading Required */ esaChannelId: number | null; /** * The begin date and time of the set of readings to be deleted. If provided, readings after (but not including) this date and time will be deleted. If provided, and equal to TimeEnd, delete the single reading at this date and time (if present). If not provided, readings since the start of time will be deleted. If TimeEnd is also not provided, ALL readings belonging to EsaChannelId will be deleted. If UseDataPointTimeZone is false, this time is interpreted as an absolute timestamp. For example, \"2024-01-01 05:00:00 -04:00\". If UseDataPointTimeZone is true, the following applies: The time is presumed to be in the time zone of the data point. If an offset is provided, it will be ignored. For example, if \"2024-01-01 05:00:00 -04:00\" is provided but the time zone of the data point is \"GMT\" then this will get turned into \"2024-01-01 05:00:00 +00:00\" before being applied. If an ambiguous time is provided (for instance 01:30 when the clocks go backward for a DST change) then choose the earliest one in absolute time. If an invalid time is provided (for example 02:30 when the clocks go forward for a DST change) then shift forward by the amount of the DST change (in this example, +1hr will make it 03:30, in the DataPoint's time zone). */ timeBegin: Date | null | undefined; /** * The end date and time of the set of readings to be deleted. If provided, readings up to (and including) this date and time will be deleted. If provided, and equal to TimeBegin, delete the single reading at this date and time (if present). If not provided, readings until the end of time will be deleted. If TimeBegin is also not provided, ALL readings belonging to EsaChannelId will be deleted. See TimeBegin for a discussion of how the value of UseDataPointTimeZone affects the interpretation of this value. */ timeEnd: Date | null | undefined; /** * */ useDataPointTimeZone: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaDeleteReadingResponse { /** * Data representing the failed reading deletion */ failures: Array | null | undefined; /** * The number of readings deleted */ deleted: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingSummarizedDelete { /** * The identifier for the ESA channel of the reading Required */ esaChannelId: number | null; /** * The begin date and time of the set of readings to be deleted. If provided, readings after (but not including) this date and time will be deleted. If provided, and equal to TimeEnd, delete the single reading at this date and time (if present). If not provided, readings since the start of time will be deleted. If TimeEnd is also not provided, ALL readings belonging to EsaChannelId will be deleted. If UseDataPointTimeZone is false, this time is interpreted as an absolute timestamp. For example, \"2024-01-01 05:00:00 -04:00\". If UseDataPointTimeZone is true, the following applies: The time is presumed to be in the time zone of the data point. If an offset is provided, it will be ignored. For example, if \"2024-01-01 05:00:00 -04:00\" is provided but the time zone of the data point is \"GMT\" then this will get turned into \"2024-01-01 05:00:00 +00:00\" before being applied. If an ambiguous time is provided (for instance 01:30 when the clocks go backward for a DST change) then choose the earliest one in absolute time. If an invalid time is provided (for example 02:30 when the clocks go forward for a DST change) then shift forward by the amount of the DST change (in this example, +1hr will make it 03:30, in the DataPoint's time zone). */ timeBegin: Date | null | undefined; /** * The end date and time of the set of readings to be deleted. If provided, readings up to (and including) this date and time will be deleted. If provided, and equal to TimeBegin, delete the single reading at this date and time (if present). If not provided, readings until the end of time will be deleted. If TimeBegin is also not provided, ALL readings belonging to EsaChannelId will be deleted. See TimeBegin for a discussion of how the value of UseDataPointTimeZone affects the interpretation of this value. */ timeEnd: Date | null | undefined; /** * */ useDataPointTimeZone: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaDeleteReadingSummarizedResponse { /** * Data representing the failed reading deletion */ failures: Array | null | undefined; /** * The number of readings deleted */ deleted: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * ESA reading value request */ declare class EsaReadingValue { /** * The date and time of the reading. If the 'seconds' portion of the timestamp is greater than 0 the reading is rounded up to the next minute. If UseDataPointTimeZone is true any time zone information on the reading is ignored and the reading is saved in the data point's time zone. If UseDataPointTimeZone is false and a time zone is not present in the timestamp, the reading is saved in UTC. Else, the reading is saved in the time zone provided. Note that the time zone of existing readings are not updated. Delete and recreate a reading if you wish to change its 'raw' time zone. In-app reporting will display the reading adjusted to the data point's time zone from the original time zone it was saved in. Required */ timestamp: Date | null; /** * If true, any time zone information on the timestamp property is ignored and the reading is saved in the data point's time zone. For example, if the timestamp provided is \"2024-01-01 05:00:00 -04:00\" and the data point's time zone offset is -07:00, the reading will be saved as \"2024-01-01 05:00:00 -07:00\". If omitted, this property is presumed to be false, meaning the offset in the timestamp property is honored. */ useDataPointTimeZone: boolean | null | undefined; /** * The reading's value Required Max scale of 15, max precision of 30 Must be between -9999999999999 and 9999999999999 */ value: number | null; /** * Indicates if the reading is estimated. If omitted, this is presumed to be false. */ estimated: boolean | null | undefined; /** * A note pertaining to the reading Max length of 255 */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * ESA reading request */ declare class EsaReadingCreate { /** * Channel Identification The channel that receives the reading is determined by the following rules: Direct pointers to a channel If the EsaChannelId is supplied, then import to that channel. If the EsaChannelId is not supplied look at the EsaChannelImportId property, which indicates a specific channel. Inferred pointers to a channel If the EsaChannelId and EsaChannelImportId are not supplied, look at the DataPointImportId property, which indicates a data point.If that data point has one channel, import to that channel. If that data point has more than one channel, find the channel with the same observation type as the ObservationTypeCode property.If only one is found, import to that channel. If more than one channel is found based on observation type, find the channel with the same output unit as the UnitCode property.If only one is found, import to that channel. If more than one channel is found based on unit, find the channel with the same EsaChannelIntervalMinutes property. If only one is found, import to that channel. Topmost (EsaChannel) At least one of EsaChannelId, EsaChannelImportId, DataPointImportId must not be null */ esaChannelId: number | null | undefined; /** * The import identifier for the channel on which to create the reading. See the EsaChannelId property for more information At least one of EsaChannelId, EsaChannelImportId, DataPointImportId must not be null */ esaChannelImportId: string | null | undefined; /** * The import identifier for the data point on which to create the reading. See the EsaChannelId property for more information At least one of EsaChannelId, EsaChannelImportId, DataPointImportId must not be null */ dataPointImportId: string | null | undefined; /** * The interval in minutes for the channel on which to create the reading. See the EsaChannelId property for more information */ esaChannelIntervalMinutes: number | null | undefined; /** * The observationType code of the reading. See the EsaChannelId property for more information */ observationTypeCode: string | null | undefined; /** * The unit code of the reading. See the EsaChannelId property for more information */ unitCode: string | null | undefined; /** * List of readings Required */ readings: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Failed reading value dtos */ declare class EsaReadingValueError { /** * The date and time of the reading */ timestamp: Date | null | undefined; /** * Indicates if the reading used the data point's time zone */ useDataPointTimeZone: boolean | null | undefined; /** * The reading's value */ value: number | null | undefined; /** * Indicates if the reading is estimated */ estimated: boolean | null | undefined; /** * A note pertaining to the reading */ note: string | null | undefined; /** * The error message */ error: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Failed reading create dtos */ declare class EsaReadingCreateError { /** * The ESA channel id */ esaChannelId: number | null | undefined; /** * The ESA channel import id */ esaChannelImportId: string | null | undefined; /** * The data point import id */ dataPointImportId: string | null | undefined; /** * The esa channel interval */ esaChannelIntervalMinutes: number | null | undefined; /** * The observation type of the esa channel */ observationTypeCode: string | null | undefined; /** * The unit code of the esa channel */ unitCode: string | null | undefined; /** * List of readings */ readings: Array | null | undefined; /** * The error message */ error: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * ESA reading create response */ declare class EsaReadingCreateResponse { /** * The number of successfully imported readings */ importedReadingsCount: number | null | undefined; /** * The number of failed readings */ failedReadingsCount: number | null | undefined; /** * Data representing the failed readings */ failedReadings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ObservationTypeChildBase { /** * The observation type identifier */ observationTypeId: number | null | undefined; /** * The observation type code */ observationTypeCode: string | null | undefined; /** * The observation type info */ observationTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingResponse { /** * The reading's raw value */ rawValue: number | null | undefined; /** * The reading's value after processing */ processedValue: number | null | undefined; /** * Creation method of the reading. 'Manual' when readings are created by users in the UI 'Imported' when readings are created by imports 'Calculated' when readings are created by calculated channels */ creationMethod: string | null | undefined; /** * The date and time of the reading */ timestamp: Date | null | undefined; /** * The date and time of the reading adjusted to the data point's time zone */ localTimestamp: Date | null | undefined; /** * Indicates whether or not the reading is estimated */ estimated: boolean | null | undefined; /** * A note pertaining to the reading */ note: string | null | undefined; /** * Reading's channel ID */ esaChannelId: number | null | undefined; /** * Reading's channel name */ esaChannelInfo: string | null | undefined; /** * Indicates if the channel is calculated */ isCalculatedEsaChannel: boolean | null | undefined; /** * Interval of the reading in minutes */ interval: number | null | undefined; /** * Interval description for the channel on which the reading was originated */ intervalInfo: string | null | undefined; unit: UnitChild | null | undefined; observationType: ObservationTypeChildBase | null | undefined; dataPoint: DataPointChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingSummarizedResponse { /** * */ summarizedValue: number | null | undefined; /** * Creation method of the reading. 'Manual' when readings are created by users in the UI 'System' when readings are calculated from raw or processed readings */ creationMethod: string | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * The summarized reading value converted from the channel unit to the common rollup unit value */ commonRollupValue: number | null | undefined; /** * The summarized reading value converted from the channel unit to the global rollup unit value */ globalRollupValue: number | null | undefined; /** * The date and time of the reading */ timestamp: Date | null | undefined; /** * The date and time of the reading adjusted to the data point's time zone */ localTimestamp: Date | null | undefined; /** * Indicates whether or not the reading is estimated */ estimated: boolean | null | undefined; /** * A note pertaining to the reading */ note: string | null | undefined; /** * Reading's channel ID */ esaChannelId: number | null | undefined; /** * Reading's channel name */ esaChannelInfo: string | null | undefined; /** * Indicates if the channel is calculated */ isCalculatedEsaChannel: boolean | null | undefined; /** * Interval of the reading in minutes */ interval: number | null | undefined; /** * Interval description for the channel on which the reading was originated */ intervalInfo: string | null | undefined; unit: UnitChild | null | undefined; observationType: ObservationTypeChildBase | null | undefined; dataPoint: DataPointChild | null | undefined; } declare class EsaReadingService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create new readings. Existing readings at the same time for a given channel will be overwritten. * * @param body Readings to be imported */ createEsaReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes existing channel readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body */ deleteEsaReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes existing summarized readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. If the summarized reading is system-generated, the endpoint will return an error indicating that it cannot be deleted. * * @param body */ deleteEsaSummarizedReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all raw and processed ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaReadings(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all summarized ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaSummarizedReadings(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all summarized ESA readings and exports them as a CSV file. File contents can be filtered and ordered. * * @param filter * @param orderBy */ getEsaSummarizedReadingsAsCSV(filter?: string, orderBy?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates and Edits summarized readings for a datapoint and channel * * @param body */ upsertEsaSummarizedReading(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create new readings. Existing readings at the same time for a given channel will be overwritten. * * @param body Readings to be imported */ createEsaReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes existing channel readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body */ deleteEsaReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes existing summarized readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. If the summarized reading is system-generated, the endpoint will return an error indicating that it cannot be deleted. * * @param body */ deleteEsaSummarizedReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all raw and processed ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaReadingsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all summarized ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaSummarizedReadingsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all summarized ESA readings and exports them as a CSV file. File contents can be filtered and ordered. * * @param filter * @param orderBy */ getEsaSummarizedReadingsAsCSVWithHttpInfo(filter?: string, orderBy?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates and Edits summarized readings for a datapoint and channel * * @param body */ upsertEsaSummarizedReadingWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionHistoricalExport { /** * Cannot be Empty */ ids: Array | null | undefined; /** * One of '', 'V', 'P', 'R' */ vpr: string | null | undefined; } declare class ExportService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param exportFileName * @param body */ exportHistoricalBills(exportFileName?: string, body?: BillActionHistoricalExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param exportFileName * @param body */ exportHistoricalBillsWithHttpInfo(exportFileName?: string, body?: BillActionHistoricalExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FileDataTypeResponse { /** * The id of the file data type */ fileDataTypeId: number | null | undefined; /** * The code of the file data type */ fileDataTypeCode: string | null | undefined; /** * The name of the file data type */ fileDataTypeInfo: string | null | undefined; /** * A list of supported extensions for this file data type */ supportedExtensions: Array | null | undefined; /** * The maximum size, in bytes, supported for this file data type */ maxSizeInBytes: number | null | undefined; } declare class FileStoreService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get a list of file data types, their supported extensions, and max size * */ getFileDataTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Upload a file * | File Data Type | File Data Type Id | Supported File Types | Maximum Size | |----------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Image | 16 | jpg, png, svg, gif, heic | 100 MB | | PDF | 17 | pdf | 100 MB | | Document | 18 | MS Word (doc, dot, wbk, docx, docm, dotx, dotm, docb) Excel (xls, xlt, xlm, xlsx, xlsm, xltx, xltm, xlsb, xlw) PowerPoint (ppt, pot, pps, pptx, pptm, potx, potm, ppsx, ppsm, sldx, sldm) OpenOffice (odt, ods, odp) OneNote (one) Other (rtf, txt, csv, xml) Zip (zip) | 100 MB | * @param fileDataTypeId The data type of the file. You can retrieve a list of supported data types by calling the GetFileDataTypes API * @param fileName The name of the file * @param body Binary data containing the file contents */ uploadFile(fileDataTypeId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of file data types, their supported extensions, and max size * */ getFileDataTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Upload a file * | File Data Type | File Data Type Id | Supported File Types | Maximum Size | |----------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Image | 16 | jpg, png, svg, gif, heic | 100 MB | | PDF | 17 | pdf | 100 MB | | Document | 18 | MS Word (doc, dot, wbk, docx, docm, dotx, dotm, docb) Excel (xls, xlt, xlm, xlsx, xlsm, xltx, xltm, xlsb, xlw) PowerPoint (ppt, pot, pps, pptx, pptm, potx, potm, ppsx, ppsm, sldx, sldm) OpenOffice (odt, ods, odp) OneNote (one) Other (rtf, txt, csv, xml) Zip (zip) | 100 MB | * @param fileDataTypeId The data type of the file. You can retrieve a list of supported data types by calling the GetFileDataTypes API * @param fileName The name of the file * @param body Binary data containing the file contents */ uploadFileWithHttpInfo(fileDataTypeId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FilterDataResponse { /** * */ value: string | null | undefined; } declare class FilterService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves list of values for data filter * * @param dataFieldId * @param search * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getFilterData(dataFieldId: number, search?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves list of values for data filter * * @param dataFieldId * @param search * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getFilterDataWithHttpInfo(dataFieldId: number, search?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagEdit { /** * Type of the flag Note: Audit exception flag type id cannot be assigned manually Required (defined) At least one of FlagTypeId, FlagStatusId, CostRecovery, Comment, Assignees must not be null */ flagTypeId: number | null | undefined; /** * Current status of the flag One of '1', '2' Case sensitive Required (defined) At least one of FlagTypeId, FlagStatusId, CostRecovery, Comment, Assignees must not be null */ flagStatusId: number | null | undefined; /** * Cost recovery associated with the issue this flag represents Required (defined) At least one of FlagTypeId, FlagStatusId, CostRecovery, Comment, Assignees must not be null */ costRecovery: number | null | undefined; /** * Event and action that has occurred with this flag Required (defined) At least one of FlagTypeId, FlagStatusId, CostRecovery, Comment, Assignees must not be null */ comment: string | null | undefined; /** * All users currently assigned to this flag Required (defined) At least one of FlagTypeId, FlagStatusId, CostRecovery, Comment, Assignees must not be null */ assignees: Array | null | undefined; /** * Determines whether or not the bill will be released from export hold when resolving the bill flag This property cannot be true if HoldFromExport is true. Required (defined) */ releaseExportHold: boolean | null | undefined; /** * Determines whether or not the bill will be held for export when flagging the bill This property cannot be true if ReleaseExportHold is true. Required (defined) */ holdFromExport: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueEdit { /** * The flag issue identifier Required (defined) */ flagIssueId: number | null | undefined; /** * Current status of the flag issue Must be a valid value for FlagStatusEnum: Unresolved = 1, Resolved = 2 Required (defined) */ flagIssueStatusId: FlagIssueEdit.FlagIssueStatusIdEnum; /** * Comment about the flag issue Required (defined) */ comment: string | null | undefined; /** * All users currently assigned to this flag issue Required (defined) */ assignees: Array | null | undefined; } declare namespace FlagIssueEdit { enum FlagIssueStatusIdEnum { NUMBER_1, NUMBER_2 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueEditAction { /** * Current status of the flag issue Must be a valid value for FlagStatusEnum: Unresolved = 1, Resolved = 2 Required (defined) */ flagIssueStatusId: FlagIssueEditAction.FlagIssueStatusIdEnum; /** * Comment about the flag issue Required (defined) */ comment: string | null | undefined; /** * All users currently assigned to this flag issue Required (defined) */ assignees: Array | null | undefined; } declare namespace FlagIssueEditAction { enum FlagIssueStatusIdEnum { NUMBER_1, NUMBER_2 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueListAction { /** * The flag issues to update Required Cannot be Empty */ flagIssueIds: Array | null; flagIssueAction: FlagIssueEditAction | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueActionChild { /** * The flag issue action identifier */ flagIssueActionId: number | null | undefined; /** * Flag issue action information */ flagIssueActionInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueEventChild { /** * The flag issue event identifier */ flagIssueEventId: number | null | undefined; createdBy: UserChild | null | undefined; /** * Date that this flag issue event was created */ createdDate: Date | null | undefined; /** * Comment about the flag issue event */ comment: string | null | undefined; /** * Description of the flag issue event */ description: string | null | undefined; flagIssueAction: FlagIssueActionChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueStatusChild { /** * The flag issue status identifier */ flagIssueStatusId: number | null | undefined; /** * Flag issue status information */ flagIssueStatusInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueTypeChild { /** * The flag issue type identifier */ flagIssueTypeId: number | null | undefined; /** * Flag issue info */ flagIssueTypeInfo: string | null | undefined; /** * More detailed description of the flag issue type */ flagIssueTypeDescription: string | null | undefined; /** * Flag issue category */ flagIssueCategory: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagIssueResponse { /** * The flag issue identifier */ flagIssueId: number | null | undefined; flagIssueType: FlagIssueTypeChild | null | undefined; flagIssueStatus: FlagIssueStatusChild | null | undefined; /** * All events and actions that have occurred with this issue */ flagIssueEvents: Array | null | undefined; /** * All users currently assigned to this issue */ assignees: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagListAction { /** * The entities to update Required (defined) */ entityIds: Array | null | undefined; flagAction: FlagEdit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagActionChild { /** * The flag action identifier */ flagActionId: number | null | undefined; /** * Flag action information */ flagActionInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagEventChild { /** * The flag event identifier */ flagEventId: number | null | undefined; createdBy: UserChild | null | undefined; /** * Date that this flag event was created */ createdDate: Date | null | undefined; /** * Comment about the flag event */ comment: string | null | undefined; /** * Description of the flag event */ description: string | null | undefined; flagAction: FlagActionChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagStatusChild { /** * The flag status identifier */ flagStatusId: number | null | undefined; /** * Flag status information */ flagStatusInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagTypeChild { /** * The flag type identifier */ flagTypeId: number | null | undefined; /** * Flag type information */ flagTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagResponse { /** * The flag identifier */ flagId: number | null | undefined; flagType: FlagTypeChild | null | undefined; flagStatus: FlagStatusChild | null | undefined; createdBy: UserChild | null | undefined; /** * Date the flag was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * Latest date the flag was modified */ modifiedDate: Date | null | undefined; /** * Cost recovery associated with the issue this flag represents */ costRecovery: number | null | undefined; /** * All events and actions that have occurred with this flag */ flagEvents: Array | null | undefined; /** * All users currently assigned to this flag */ assignees: Array | null | undefined; /** * All issues associated with the flag Even if the flag is marked as resolved, the list of issues that were on the flag at that time will remain. This keeps a historic record and allows for filtering. */ flagIssues: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagTypeCreate { /** * The name of the flag type being created Required Must be between 1 and 32 characters */ flagTypeInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagWidgetChild { /** * Identifier for the item could be meterId, placeId, accountId */ itemId: number | null | undefined; /** * Item display (name or code) */ itemDisplay: string | null | undefined; /** * If item is a meter, this will be commodityCode If item is a building, this will say BUILDING If item is a account, this will say ACCOUNT */ itemType: string | null | undefined; /** * Identifier for the parent of the item could be placeId, costCenterId */ parentId: number | null | undefined; /** * Parent display (name or code) */ parentDisplay: string | null | undefined; /** * If parent is a building, this will say BUILDING For all other types, it will say ORGANIZATION If parent is a costcenter, this will say COSTCENTER */ parentItemType: string | null | undefined; /** * If the view is by Account or Meter, true indicates the account or meter is a master for a \"Bill split\" */ splitParent: boolean | null | undefined; /** * If the view is by Account or Meter, true indicates the account or meter is a recipient of a \"Bill split\" */ splitChild: boolean | null | undefined; /** * If the view is by Account or Meter, true indicates the account or meter is part of a \"Bill calculation\" */ calculated: boolean | null | undefined; /** * If the view is by Account or Meter, true indicates the account or meter is active */ active: boolean | null | undefined; /** * Total cost of all the bills that have flags for this item */ cost: number | null | undefined; /** * Total cost recovery for bill flags for this item */ costRecovery: number | null | undefined; /** * Total number of bill flags for this item */ flagCount: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlagWidget { /** * The type of entity we are grouping bill flags by - Meter, Account or Building */ viewBy: string | null | undefined; /** * The status of bill flags - Unresolved or Resolved */ flagStatus: string | null | undefined; /** * Total cost for all the bills that are represented by the bill flags */ totalCost: number | null | undefined; /** * Total cost recovery represented by the bill flags */ totalCostRecovery: number | null | undefined; /** * Total number of bill flags represented */ flagCount: number | null | undefined; /** * List of bill flag rows The rows are sorted by highest cost , then by highest cost recovery, and then by the item's display alphabetically */ results: Array | null | undefined; /** * Total number of results available If pagination was applied, Results list will have \"pagesize\" out of TotalNumberOfResults If pagination was not applied, Results list will have 100 out of TotalNumberOfResults */ totalNumberOfResults: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SingleBoolean { /** * */ value: boolean | null | undefined; } declare class FlagService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccount(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeter(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a flag type * * @param body Contains the name of the flag type being created */ createFlagType(body?: FlagTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a flag type. System flag types cannot be deleted. * * @param flagTypeId The identifier for the flag type being deleted */ deleteFlagType(flagTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit flag data for a specified entity * This API supports a wide variety of Flag-related actions. Below are summaries of expected outcomes for possible combinations of property values. Create Flag(the entity is not yet flagged, therefore there is no \"modified\" info) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | null | null | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | null | **not null** | **not null** | **not null** | **not null** | false | false | Exception, must have a type | | **not null** | null | null | null | null | false | false | Flagged, unresolved, specified type | | **not null** | **not null** | null | null | null | false | false | Flagged, unresolved(ignoring specified status), specified type | | **not null** | null | **not null** | null | null | false | false | Flagged, unresolved, specified type, cost recovery | | **not null** | null | null | **not null**<sup>1</sup> | null | false | false | Flagged, unresolved, specified type <sup>1</sup>If assignees not empty, assigned | | **not null** | null | null | null | **not null** | false | false | Flagged, unresolved, specified type, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment, held from export <sup>2</sup>If assignees not empty, assigned, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>3</sup> | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment <sup>2</sup>If assignees not empty, assigned, comment <sup>3</sup>No action; will not release a newly flagged bill for export | Edit Unresolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Flag type updated | | null | **resolved** | null | null | null | false | false | Resolved | | null | **resolved** | null | null | null | false | **true** | Resolved, released for export | | null | null | **not null** | null | null | false | false | Updated, cost recovery | | null | null | null | **not null** | null | false | false | Assigned | | null | null | null | null | **not null** | false | false | Updated, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Updated, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | Edit Resolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | -------------------------- | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Updated, specified type | | null | **non-null** | null | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | **not null** | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | **not null** | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | null | **not null** | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, released from export <sup>2</sup>Assigned, comment | * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param body The flag edit request */ editFlag(entityType: string, entityId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param flagResolveComment Optional comment that will be recorded in the flag event when resolving the issue * @param body The flag issue edit request */ editFlagIssues(entityType: string, entityId: number, flagResolveComment?: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates flags for a given list of entities. If the entity does not currently have a flag, one will be created. * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param body The changes to be made to the flags */ flagAction(entityType: string, body?: FlagListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given account and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param accountId */ flagInAccountHierarchy(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given cost center and it's child cost centers, accounts, and bills for the existence of a flag For bill flags, void bills are excluded * * @param costCenterId */ flagInCostCenterHierarchy(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given meter and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param meterId */ flagInMeterHierarchy(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given place and it's child places, meters, and bills for the existence of a flag For bill flags, void bills are excluded * * @param placeId */ flagInPlaceHierarchy(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates flag issues for a given list of flag issue ids * * @param body The changes to be made to the flag issues */ flagIssueAction(body?: FlagIssueListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get flag data for a specified entity * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlag(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get flag issues for a specified entity * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagIssues(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available flag types * */ getFlagTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccountWithHttpInfo(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeterWithHttpInfo(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a flag type * * @param body Contains the name of the flag type being created */ createFlagTypeWithHttpInfo(body?: FlagTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a flag type. System flag types cannot be deleted. * * @param flagTypeId The identifier for the flag type being deleted */ deleteFlagTypeWithHttpInfo(flagTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit flag data for a specified entity * This API supports a wide variety of Flag-related actions. Below are summaries of expected outcomes for possible combinations of property values. Create Flag(the entity is not yet flagged, therefore there is no \"modified\" info) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | null | null | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | null | **not null** | **not null** | **not null** | **not null** | false | false | Exception, must have a type | | **not null** | null | null | null | null | false | false | Flagged, unresolved, specified type | | **not null** | **not null** | null | null | null | false | false | Flagged, unresolved(ignoring specified status), specified type | | **not null** | null | **not null** | null | null | false | false | Flagged, unresolved, specified type, cost recovery | | **not null** | null | null | **not null**<sup>1</sup> | null | false | false | Flagged, unresolved, specified type <sup>1</sup>If assignees not empty, assigned | | **not null** | null | null | null | **not null** | false | false | Flagged, unresolved, specified type, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment, held from export <sup>2</sup>If assignees not empty, assigned, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>3</sup> | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment <sup>2</sup>If assignees not empty, assigned, comment <sup>3</sup>No action; will not release a newly flagged bill for export | Edit Unresolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Flag type updated | | null | **resolved** | null | null | null | false | false | Resolved | | null | **resolved** | null | null | null | false | **true** | Resolved, released for export | | null | null | **not null** | null | null | false | false | Updated, cost recovery | | null | null | null | **not null** | null | false | false | Assigned | | null | null | null | null | **not null** | false | false | Updated, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Updated, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | Edit Resolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | -------------------------- | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Updated, specified type | | null | **non-null** | null | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | **not null** | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | **not null** | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | null | **not null** | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, released from export <sup>2</sup>Assigned, comment | * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param body The flag edit request */ editFlagWithHttpInfo(entityType: string, entityId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param flagResolveComment Optional comment that will be recorded in the flag event when resolving the issue * @param body The flag issue edit request */ editFlagIssuesWithHttpInfo(entityType: string, entityId: number, flagResolveComment?: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates flags for a given list of entities. If the entity does not currently have a flag, one will be created. * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param body The changes to be made to the flags */ flagActionWithHttpInfo(entityType: string, body?: FlagListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given account and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param accountId */ flagInAccountHierarchyWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given cost center and it's child cost centers, accounts, and bills for the existence of a flag For bill flags, void bills are excluded * * @param costCenterId */ flagInCostCenterHierarchyWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given meter and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param meterId */ flagInMeterHierarchyWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given place and it's child places, meters, and bills for the existence of a flag For bill flags, void bills are excluded * * @param placeId */ flagInPlaceHierarchyWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates flag issues for a given list of flag issue ids * * @param body The changes to be made to the flag issues */ flagIssueActionWithHttpInfo(body?: FlagIssueListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get flag data for a specified entity * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagWithHttpInfo(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get flag issues for a specified entity * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagIssuesWithHttpInfo(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all available flag types * */ getFlagTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FormulaValidationRequest { /** * Required */ formula: string | null; /** * */ dataPointId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FormulaValidationResponse { /** * */ valid: boolean | null | undefined; /** * */ errorMessages: Array | null | undefined; } declare class FormulaService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Check that a Calculated Meter formula is valid. It is valid if the following are all true: <list type=\"bullet\"><item><description> It is syntactically correct </description></item><item><description> It only calls allowed functions (including the custom function `channel()`\") </description></item><item><description> Each channel referenced (via `channel(channelId)`) is the Primary Value Channel of some other datapoint (which also rules out self-references). </description></item></list> * * @param body Formula to validate */ validateCalculatedMeterFormula(body?: FormulaValidationRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Check that a Calculated Channel formula is valid, in the context of the given datapoint. It is valid if the following are all true: <list type=\"bullet\"><item><description> It is syntactically correct </description></item><item><description> It only calls allowed functions (including the custom function `channel()`\") </description></item><item><description> Each channel referenced (via `channel(channelId)`) belongs to this datapoint and is a simple (not calculated) channel (which also rules out self-references). </description></item></list> * * @param body Formula to validate */ validateFormula(body?: FormulaValidationRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Check that a Calculated Meter formula is valid. It is valid if the following are all true: <list type=\"bullet\"><item><description> It is syntactically correct </description></item><item><description> It only calls allowed functions (including the custom function `channel()`\") </description></item><item><description> Each channel referenced (via `channel(channelId)`) is the Primary Value Channel of some other datapoint (which also rules out self-references). </description></item></list> * * @param body Formula to validate */ validateCalculatedMeterFormulaWithHttpInfo(body?: FormulaValidationRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Check that a Calculated Channel formula is valid, in the context of the given datapoint. It is valid if the following are all true: <list type=\"bullet\"><item><description> It is syntactically correct </description></item><item><description> It only calls allowed functions (including the custom function `channel()`\") </description></item><item><description> Each channel referenced (via `channel(channelId)`) belongs to this datapoint and is a simple (not calculated) channel (which also rules out self-references). </description></item></list> * * @param body Formula to validate */ validateFormulaWithHttpInfo(body?: FormulaValidationRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorCategory { /** * The Factor Category identifier */ factorCategoryId: number | null | undefined; /** * The Factor Category Info */ factorCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorRegion { /** * The Factor Region identifier */ factorRegionId: number | null | undefined; /** * The Factor Region info */ factorRegionInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorResponse { /** * The factor identifier */ factorId: number | null | undefined; /** * The factor code */ factorCode: string | null | undefined; /** * The factor info */ factorInfo: string | null | undefined; /** * The factor description */ factorDescription: string | null | undefined; /** * The source organization */ sourceOrganization: string | null | undefined; /** * The model */ model: string | null | undefined; factorCategory: GHGFactorCategory | null | undefined; fromUnit: UnitChild | null | undefined; factorRegion: GHGFactorRegion | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGGas { /** * Gas identifier */ gasId: number | null | undefined; /** * Gas descrption */ gasInfo: string | null | undefined; /** * Gas amount */ gasAmount: number | null | undefined; /** * Co2Evalue */ co2Evalue: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGVersion { /** * Effective Date */ effectiveDate: Date | null | undefined; /** * Source */ source: string | null | undefined; /** * List of gases per version. */ gases: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorVersionHistoryResponse { /** * Identifier for the factor */ factorId: string | null | undefined; /** * Name of the factor */ factorInfo: string | null | undefined; /** * Description of the factor */ factorDescription: string | null | undefined; factorUnit: UnitChild | null | undefined; factorCO2EUnit: UnitChild | null | undefined; commodityUnit: UnitChild | null | undefined; commodity: CommodityChild | null | undefined; factorCategory: GHGFactorCategory | null | undefined; /** * List of versions */ versions: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGScopeResponse { /** * The Scope Identifier */ scopeId: number | null | undefined; /** * The Scope Info */ scopeInfo: string | null | undefined; /** * The list of Scope Categories under this scope */ scopeCategories: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactor { /** * The GHG Factor type. Values for this field can be \"use meter address\" or \"specific factor\" */ factorType: string | null | undefined; factorCategory: GHGFactorCategory | null | undefined; /** * The Factor Identifier */ factorId: number | null | undefined; /** * The Factor Info */ factorInfo: string | null | undefined; /** * The Factor Description */ factorDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGScope { /** * The Scope Identifier */ scopeId: number | null | undefined; /** * The Scope Info */ scopeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGScopeCategory { scope: GHGScope | null | undefined; /** * The GHG Scope Category Identifier */ scopeCategoryId: number | null | undefined; /** * The GHG Scope Category Info */ scopeCategoryInfo: string | null | undefined; /** * The GHG Scope Category Description */ scopeCategoryDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGSettingResponse { scopeCategory: GHGScopeCategory | null | undefined; factor: GHGFactor | null | undefined; /** * If true, this meter is using the default GHG settings that were in effect at the time the meter was created */ usingDefaultSettings: boolean | null | undefined; /** * Flag indicating whether or not configuration exists for this meter. If false, EnergyCap.DTO.V202210.GHG.GHGSettingResponseDTO.Factor or EnergyCap.DTO.V202210.GHG.GHGSettingResponseDTO.ScopeCategory may be null. */ isConfigured: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasDefaultSettingRequestScopeCategoryAndFactorChild { /** * The Greenhouse Gas Scope category identifier Required (defined) */ scopeCategoryId: number | null | undefined; defaultFactor: GHGDefaultFactor | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasDefaultSettingRequestCommodityChild { /** * The Commodity ID Required (defined) */ commodityId: number | null | undefined; /** * The Commodity default settings Required */ defaultSettings: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasDefaultSettingRequest { /** * Do we want to an create emission source automatically when we create a new meter? Required (defined) */ createEmissionSourcesForMeters: boolean | null | undefined; /** * The Commodity default settings Required */ defaultSettings: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IGHGDefaultScopeCategoryAndFactor { defaultScopeCategory: GHGScopeCategory | null | undefined; defaultFactor: GHGFactor | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasDefaultSettingResponseCommodityChild { /** * The Commodity default settings */ defaultSettings: Array | null | undefined; /** * The Commodity ID */ commodityId: number | null | undefined; /** * The Commodity Code */ commodityCode: string | null | undefined; /** * The Commodity Info */ commodityInfo: string | null | undefined; commodityIcon: Icon | null | undefined; /** * Flag to indicate if the commodity is assigned to any meters */ inUseByVendor: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGasDefaultSettingResponse { /** * Do we want to an create emission source automatically when we create a new meter? */ createEmissionSourcesForMeters: boolean | null | undefined; /** * The default commodity settings */ defaultSettings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterActionCreateEmissionSource { /** * Cannot be Empty */ ids: Array | null | undefined; } declare class GHGService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create emission sources for existing meters. * * @param body The ids of the meters for which to create emission sources */ createEmissionSourceForMeter(body?: MeterActionCreateEmissionSource, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the default GHG scopes and factors that are applied to new meters. Only included CommodityIds will be updated. If a CommodityId is not included in the list the currently assigned value will remain. To remove a default for a particular CommodityId set its ScopeCategoryId and DefaultFactor to null. * * @param body The default GHG scope and factor to be applied */ editDefaultGHGSettingsMultiFactor(body?: GHGasDefaultSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the default GHG scopes and factors that are applied to new meters GHG License is required to call this endpoint * */ getDefaultGHGSettingsMultiFactor(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the ghg factor categories * */ getGHGFactorCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the ghg factor regions * */ getGHGFactorRegions(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the version history of a specific GHG factor * * @param factorId The GHG factor to retrieve history for */ getGHGFactorVersionHistory(factorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the ghg factors * * @param filter The api filters> * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGHGFactors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all GHG scope categories and scopes GHG License is required to call this endpoint * */ getGHGScopesWithCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the configured GHG scope category and factor for a meter. GHG License is required to call this endpoint. * * @param meterId The meter to retrieve settings for */ getMeterGHGSettings(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create emission sources for existing meters. * * @param body The ids of the meters for which to create emission sources */ createEmissionSourceForMeterWithHttpInfo(body?: MeterActionCreateEmissionSource, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the default GHG scopes and factors that are applied to new meters. Only included CommodityIds will be updated. If a CommodityId is not included in the list the currently assigned value will remain. To remove a default for a particular CommodityId set its ScopeCategoryId and DefaultFactor to null. * * @param body The default GHG scope and factor to be applied */ editDefaultGHGSettingsMultiFactorWithHttpInfo(body?: GHGasDefaultSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the default GHG scopes and factors that are applied to new meters GHG License is required to call this endpoint * */ getDefaultGHGSettingsMultiFactorWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the ghg factor categories * */ getGHGFactorCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the ghg factor regions * */ getGHGFactorRegionsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the version history of a specific GHG factor * * @param factorId The GHG factor to retrieve history for */ getGHGFactorVersionHistoryWithHttpInfo(factorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the ghg factors * * @param filter The api filters> * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGHGFactorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all GHG scope categories and scopes GHG License is required to call this endpoint * */ getGHGScopesWithCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the configured GHG scope category and factor for a meter. GHG License is required to call this endpoint. * * @param meterId The meter to retrieve settings for */ getMeterGHGSettingsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GLSubcodeRequest { /** * Index of this subcode (1-20) Required Must be between 1 and 20 */ subCodeIndex: number | null; /** * Name for this SubCode Required Must be between 0 and 32 characters */ subCodeName: string | null; /** * SubCodeType - should be \"list\"(fixed=1 in DB) or \"text\" (fixed=0 in DB) Required One of 'list', 'text' */ subCodeType: string | null; /** * An array of pick list values when this subcode is a \"list\" Required when subCodeType is set to list */ subCodeValues: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GLSubcodeResponse { /** * Index of this subcode (01-20) */ subCodeIndex: string | null | undefined; /** * Name for this SubCode */ subCodeName: string | null | undefined; /** * SubCodeType - will be \"list\"(if fixed=1 in DB) or \"text\" (if fixed=0) in DB */ subCodeType: string | null | undefined; /** * An array of pick list values when this subcode is a \"list\" */ subCodeValues: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GLSubCodeChildRequest { /** * Index of this sub code (1-20) Required Must be between 1 and 20 */ subCodeIndex: number | null; /** * Value for the sub code Must be between 0 and 25 characters */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GeneralLedgerRequest { /** * Unique identifier for the General Ledger Required Must be between 0 and 255 characters */ generalLedgerCode: string | null; /** * List of 20 sub codes and their values Required */ subCodes: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GLSubCodeChild { /** * Index of this subcode (01-20) */ subCodeIndex: string | null | undefined; /** * Name for this SubCode */ subCodeName: string | null | undefined; /** * The value assigned to the subcode */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GeneralLedgerResponse { /** * General Ledger Identifier */ generalLedgerId: number | null | undefined; /** * Unique code for the general ledger */ generalLedgerCode: string | null | undefined; /** * List of 20 subCodes with their index, name, and value */ subCodes: Array | null | undefined; } declare class GeneralLedgerService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a General Ledger * * @param body Data representing the general ledger being created */ createGeneralLedger(body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit General Ledger Subcode definitions - update name, type and if \"list\" type edit (add/delete/edit) pick list values. One or more subcodes can be edited. * * @param body Provide the subcode definition */ editGLSubCodes(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a General Ledger * * @param generalLedgerId General Ledger ID to update * @param body Data representing the general ledger to update */ editGeneralLedger(generalLedgerId: number, body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves specific General Ledger Subcode definition * * @param subCodeIndex The index of the subCode being retrieved */ getGLSubCode(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves unique General Ledger Subcode values * * @param subCodeIndex The index of the subCode whose values are being retrieved */ getGLSubCodeValues(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all General Ledger SubCode definitions * */ getGLSubCodes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific General Ledger * * @param generalLedgerId General Ledger ID to return */ getGeneralLedger(generalLedgerId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgers(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a General Ledger * * @param body Data representing the general ledger being created */ createGeneralLedgerWithHttpInfo(body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit General Ledger Subcode definitions - update name, type and if \"list\" type edit (add/delete/edit) pick list values. One or more subcodes can be edited. * * @param body Provide the subcode definition */ editGLSubCodesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates a General Ledger * * @param generalLedgerId General Ledger ID to update * @param body Data representing the general ledger to update */ editGeneralLedgerWithHttpInfo(generalLedgerId: number, body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves specific General Ledger Subcode definition * * @param subCodeIndex The index of the subCode being retrieved */ getGLSubCodeWithHttpInfo(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves unique General Ledger Subcode values * * @param subCodeIndex The index of the subCode whose values are being retrieved */ getGLSubCodeValuesWithHttpInfo(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all General Ledger SubCode definitions * */ getGLSubCodesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a specific General Ledger * * @param generalLedgerId General Ledger ID to return */ getGeneralLedgerWithHttpInfo(generalLedgerId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalEmissionSource { /** * Indicates if the emission source has a EUM Meter link */ hasEUMMeter: boolean | null | undefined; /** * The emission source identifier */ emissionSourceId: number | null | undefined; /** * The emission source code */ emissionSourceCode: string | null | undefined; /** * The emission source info */ emissionSourceInfo: string | null | undefined; /** * Whether the emission source is active or not */ active: boolean | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalCollections2 { /** * */ parentId: number | null | undefined; /** * */ collectionId: number | null | undefined; /** * */ collectionInfo: string | null | undefined; /** * */ collectionCode: string | null | undefined; collectionIcon: Icon | null | undefined; /** * */ hasChildren: boolean | null | undefined; /** * */ hasCollectionChildren: boolean | null | undefined; /** * */ hasEmissionSourceChildren: boolean | null | undefined; /** * */ hasActiveChildren: boolean | null | undefined; /** * */ hasActiveEmissionSourceChildren: boolean | null | undefined; /** * */ emissionSourceChildren: Array | null | undefined; /** * */ collectionChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalCollections { /** * The collection's parent */ parentId: number | null | undefined; /** * The collection's primary ID */ collectionId: number | null | undefined; /** * The collection info */ collectionInfo: string | null | undefined; /** * The collection code */ collectionCode: string | null | undefined; collectionIcon: Icon | null | undefined; /** * If this collection has any children, either emission sources or collections */ hasChildren: boolean | null | undefined; /** * If this collection has any collection children */ hasCollectionChildren: boolean | null | undefined; /** * If this collection has any emission source children */ hasEmissionSourceChildren: boolean | null | undefined; /** * If this collection has any collection children or active emission source children */ hasActiveChildren: boolean | null | undefined; /** * If this collection has any active emission source children */ hasActiveEmissionSourceChildren: boolean | null | undefined; /** * List of emission source children */ emissionSourceChildren: Array | null | undefined; /** * List of collection children */ collectionChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalCostCenters2 { /** * */ parentId: number | null | undefined; /** * */ costCenterId: number | null | undefined; /** * */ costCenterInfo: string | null | undefined; /** * */ costCenterCode: string | null | undefined; /** * */ hasChildren: boolean | null | undefined; /** * */ hasCostCenterChildren: boolean | null | undefined; /** * */ hasAccountChildren: boolean | null | undefined; /** * */ hasActiveChildren: boolean | null | undefined; /** * */ hasActiveAccountChildren: boolean | null | undefined; /** * */ accountChildren: Array | null | undefined; /** * */ costCenterChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalCostCenters { /** * The cost center's parent */ parentId: number | null | undefined; /** * The cost center's primary ID */ costCenterId: number | null | undefined; /** * CostCenterInfo */ costCenterInfo: string | null | undefined; /** * CostCenterCode */ costCenterCode: string | null | undefined; /** * If this costCenter has any children, either accounts or costCenters */ hasChildren: boolean | null | undefined; /** * If this costCenter has any costCenter children */ hasCostCenterChildren: boolean | null | undefined; /** * If this costCenter has any account children */ hasAccountChildren: boolean | null | undefined; /** * If this costCenter has any costCenter children or active account children */ hasActiveChildren: boolean | null | undefined; /** * If this costCenter has any active account children */ hasActiveAccountChildren: boolean | null | undefined; /** * List of account children */ accountChildren: Array | null | undefined; /** * List of costCenter children */ costCenterChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalMeter { /** * Indicates if the meter has a Smart Analytics (Wattics) Data Point link */ hasWatticsDataPoint: boolean | null | undefined; /** * Indicates if the meter has an Emission Source link */ hasEmissionSource: boolean | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalPlaces2 { /** * */ parentId: number | null | undefined; /** * */ placeId: number | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeTypeId: number | null | undefined; /** * */ hasChildren: boolean | null | undefined; /** * */ hasPlaceChildren: boolean | null | undefined; /** * */ hasMeterChildren: boolean | null | undefined; /** * */ hasActiveChildren: boolean | null | undefined; /** * */ hasActiveMeterChildren: boolean | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * */ meterChildren: Array | null | undefined; /** * */ placeChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalPlaces { /** * The place's parent */ parentId: number | null | undefined; /** * The place's primary ID */ placeId: number | null | undefined; /** * PlaceInfo */ placeInfo: string | null | undefined; /** * PlaceCode */ placeCode: string | null | undefined; /** * PlaceTypeID */ placeTypeId: number | null | undefined; /** * If this place has any children, either meters or places */ hasChildren: boolean | null | undefined; /** * If this place has any place children */ hasPlaceChildren: boolean | null | undefined; /** * If this place has any meter children */ hasMeterChildren: boolean | null | undefined; /** * If this place has any place children or active meter children */ hasActiveChildren: boolean | null | undefined; /** * If this place has any active meter children */ hasActiveMeterChildren: boolean | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * List of meter children */ meterChildren: Array | null | undefined; /** * List of place children */ placeChildren: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalDataPoint { /** * The data point identifier */ dataPointId: number | null | undefined; /** * The data point code */ dataPointCode: string | null | undefined; /** * The data point info */ dataPointInfo: string | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the data point is Active */ active: boolean | null | undefined; /** * Indicates whether the data point is a calculated data point */ isCalculatedDataPoint: boolean | null | undefined; /** * The data point's current serial number */ serialNumber: string | null | undefined; /** * Indicates if the primary value channel on the datapoint has a summarization method of SUM */ isDataRolledUp: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalSpaces2 { /** * */ parentId: number | null | undefined; /** * */ placeId: number | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeCode: string | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * */ hasChildren: boolean | null | undefined; /** * */ hasSpaceChildren: boolean | null | undefined; /** * */ hasDataPointChildren: boolean | null | undefined; /** * */ hasActiveChildren: boolean | null | undefined; /** * */ hasActiveDataPointChildren: boolean | null | undefined; /** * */ dataPointChildren: Array | null | undefined; /** * */ spaceChildren: Array | null | undefined; /** * */ isDataRolledUp: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HierarchicalSpaces { /** * The place's parent */ parentId: number | null | undefined; /** * The place's primary ID */ placeId: number | null | undefined; /** * The place's Info */ placeInfo: string | null | undefined; /** * The place's Code */ placeCode: string | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * If this place has any children, either datapoins or places */ hasChildren: boolean | null | undefined; /** * If this place has any space children */ hasSpaceChildren: boolean | null | undefined; /** * If this place has any data point children */ hasDataPointChildren: boolean | null | undefined; /** * If this place has any active space children or active data point children */ hasActiveChildren: boolean | null | undefined; /** * If this place has any active data point children */ hasActiveDataPointChildren: boolean | null | undefined; /** * List of data point children */ dataPointChildren: Array | null | undefined; /** * List of place children */ spaceChildren: Array | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; } declare class HierarchyService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * For a list of topmost places, get associated topmost cost centers. * * @param body List of placeIds to get associated topmost cost centers. */ availableCostCentersForTopmostPlaces(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For a list of topmost cost centers, get associated topmost places. * * @param body List of costCenterIds to get associated topmost places. */ availablePlacesForTopmostCostCenters(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns account ancestry information, useful for populating a tree of costCenters * * @param accountId Account ID */ hierarchicalAncestryAccounts(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns collection ancestry information, useful for populating a tree of collections * * @param collectionId Collection ID */ hierarchicalAncestryCollections(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns cost center ancestry information, useful for populating a tree of cost centers * * @param costCenterId CostCenter ID */ hierarchicalAncestryCostCenters(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the data point ancestry information, useful for populating a tree of spaces * * @param dataPointId Data point Id */ hierarchicalAncestryDataPoints(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns emission source ancestry information, useful for populating a tree of collections * * @param emissionSourceId Emission Source ID */ hierarchicalAncestryEmissionSources(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns meter ancestry information, useful for populating a tree of places * * @param meterId Meter ID */ hierarchicalAncestryMeters(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns place ancestry information, useful for populating a tree of places * * @param placeId Place ID */ hierarchicalAncestryPlaces(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the space ancestry information, useful for populating a tree of spaces * * @param placeId Place Id */ hierarchicalAncestrySpaces(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns collection descendant information, useful for expanding a collection node * * @param collectionId Collection ID */ hierarchicalCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns costCenter descendant information, useful for expanding a costCenter node * * @param costCenterId CostCenter ID */ hierarchicalCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns place descendant information, useful for expanding a place node * * @param placeId Place ID */ hierarchicalPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the space descendant information, useful for expanding a space node * * @param placeId Place Id */ hierarchicalSpace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For a list of topmost places, get associated topmost cost centers. * * @param body List of placeIds to get associated topmost cost centers. */ availableCostCentersForTopmostPlacesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * For a list of topmost cost centers, get associated topmost places. * * @param body List of costCenterIds to get associated topmost places. */ availablePlacesForTopmostCostCentersWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns account ancestry information, useful for populating a tree of costCenters * * @param accountId Account ID */ hierarchicalAncestryAccountsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns collection ancestry information, useful for populating a tree of collections * * @param collectionId Collection ID */ hierarchicalAncestryCollectionsWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns cost center ancestry information, useful for populating a tree of cost centers * * @param costCenterId CostCenter ID */ hierarchicalAncestryCostCentersWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the data point ancestry information, useful for populating a tree of spaces * * @param dataPointId Data point Id */ hierarchicalAncestryDataPointsWithHttpInfo(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns emission source ancestry information, useful for populating a tree of collections * * @param emissionSourceId Emission Source ID */ hierarchicalAncestryEmissionSourcesWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns meter ancestry information, useful for populating a tree of places * * @param meterId Meter ID */ hierarchicalAncestryMetersWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns place ancestry information, useful for populating a tree of places * * @param placeId Place ID */ hierarchicalAncestryPlacesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the space ancestry information, useful for populating a tree of spaces * * @param placeId Place Id */ hierarchicalAncestrySpacesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns collection descendant information, useful for expanding a collection node * * @param collectionId Collection ID */ hierarchicalCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns costCenter descendant information, useful for expanding a costCenter node * * @param costCenterId CostCenter ID */ hierarchicalCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns place descendant information, useful for expanding a place node * * @param placeId Place ID */ hierarchicalPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the space descendant information, useful for expanding a space node * * @param placeId Place Id */ hierarchicalSpaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class KickoutField { /** * The column identifier. This is a dynamic field and may vary between requests. */ id: number | null | undefined; /** * The column name */ name: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class KickoutValue { /** * The field identifier */ fieldId: number | null | undefined; /** * The kickout value */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportKickoutDetailsResponse { /** * The kickout fields */ fields: Array | null | undefined; /** * The kickout values */ data: Array> | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportProfileObservation { /** * Required Must be between 1 and 2147483647 */ columnIndex: number | null; /** * Required */ observationTypeCode: string | null; /** * Required Must be between 0 and 100 characters */ caption: string | null; /** * Required */ unitCode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportProfileColumnMapping { /** * Required One of 'mm/dd/yyyy', 'Month dd yyyy', 'dd/mm/yyyy', 'dd Month yyyy', 'yyyymmdd' Case sensitive */ dateFormat: string | null; /** * Required Must be between 1 and 2147483647 */ accountCodeColumnIndex: number | null; /** * Required Must be between 1 and 2147483647 */ startDateColumnIndex: number | null; /** * Required Must be between 1 and 2147483647 */ endDateColumnIndex: number | null; /** * Must be between 1 and 2147483647 */ vendorCodeColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ payAmountColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ billingPeriodColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ accountPeriodColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ statementDateColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ dueDateColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ controlCodeColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ invoiceNumberColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ meterCodeColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ commodityColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ serviceChargeColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ aceFlagColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ vprFlagColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ rateColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ serialNumberColumnIndex: number | null | undefined; /** * Must be between 1 and 2147483647 */ billNoteColumnIndex: number | null | undefined; /** * Cannot be Empty */ observations: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportProfileRequest { /** * Required Must be between 0 and 64 characters */ profileCode: string | null; columnMapping: BillImportProfileColumnMapping | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportProfileResponse { /** * */ profileId: number | null | undefined; /** * Required Must be between 0 and 64 characters Required Must be between 0 and 64 characters */ profileCode: string | null; columnMapping: BillImportProfileColumnMapping | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchSettings { /** * needs to be one of - \"use existing batch\", \"new batch\", \"new self-contained batch\", \"use pending batch\", \"smart batch\" if \"use existing batch\" - we will use an existing open batch and leave it open. Used with ExistingOpenBatchId property. if \"new batch\" - make a new batch. LeaveExistingBatchesOpen set to true will leave other batches open. If false or not provided, we close the open batch for this user. If more than one batch is open it fails. if \"new self-contained batch\" - make a new batch and add bills to it and close it. Any open batch will be left open if \"use pending batch\" - PendingBatchId is required. We will use the pending batch and leave it pending if \"smart batch\" - NewBatchCode is required. Uses NewBatchCode to determine which batch mode path it should follow. BatchMode is then modified so error message may reflect this new BatchMode. --- if newBatchCode already exists in the database and it is a closed batch, create a new batch with a GUID appended to the newBatchCode to make it unique. Any open batch will be left open. BatchMode modified to \"new batch\" and LeaveExistingBatchesOpen set to true. This scenario can occur if BC is in the middle of processing micro batches and a user closes the original batch that was being used by BC. --- if there is a open batch with the newBatchCode and it belongs to the current user, use it. BatchMode modified to \"use existing batch\" --- if there is a open batch with the newBatchCode and it belongs to the another user, use it if the current user has Bills and Batches:Manage.Otherwise, error. BatchMode modified to \"use existing batch\" --- if no open batches, check if there is a pending batch with newBatchCode, if so use it and get bills imported into the pending batch. BatchMode modified to \"use pending batch\" --- if a batch with newBatchCode does not exist, create it and add bills to it, any open batch will be left open. BatchMode modified to \"new batch\" and LeaveExistingBatchesOpen set to true One of 'use existing batch', 'new batch', 'new self-contained batch', 'use pending batch', 'smart batch' */ batchMode: string | null | undefined; /** * optional - Only applies when BatchMode is \"new batch\". When true it will leave any existing batches open */ leaveExistingBatchesOpen: boolean | null | undefined; /** * optional - ID of an existing open batch to use. Only applies when BatchMode is \"use existing batch\". If not provided, the current user must have exactly one open batch, otherwise an error occurs. Must reference an open batch belonging to the current user, or if the user has \"Bills and Batch: Manage\" permission, any user's open batch. */ existingOpenBatchId: number | null | undefined; /** * Pending batchId to import the bills into. Only applies when BatchMode is \"use pending batch\". Required when BatchMode is set to use pending batch */ pendingBatchId: number | null | undefined; /** * required - if batch mode is \"smart batch\" optional for batch modes \"new batch\", \"new self-contained batch\" - if not provided, we will autocreate the batch code. Ignored for all other batch modes Must be between 0 and 255 characters Required when BatchMode is set to smart batch */ newBatchCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportRequest { /** * optional - if not provided, we assume the data is in Advanced format A bill import profile code. Maps given data to Advanced format using the mappings defined by this profile */ profileCode: string | null | undefined; /** * FileName for the import file. Should include extension. Example: fileABC.csv Data contains the contents. The importer will save the under this file name. The extension allows the importer to read the data in the proper format (csv,xlsx,zip) Required */ fileName: string | null; /** * The base64 encoded file. Required */ data: string | null; /** * Optional property to indicate whether or not to suppress the Bill Capture Automation notification that would normally be sent after a successful import. This is used for microbatches to avoid sending a notification for each microbatch that is imported. Instead, the notification will be sent after all microbatches have been imported from the BillCapture process. Assumes false if not provided. */ suppressBillCaptureNotification: boolean | null | undefined; batchSettings: BatchSettings | null | undefined; /** * Optional note/comment. */ importNote: string | null | undefined; /** * Optional property to indicate if failed audits automatically get marked as resolved */ saveAsResolved: boolean | null | undefined; /** * Optional comment to explain why the audit is being auto resolved */ comment: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillImportTaskKickoutSummaryResponse { /** * The identifier for the task that produced the kickouts */ taskGuid: string | null | undefined; /** * The name of the imported file that produced the kickouts */ fileName: string | null | undefined; /** * A list of the kickout messages produced by the uploaded file. */ kickoutMessages: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillKickoutImportRequest { batchSettings: BatchSettings | null | undefined; /** * Optional note/comment. */ importNote: string | null | undefined; /** * Optional property to indicate if failed audits automatically get marked as resolved */ saveAsResolved: boolean | null | undefined; /** * Optional comment to explain why the audit is being auto resolved */ comment: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DetailedGuidResponse { /** * The name of the file that was uploaded */ fileName: string | null | undefined; /** * A guid that identifies the current task */ taskGUId: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ColumnNumberOrOverrideValueNullableInt32 { /** * Column number */ columnNumber: number | null | undefined; /** * The value of the column */ overrideValue: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ColumnNumberOrOverrideValueString { /** * Column number */ columnNumber: number | null | undefined; /** * The value of the column */ overrideValue: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportProfileColumn { /** * The number of the column Must be between 1 and 104 */ columnNumber: number | null | undefined; /** * The observation type code of the reading Required Must be between 0 and 16 characters */ observationTypeCode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Estimated { /** * Column number specifying where to look for the estimated indicator Required Must be between 1 and 2147483647 */ columnNumber: number | null; /** * The string used to indicate the reading is estimated If this value is found in the column number specified the reading will be marked as estimated Example: e, E, 1, 0, est, *, this is my estimated read Required */ indicator: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportProfileCreate { /** * Name of the import profile Max length of 50 Required */ profileInfo: string | null; /** * Description of the import profile Max length of 255 */ profileDescription: string | null | undefined; /** * The time zone for the import profile */ timeZoneId: number | null | undefined; /** * The string that represents how the file contents are delimited Required Must be between 1 and 2 characters */ delimiter: string | null; /** * The string that represents how the decimal values are separated Must be between 1 and 2 characters One of ',', '.' Case sensitive */ decimalSeparator: string | null | undefined; /** * Number of header rows before the data begins (Skip Rows) Required Must be between 0 and 2147483647 */ numberOfHeaderRows: number | null; dataPointImportId: ColumnNumberOrOverrideValueString | null | undefined; channelImportId: ColumnNumberOrOverrideValueString | null | undefined; /** * The format for the Date and Time of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz Only one of DateFormat, DateTimeFormat can be set Only one of TimeFormat, DateTimeFormat can be set */ dateTimeFormat: string | null | undefined; /** * The number of the column that holds the Date and Time Mandatory when Date Time Format column is provided Required when DateTimeFormat is set Must be between 1 and 104 */ dateTimeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy Only one of DateFormat, DateTimeFormat can be set */ dateFormat: string | null | undefined; /** * The number of the column that holds the date Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ dateColumnNumber: number | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz Mandatory when Date Format column is provided Required when DateFormat is set Only one of TimeFormat, DateTimeFormat can be set */ timeFormat: string | null | undefined; /** * The number of the column that holds the time Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ timeColumnNumber: number | null | undefined; estimated: Estimated | null | undefined; interval: ColumnNumberOrOverrideValueNullableInt32 | null | undefined; /** * Column number that holds a note to be stored with the reading Must be between 1 and 104 */ readingNoteColumnNumber: number | null | undefined; /** * Column number that holds reading value to be imported onto the ChannelImportId Must be between 1 and 104 Required when ChannelImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ readingValueColumnNumber: number | null | undefined; /** * A list of columns from the import sheet with their observation type and unit Cannot be Empty NULL Valid Required when DataPointImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ intervalDataTypes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportProfileEdit { /** * Name of the import profile Max length of 50 Required */ profileInfo: string | null; /** * Description of the import profile Max length of 255 Required (defined) */ profileDescription: string | null | undefined; /** * The time zone for the import profile Required (defined) */ timeZoneId: number | null | undefined; /** * The string that represents how the file contents are delimited Required Must be between 1 and 2 characters */ delimiter: string | null; /** * The string that represents how the decimal values are separated Must be between 1 and 2 characters One of ',', '.' Case sensitive Required (defined) */ decimalSeparator: string | null | undefined; /** * Number of header rows before the data begins (Skip Rows) Required Must be between 0 and 2147483647 */ numberOfHeaderRows: number | null; dataPointImportId: ColumnNumberOrOverrideValueString | null | undefined; channelImportId: ColumnNumberOrOverrideValueString | null | undefined; /** * The format for the Date and Time of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz Required (defined) Only one of DateFormat, DateTimeFormat can be set Only one of TimeFormat, DateTimeFormat can be set */ dateTimeFormat: string | null | undefined; /** * The number of the column that holds the Date and Time Mandatory when Date Time Format column is provided Required when DateTimeFormat is set Must be between 1 and 104 */ dateTimeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy Required (defined) Only one of DateFormat, DateTimeFormat can be set */ dateFormat: string | null | undefined; /** * The number of the column that holds the date Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ dateColumnNumber: number | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz Mandatory when Date Format column is provided Required when DateFormat is set Only one of TimeFormat, DateTimeFormat can be set */ timeFormat: string | null | undefined; /** * The number of the column that holds the time Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ timeColumnNumber: number | null | undefined; estimated: Estimated | null | undefined; interval: ColumnNumberOrOverrideValueNullableInt32 | null | undefined; /** * Column number that holds a note to be stored with the reading Must be between 1 and 104 Required (defined) */ readingNoteColumnNumber: number | null | undefined; /** * Column number that holds reading value to be imported onto the ChannelImportId Must be between 1 and 104 Required when ChannelImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ readingValueColumnNumber: number | null | undefined; /** * A list of columns from the import sheet with their observation type and unit Cannot be Empty NULL Valid Required when DataPointImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ intervalDataTypes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportProfileResponse { /** * Identifier of the record import profile */ profileId: number | null | undefined; /** * Name of the import profile */ profileInfo: string | null | undefined; /** * Description of the import profile */ profileDescription: string | null | undefined; timeZone: TimeZoneChild | null | undefined; /** * The string that represents how the file contents are delimited */ delimiter: string | null | undefined; /** * The string that represents how the decimal values are separated */ decimalSeparator: string | null | undefined; /** * Number of header rows before the data begins */ numberOfHeaderRows: number | null | undefined; dataPointImportId: ColumnNumberOrOverrideValueString | null | undefined; channelImportId: ColumnNumberOrOverrideValueString | null | undefined; /** * The format for the Date and Time of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz */ dateTimeFormat: string | null | undefined; /** * The number of the column that holds the Date and Time */ dateTimeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy */ dateFormat: string | null | undefined; /** * The number of the column that holds the date */ dateColumnNumber: number | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz */ timeFormat: string | null | undefined; /** * The number of the column that holds the time */ timeColumnNumber: number | null | undefined; estimated: Estimated | null | undefined; interval: ColumnNumberOrOverrideValueNullableInt32 | null | undefined; /** * Column number that holds a note to be stored with the reading */ readingNoteColumnNumber: number | null | undefined; /** * Column number that holds reading value to be imported onto the ChannelImportId */ readingValueColumnNumber: number | null | undefined; /** * A list of columns from the import sheet with their observation type and unit */ intervalDataTypes: Array | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the import profile was modified */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time the import profile was modified */ modifiedDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportProfile { /** * The time zone for the import profile */ timeZoneId: number | null | undefined; /** * The string that represents how the file contents are delimited Required Must be between 1 and 2 characters */ delimiter: string | null; /** * The string that represents how the decimal values are separated Must be between 1 and 2 characters One of ',', '.' Case sensitive */ decimalSeparator: string | null | undefined; /** * Number of header rows before the data begins (Skip Rows) Required Must be between 0 and 2147483647 */ numberOfHeaderRows: number | null; dataPointImportId: ColumnNumberOrOverrideValueString | null | undefined; channelImportId: ColumnNumberOrOverrideValueString | null | undefined; /** * The format for the Date and Time of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz Only one of DateFormat, DateTimeFormat can be set Only one of TimeFormat, DateTimeFormat can be set */ dateTimeFormat: string | null | undefined; /** * The number of the column that holds the Date and Time Mandatory when Date Time Format column is provided Required when DateTimeFormat is set Must be between 1 and 104 */ dateTimeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy Only one of DateFormat, DateTimeFormat can be set */ dateFormat: string | null | undefined; /** * The number of the column that holds the date Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ dateColumnNumber: number | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz Mandatory when Date Format column is provided Required when DateFormat is set Only one of TimeFormat, DateTimeFormat can be set */ timeFormat: string | null | undefined; /** * The number of the column that holds the time Mandatory when Date Format column is provided Required when DateFormat is set Must be between 1 and 104 */ timeColumnNumber: number | null | undefined; estimated: Estimated | null | undefined; interval: ColumnNumberOrOverrideValueNullableInt32 | null | undefined; /** * Column number that holds a note to be stored with the reading Must be between 1 and 104 */ readingNoteColumnNumber: number | null | undefined; /** * Column number that holds reading value to be imported onto the ChannelImportId Must be between 1 and 104 Required when ChannelImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ readingValueColumnNumber: number | null | undefined; /** * A list of columns from the import sheet with their observation type and unit Cannot be Empty NULL Valid Required when DataPointImportId is set Only one of ReadingValueColumnNumber, IntervalDataTypes can be set */ intervalDataTypes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaReadingImportRequest { /** * Name of the import profile Must be between 0 and 64 characters Only one of ProfileInfo, InlineProfile can be set */ profileInfo: string | null | undefined; inlineProfile: EsaReadingImportProfile | null | undefined; /** * FileName for the import file. Should include extension. The extension allows the importer to read the data in the proper format (csv, xlsx, zip) Required */ fileName: string | null; /** * The base64 encoded file Required */ fileContent: string | null; /** * Optional note/comment. */ importNote: string | null | undefined; /** * The type of notification to send when the import is completed with errors. Default is \"SystemMessages\". Must be a valid value for NotificationTypeEnum: SystemMessages = 1, BillImportAutomation = 2, BillExportToApAutomation = 3, IntervalDataAutomation = 4, UserGroupMessages = 5, UpdatesAndNewFeatures = 6, HelpArticlesTipsAndSuggestions = 7, CustomerServiceMessages = 8, EnergyStarSubmissionFailures = 9, BillExportToGlAutomation = 10, AutomaticallyCreatedMetersOrAccounts = 11, ExceededLicensedObjectCount = 12, BillCaptureAutomation = 13, TrendInsights = 14, ESADataImports = 15 */ completeWithErrorsNotificationType: EsaReadingImportRequest.CompleteWithErrorsNotificationTypeEnum; } declare namespace EsaReadingImportRequest { enum CompleteWithErrorsNotificationTypeEnum { NUMBER_1, NUMBER_2, NUMBER_3, NUMBER_4, NUMBER_5, NUMBER_6, NUMBER_7, NUMBER_8, NUMBER_9, NUMBER_10, NUMBER_11, NUMBER_12, NUMBER_13, NUMBER_14, NUMBER_15 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingImportProfileColumn { /** * The number of the column Must be between 1 and 2147483647 */ columnNumber: number | null | undefined; /** * The observation type code of the reading Required Must be between 0 and 16 characters */ observationTypeCode: string | null; /** * The unit code of the reading Required Must be between 0 and 16 characters */ unitCode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingImportProfileRequest { /** * The profile code Required Must be between 0 and 64 characters */ profileCode: string | null; /** * The interval of the readings in seconds */ channelIntervalInSeconds: number | null | undefined; /** * The string that represents how the file contents are delimited. Valid options are \"\\t\" for tab, \" \" for space and \",\" for comma. Required Must be between 1 and 2 characters One of ' ', ' ', ',' Case sensitive */ delimiter: string | null; /** * Number of header rows before the data begins Required Must be between 0 and 2147483647 */ numberOfHeaderRows: number | null; /** * The number of the column that holds the timestamp Must be between 1 and 2147483647 */ timestampColumnNumber: number | null | undefined; /** * The format for the timestamp of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz */ timestampFormat: string | null | undefined; /** * The number of the column that holds the date Must be between 1 and 2147483647 */ dateColumnNumber: number | null | undefined; /** * The number of the column that holds the time Must be between 1 and 2147483647 */ timeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy */ dateFormat: string | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz */ timeFormat: string | null | undefined; /** * The time zone for the readings */ timeZoneId: number | null | undefined; /** * The number of the column that holds the meter import identifier Must be between 1 and 2147483647 */ meterImportIdColumnNumber: number | null | undefined; /** * The number of the column that holds the channel import identifier Must be between 1 and 2147483647 */ channelImportIdColumnNumber: number | null | undefined; /** * The minimum number of columns in the import sheet Required Must be between 1 and 2147483647 */ numberOfColumns: number | null; /** * A list of columns from the import sheet with their observation type and unit */ dataMapping: Array | null | undefined; estimated: Estimated | null | undefined; /** * Column number that holds a note to be stored with the reading Must be between 1 and 2147483647 */ noteColumnNumber: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingImportProfileResponse { /** * The profile Identifier */ profileId: number | null | undefined; /** * The profile code */ profileCode: string | null | undefined; createdBy: UserChild | null | undefined; /** * The number of the column that holds the Meter import identifier */ meterImportIdColumnNumber: number | null | undefined; /** * The number of the column that holds the Channel import identifier */ channelImportIdColumnNumber: number | null | undefined; /** * The total number of columns in the import sheet */ numberOfColumns: number | null | undefined; /** * The interval of the readings */ channelIntervalInSeconds: number | null | undefined; /** * The string that represents how the file contents are delimited. Valid options are \"\\t\" for tab, \" \" for space and \",\" for comma. */ delimiter: string | null | undefined; /** * Number of header rows before the data begins */ numberOfHeaderRows: number | null | undefined; /** * The number of the column that holds the timestamp */ timestampColumnNumber: number | null | undefined; /** * The format for the timestamp of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz */ timestampFormat: string | null | undefined; /** * The number of the column that holds the date */ dateColumnNumber: number | null | undefined; /** * The number of the column that holds the time */ timeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy */ dateFormat: string | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz */ timeFormat: string | null | undefined; timeZone: TimeZoneChild | null | undefined; /** * A list of columns from the import sheet with their observation type and unit */ dataMapping: Array | null | undefined; estimated: Estimated | null | undefined; /** * Column number that holds a note to be stored with the reading */ noteColumnNumber: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingImportProfile { /** * The interval of the readings in seconds */ channelIntervalInSeconds: number | null | undefined; /** * The string that represents how the file contents are delimited. Valid options are \"\\t\" for tab, \" \" for space and \",\" for comma. Required Must be between 1 and 2 characters One of ' ', ' ', ',' Case sensitive */ delimiter: string | null; /** * Number of header rows before the data begins Required Must be between 0 and 2147483647 */ numberOfHeaderRows: number | null; /** * The number of the column that holds the timestamp Must be between 1 and 2147483647 */ timestampColumnNumber: number | null | undefined; /** * The format for the timestamp of the readings. An example is MM/dd/yyyy mm:hh:ss:zzz */ timestampFormat: string | null | undefined; /** * The number of the column that holds the date Must be between 1 and 2147483647 */ dateColumnNumber: number | null | undefined; /** * The number of the column that holds the time Must be between 1 and 2147483647 */ timeColumnNumber: number | null | undefined; /** * The format for the date of the readings. An example is MM/dd/yyyy */ dateFormat: string | null | undefined; /** * The format for the time of the readings. An example is mm:hh:ss:zzz */ timeFormat: string | null | undefined; /** * The time zone for the readings */ timeZoneId: number | null | undefined; /** * The number of the column that holds the meter import identifier Must be between 1 and 2147483647 */ meterImportIdColumnNumber: number | null | undefined; /** * The number of the column that holds the channel import identifier Must be between 1 and 2147483647 */ channelImportIdColumnNumber: number | null | undefined; /** * The minimum number of columns in the import sheet Required Must be between 1 and 2147483647 */ numberOfColumns: number | null; /** * A list of columns from the import sheet with their observation type and unit */ dataMapping: Array | null | undefined; estimated: Estimated | null | undefined; /** * Column number that holds a note to be stored with the reading Must be between 1 and 2147483647 */ noteColumnNumber: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingImportRequest { /** * A reading import data profile code. */ profileCode: string | null | undefined; inlineProfile: ReadingImportProfile | null | undefined; /** * The base64 encoded file. Required */ data: string | null; /** * Create new channels if they don't exist? */ autoCreateChannels: boolean | null | undefined; /** * Optional note/comment. */ importNote: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordImportProfileEdit { /** * Name of the import profile Required Must be between 0 and 64 characters */ profileCode: string | null; /** * The format for the record start/end dates. It represents the regional convention for the order of day, month, and year. It is not a date format itself. Required One of 'MM/dd/yyyy', 'dd/MM/yyyy', 'yyyy/MM/dd' Case sensitive */ dateFormat: string | null; /** * The number of header rows before the data begins Required Must be between 0 and 9 */ numberOfHeaderRows: number | null; /** * Flag to indicate if new emission sources or suppliers should be created if they do not already exist Required */ createNewEntities: boolean | null; /** * Optional notes field Max length of 255 Required (defined) */ notes: string | null | undefined; /** * The index of the column that holds the emission source code Required Must be between 1 and 104 */ emissionSourceCodeColumnIndex: number | null; /** * The index of the column that holds the emission source name Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceNameColumnIndex: number | null | undefined; /** * The index of the column that holds the emission source type Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceTypeColumnIndex: number | null | undefined; /** * The index of the column that holds the emission record start date Required Must be between 1 and 104 */ startDateColumnIndex: number | null; /** * The index of the column that holds the emission record end date Required Must be between 1 and 104 */ endDateColumnIndex: number | null; /** * The index of the column that holds the supplier name. This field is optional Must be between 1 and 104 Required (defined) */ supplierColumnIndex: number | null | undefined; /** * The index of the column that holds the notes for a record. This field is optional Must be between 1 and 104 Required (defined) */ notesColumnIndex: number | null | undefined; /** * The index of the column that holds the use for a record. Required if no value is set for either the Cost Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ useColumnIndex: number | null | undefined; /** * The identifier for the use unit to use. Required if UseColumnIndex is set Required when UseColumnIndex is set */ useUnitId: number | null | undefined; /** * The index of the column that holds the cost for a record. Required if no value is set for either the Use Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ costColumnIndex: number | null | undefined; /** * The identifier for the cost unit to use. Required if CostColumnIndex is set Required when CostColumnIndex is set */ costUnitId: number | null | undefined; /** * The index of the column that holds direct emissions/emission offsets for a record. Required if no value is set for either the Use Or Cost column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ directOffsetColumnIndex: number | null | undefined; /** * The identifier for the direct emissions/emission offset unit to use. Required if DirectOffsetColumnIndex is set Required when DirectOffsetColumnIndex is set */ directOffsetUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordImportProfileRequest { /** * Name of the import profile Required Must be between 0 and 64 characters */ profileCode: string | null; /** * The format for the record start/end dates. It represents the regional convention for the order of day, month, and year. It is not a date format itself. Required One of 'MM/dd/yyyy', 'dd/MM/yyyy', 'yyyy/MM/dd' Case sensitive */ dateFormat: string | null; /** * The number of header rows before the data begins Required Must be between 0 and 9 */ numberOfHeaderRows: number | null; /** * Flag to indicate if new emission sources or suppliers should be created if they do not already exist Required */ createNewEntities: boolean | null; /** * Optional notes field Max length of 255 */ notes: string | null | undefined; /** * The index of the column that holds the emission source code Required Must be between 1 and 104 */ emissionSourceCodeColumnIndex: number | null; /** * The index of the column that holds the emission source name Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceNameColumnIndex: number | null | undefined; /** * The index of the column that holds the emission source type Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceTypeColumnIndex: number | null | undefined; /** * The index of the column that holds the emission record start date Required Must be between 1 and 104 */ startDateColumnIndex: number | null; /** * The index of the column that holds the emission record end date Required Must be between 1 and 104 */ endDateColumnIndex: number | null; /** * The index of the column that holds the supplier name. This field is optional Must be between 1 and 104 */ supplierColumnIndex: number | null | undefined; /** * The index of the column that holds the notes for a record. This field is optional Must be between 1 and 104 */ notesColumnIndex: number | null | undefined; /** * The index of the column that holds the use for a record. Required if no value is set for either the Cost Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ useColumnIndex: number | null | undefined; /** * The identifier for the use unit to use. Required if UseColumnIndex is set Required when UseColumnIndex is set */ useUnitId: number | null | undefined; /** * The index of the column that holds the cost for a record. Required if no value is set for either the Use Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ costColumnIndex: number | null | undefined; /** * The identifier for the cost unit to use. Required if CostColumnIndex is set Required when CostColumnIndex is set */ costUnitId: number | null | undefined; /** * The index of the column that holds direct emissions/emission offsets for a record. Required if no value is set for either the Use Or Cost column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ directOffsetColumnIndex: number | null | undefined; /** * The identifier for the direct emissions/emission offset unit to use. Required if DirectOffsetColumnIndex is set Required when DirectOffsetColumnIndex is set */ directOffsetUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordImportProfileResponse { /** * Identifier of the record import profile */ profileId: number | null | undefined; /** * Name of the import profile */ profileCode: string | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the import profile was modified */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time the import profile was modified */ modifiedDate: Date | null | undefined; /** * The format for the record start/end dates */ dateFormat: string | null | undefined; /** * The number of header rows before the data begins */ numberOfHeaderRows: number | null | undefined; /** * Flag to indicate if new emission sources or suppliers should be created if they do not already exist */ createNewEntities: boolean | null | undefined; /** * Optional notes field */ notes: string | null | undefined; /** * The index of the column that holds the emission source code */ emissionSourceCodeColumnIndex: number | null | undefined; /** * The index of the column that holds the emission source name */ emissionSourceNameColumnIndex: number | null | undefined; /** * The index of the column that holds the emission source type */ emissionSourceTypeColumnIndex: number | null | undefined; /** * The index of the column that holds the emission record start date */ startDateColumnIndex: number | null | undefined; /** * The index of the column that holds the emission record end date */ endDateColumnIndex: number | null | undefined; /** * The index of the column that holds the supplier name */ supplierColumnIndex: number | null | undefined; /** * The index of the column that holds the notes for a record */ notesColumnIndex: number | null | undefined; /** * The index of the column that holds the use for a record */ useColumnIndex: number | null | undefined; useUnit: UnitChild | null | undefined; /** * The index of the column that holds the cost for a record */ costColumnIndex: number | null | undefined; costUnit: UnitChild | null | undefined; /** * The index of the column that holds direct emissions/emission offsets for a record */ directOffsetColumnIndex: number | null | undefined; directOffsetUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordImportProfile { /** * The format for the record start/end dates. It represents the regional convention for the order of day, month, and year. It is not a date format itself. Required One of 'MM/dd/yyyy', 'dd/MM/yyyy', 'yyyy/MM/dd' Case sensitive */ dateFormat: string | null; /** * The number of header rows before the data begins Required Must be between 0 and 9 */ numberOfHeaderRows: number | null; /** * Flag to indicate if new emission sources or suppliers should be created if they do not already exist Required */ createNewEntities: boolean | null; /** * Optional notes field Max length of 255 */ notes: string | null | undefined; /** * The index of the column that holds the emission source code Required Must be between 1 and 104 */ emissionSourceCodeColumnIndex: number | null; /** * The index of the column that holds the emission source name Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceNameColumnIndex: number | null | undefined; /** * The index of the column that holds the emission source type Must be between 1 and 104 Required when CreateNewEntities is set to True, case sensitive. Must be null when CreateNewEntities is set to False, case sensitive */ emissionSourceTypeColumnIndex: number | null | undefined; /** * The index of the column that holds the emission record start date Required Must be between 1 and 104 */ startDateColumnIndex: number | null; /** * The index of the column that holds the emission record end date Required Must be between 1 and 104 */ endDateColumnIndex: number | null; /** * The index of the column that holds the supplier name. This field is optional Must be between 1 and 104 */ supplierColumnIndex: number | null | undefined; /** * The index of the column that holds the notes for a record. This field is optional Must be between 1 and 104 */ notesColumnIndex: number | null | undefined; /** * The index of the column that holds the use for a record. Required if no value is set for either the Cost Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ useColumnIndex: number | null | undefined; /** * The identifier for the use unit to use. Required if UseColumnIndex is set Required when UseColumnIndex is set */ useUnitId: number | null | undefined; /** * The index of the column that holds the cost for a record. Required if no value is set for either the Use Or Direct/Offset column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ costColumnIndex: number | null | undefined; /** * The identifier for the cost unit to use. Required if CostColumnIndex is set Required when CostColumnIndex is set */ costUnitId: number | null | undefined; /** * The index of the column that holds direct emissions/emission offsets for a record. Required if no value is set for either the Use Or Cost column numbers Must be between 1 and 104 At least one of UseColumnIndex, CostColumnIndex, DirectOffsetColumnIndex must not be null */ directOffsetColumnIndex: number | null | undefined; /** * The identifier for the direct emissions/emission offset unit to use. Required if DirectOffsetColumnIndex is set Required when DirectOffsetColumnIndex is set */ directOffsetUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordImportRequest { /** * Name of the import profile Must be between 0 and 64 characters Only one of ProfileCode, InlineProfile can be set */ profileCode: string | null | undefined; inlineProfile: RecordImportProfile | null | undefined; /** * FileName for the import file. Should include extension. The extension allows the importer to read the data in the proper format (csv, xlsx) Required */ fileName: string | null; /** * The base64 encoded file Required */ fileContent: string | null; /** * Optional note/comment. */ importNote: string | null | undefined; } declare class ImportService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * This endpoint allows the import of an EnergyCAP Advanced or a profile mapped file. The file can be comma separated file (CSV/DAT/TXT) or EXCEL (XLSX) or a collection of files (ZIP). The file should be base64 encoded with a UTF8 character set. * * @param body DTO containing the data to import, filename with extension, optional profileCode to map input file to advanced format, optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ billImport(body?: BillImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA reading import profile * * @param body Object containing settings for the new profile */ createEsaReadingImportProfile(body?: EsaReadingImportProfileCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an interval data import profile * * @param body The details about the profile being created */ createReadingImportProfile(body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emission record import profile * * @param body Object containing settings for the new profile */ createRecordImportProfile(body?: RecordImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a bill import profile * * @param profileId The identifier for the profile being deleted */ deleteBillImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA reading import profile * * @param profileId The identifier of the profile to delete */ deleteEsaReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a reading import profile * * @param profileId The identifier for the profile being deleted */ deleteReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an emission record import profile * * @param profileId The identifier of the profile to delete */ deleteRecordImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a bill import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editBillImportProfile(profileId: number, body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA reading import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings for the profile */ editEsaReadingImportProfile(profileId: number, body?: EsaReadingImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an interval data import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editReadingImportProfile(profileId: number, body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emission record import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings to change */ editRecordImportProfile(profileId: number, body?: RecordImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the kickout details associated with a specified bill import task and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetails(taskGuid: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the kickout details associated with a specified bill import task, file and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsByFile(taskGuid: string, filename: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a bill import profile * * @param profileId The identifier for the profile to get */ getBillImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all bill import profiles * */ getBillImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets an ESA reading import profile * * @param profileId */ getEsaReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all ESA reading import profiles * */ getEsaReadingImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns one reading import profile * * @param profileId */ getReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns all Reading Import profiles * */ getReadingImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an emission record import profile * * @param profileId The identifier of the profile to get */ getRecordImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all emission record import profiles * */ getRecordImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of kickout messages associated with a specified bill import task * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. */ getTaskKickoutSummary(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of kickout messages associated with a specified bill import task and file. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. */ getTaskKickoutSummaryByFile(taskGuid: string, filename: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the reimport of an EnergyCAP. All kickout files generated from the import will be zipped and reimported as a single task. * * @param taskGuid The taskGuid should be a bill import task with a status of completed with kickouts. * @param body DTO containing optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ importBillImportTaskKickouts(taskGuid: string, body?: BillKickoutImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the import of a emission records import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEmissionRecordsWithProfile(body?: RecordImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the import of an ESA reading import file. The file should be a base64-encoded file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEsaReadingWithProfile(body?: EsaReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of a channel reading (\"interval\") data import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to export and the profile that defines the structure. */ readingImport(body?: ReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a bill import profile * * @param body The details about the profile being created */ writeBillImportProfile(body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the import of an EnergyCAP Advanced or a profile mapped file. The file can be comma separated file (CSV/DAT/TXT) or EXCEL (XLSX) or a collection of files (ZIP). The file should be base64 encoded with a UTF8 character set. * * @param body DTO containing the data to import, filename with extension, optional profileCode to map input file to advanced format, optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ billImportWithHttpInfo(body?: BillImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA reading import profile * * @param body Object containing settings for the new profile */ createEsaReadingImportProfileWithHttpInfo(body?: EsaReadingImportProfileCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an interval data import profile * * @param body The details about the profile being created */ createReadingImportProfileWithHttpInfo(body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an emission record import profile * * @param body Object containing settings for the new profile */ createRecordImportProfileWithHttpInfo(body?: RecordImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a bill import profile * * @param profileId The identifier for the profile being deleted */ deleteBillImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an ESA reading import profile * * @param profileId The identifier of the profile to delete */ deleteEsaReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a reading import profile * * @param profileId The identifier for the profile being deleted */ deleteReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an emission record import profile * * @param profileId The identifier of the profile to delete */ deleteRecordImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a bill import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editBillImportProfileWithHttpInfo(profileId: number, body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA reading import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings for the profile */ editEsaReadingImportProfileWithHttpInfo(profileId: number, body?: EsaReadingImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an interval data import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editReadingImportProfileWithHttpInfo(profileId: number, body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an emission record import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings to change */ editRecordImportProfileWithHttpInfo(profileId: number, body?: RecordImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the kickout details associated with a specified bill import task and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsWithHttpInfo(taskGuid: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the kickout details associated with a specified bill import task, file and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsByFileWithHttpInfo(taskGuid: string, filename: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a bill import profile * * @param profileId The identifier for the profile to get */ getBillImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all bill import profiles * */ getBillImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets an ESA reading import profile * * @param profileId */ getEsaReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all ESA reading import profiles * */ getEsaReadingImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns one reading import profile * * @param profileId */ getReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns all Reading Import profiles * */ getReadingImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get an emission record import profile * * @param profileId The identifier of the profile to get */ getRecordImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all emission record import profiles * */ getRecordImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of kickout messages associated with a specified bill import task * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. */ getTaskKickoutSummaryWithHttpInfo(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of kickout messages associated with a specified bill import task and file. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. */ getTaskKickoutSummaryByFileWithHttpInfo(taskGuid: string, filename: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the reimport of an EnergyCAP. All kickout files generated from the import will be zipped and reimported as a single task. * * @param taskGuid The taskGuid should be a bill import task with a status of completed with kickouts. * @param body DTO containing optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ importBillImportTaskKickoutsWithHttpInfo(taskGuid: string, body?: BillKickoutImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of a emission records import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEmissionRecordsWithProfileWithHttpInfo(body?: RecordImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of an ESA reading import file. The file should be a base64-encoded file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEsaReadingWithProfileWithHttpInfo(body?: EsaReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * This endpoint allows the import of a channel reading (\"interval\") data import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to export and the profile that defines the structure. */ readingImportWithHttpInfo(body?: ReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a bill import profile * * @param body The details about the profile being created */ writeBillImportProfileWithHttpInfo(body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillActionMoveList { /** * Destination Account Id Required (defined) */ accountId: number | null | undefined; /** * Destination AccountMeter Ids Required (defined) */ accountMeterIds: Array | null | undefined; /** * Use Account General Ledger from destination account? Required (defined) */ updateAccountGLs: boolean | null | undefined; /** * Use Meter General Ledger from destination meter? Required (defined) */ updateMeterGLs: boolean | null | undefined; /** * If both the source and destination meter is linked to an emissions source and there are records generated from the bills being moved, update the scope category and GHG factor on those records to the destination meter defaults? Defaults to true for GHG Lite users, otherwise false. Required (defined) */ updateRecordScopeAndFactor: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillExportOptions { /** * The export mode to use. Valid values are 'AP', 'GL', 'Payment' Required One of 'ap', 'gl', 'payment' */ exportMode: string | null; /** * Flag to mark bills as exported after the export is complete. Required */ markAsExported: boolean | null; /** * Optional filename to use for the export file. Filenames may only contain alphanumeric characters, dashes, underscores, or periods. Required (defined) */ fileName: string | null | undefined; /** * Optional note/comment. Required (defined) */ exportNote: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillUnexportOptions { /** * Required One of 'ap', 'gl', 'payment' */ exportMode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackProcessorSettingsForSplits { /** * Optional note/comment */ note: string | null | undefined; batchSettings: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DynamicListRequest { /** * Filters to apply to the dynamic list when initializing it Cannot be Empty */ filters: Array | null | undefined; /** * Flag indicating whether or not to initialize the dynamic list column definitions */ resetColumns: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionAccrualExclusion { /** * Whether or not the bill ids should be excluded from accruals, or included again Required */ exclude: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionApprove { /** * Required (defined) */ approve: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionCustom { /** * The webhook identifier that represents the custom bill action Required */ webhookId: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionExportHold { /** * Required (defined) */ exportHold: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionReverse { batchSettings: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListActionVoid { /** * Required (defined) */ void: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListColumnEdit { /** * Column/Filter Identifier Required */ fieldId: number | null; /** * Width of the column Required */ width: number | null; /** * Order of the column Required */ displayOrder: number | null; /** * Sort order for the column Required */ sortOrder: number | null; /** * Sort direction Required One of 'asc', 'desc' Case sensitive */ sortDirection: string | null; /** * Is the column visible? Required */ visible: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListCopy { /** * The list name Required Must be between 0 and 50 characters */ listInfo: string | null; /** * The list description Must be between 0 and 255 characters */ listDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListCreate { /** * The list type (List) id Required */ listTypeId: number | null; /** * The list name Required Must be between 0 and 50 characters */ listInfo: string | null; /** * The list description Must be between 0 and 255 characters */ listDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListTypeChild { /** * */ listTypeId: number | null | undefined; /** * */ listTypeInfo: string | null | undefined; /** * */ listTypeDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListCreateResponse { /** * The list identifier. */ listId: number | null | undefined; /** * The list name. */ listInfo: string | null | undefined; /** * The list description. */ listDescription: string | null | undefined; listType: ListTypeChild | null | undefined; user: UserChild | null | undefined; /** * Is this a list shared with anyone? */ sharedList: boolean | null | undefined; /** * Is this list visible to me? */ visible: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListEdit { /** * The list name Required Must be between 0 and 50 characters */ listInfo: string | null; /** * The list description Must be between 0 and 255 characters Required (defined) */ listDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListResponseListField { /** * Column/Filter Identifier */ fieldId: number | null | undefined; /** * Width of the column */ width: number | null | undefined; /** * Order of the column */ displayOrder: number | null | undefined; /** * Is the column sortable? */ sortable: boolean | null | undefined; /** * Caption for the column/filter */ caption: string | null | undefined; /** * Sort direction \"asc\" or \"desc\" */ sortDirection: string | null | undefined; /** * Sort order for the column */ sortOrder: number | null | undefined; /** * Type of Data in this column */ dataTypeCode: string | null | undefined; /** * Is this column a required column? */ requiredOutput: boolean | null | undefined; /** * Is this column currently visible? */ visible: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListResponseListItem { fieldId: number | null | undefined; name: string | null | undefined; value: any | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ListResponse { /** * Specific List Identifier */ listId: number | null | undefined; /** * Data for the bill list */ data: Array> | null | undefined; /** * Definition of the bill list - available filters and columns */ field: Array | null | undefined; /** * Meta data about the list Can contain: TotalCount - Total number of items that match the filter TotalCost - Total Cost of all the items that match the filter costUnitInfo - The currency unit ErrorMessage - Indicates data fetch error. */ meta: { [key: string]: any; } | null | undefined; } declare class ListService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Approve/unapprove account bills * * @param accountId The account to approve/unapprove all bills * @param body Boolean representing approve flag */ accountBillListApprove(accountId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action on an account bill list. Custom bill actions are setup as webhooks. * * @param accountId The account against which all of its bills will have the custom action performed * @param body */ accountBillListCustomAction(accountId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills for account * * @param accountId The account to delete all bills from */ accountBillListDeleteBills(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param accountId The account to export bills */ accountBillListExcelExport(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all account bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param accountId The account to export all bills * @param body Bill Export Options */ accountBillListExport(accountId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release account bills for export * * @param accountId The account to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ accountBillListExportHold(accountId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport account bills * * @param accountId The account for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ accountBillListUnexport(accountId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid account bills * * @param accountId The account to void/unvoid all bills * @param body Boolean representing void flag */ accountBillListVoid(accountId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generate a bill import file from all bills in an account bill list. * * @param accountId The account from which to get all bills */ accountExportHistoricalBillList(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountList(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove bill list * * @param listId The list identifier * @param body Boolean representing approve flag */ approveBillList(listId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action on a bill list * * @param listId The bill list against which all of its bills will have the custom action performed * @param body */ billListCustomAction(listId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordList(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param collectionId The collection to export records */ collectionRecordListExcelExport(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new list as a copy of an existing list * * @param listId The list identifier of the existing list * @param body The list create properties */ createAndCopyList(listId: number, body?: ListCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new list with default list settings * * @param body The list create properties */ createDefaultList(body?: ListCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills in a bill list * * @param listId The list identifier */ deleteBillsInBillList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a list. For a list to be deleted you must have created the list or have Manage permission and the list is shared with anyone. * * @param listId The id of the list to delete */ deleteList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the provided list which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param listId ID for the list containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInList(listId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a list * * @param listId The list identifier of the existing list * @param body The list edit properties */ editList(listId: number, body?: ListEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the column definition for the list. For list columns to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier * @param body */ editListColumns(listId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Set list filters If a filter exists in the database, but is not passed in it will be deleted. For list filters to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier * @param body List of filters being set */ editListFilters(listId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the shared users and user groups for a list. To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to []. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission * * @param listId The list identifier * @param body Users and user groups to share the list with */ editListShare(listId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the visibility of a list for the current user. You must have created the list or have access to it. * * @param listId The shared list identifier * @param body Set shared list visibility */ editListShareVisibility(listId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordList(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param emissionSourceId The emissionSource to export records */ emissionSourceRecordListExcelExport(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all bills in a list to ap or gl Maximum of 10000 bills can be processed at one time. * * @param listId The list identifier * @param body Bill Export Options */ exportBillList(listId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generate a bill import file from bills in a list. * * @param listId The id of the list to get bills from */ exportHistoricalBillList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release bill list for export * * @param listId The list identifier * @param body Boolean representing exportHold flag */ exportHoldBillList(listId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create and/or update flags for all bills in a list * * @param listId Bill list containing a list of bills that will have flags created or updated * @param body DTO containing the new state of the flags on each bill in the list */ flagBillListAction(listId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update flag issuess for all issues in a list * * @param listId Flag Issue list containing a list of flag issues to be updated * @param body DTO containing the new state of the flag Issue on each flag issue in the list */ flagIssueBillListAction(listId: number, body?: FlagIssueEditAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the definition and data for a list type * * @param listTypeId The list type for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body DTO containing the list of initial filters to apply and a flag indicating whether to reset the current columns. Only one list of the specified list type exists, so columns and filters are shared for every dynamic list of the list type. Filters provided will be saved to the database. */ getDynamicListWithData(listTypeId: number, pageSize?: number, pageNumber?: number, body?: DynamicListRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the filters for a list * * @param listId The list for which the filters are to be retrieved */ getListFilters(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the shared users and user groups for a list. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission * * @param listId The list identifier */ getListShare(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the definition and data for a list. For a list to be returned you must have created the list or have access to it. * * @param listId The list for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getListWithData(listId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get lists. For a list to be returned you must have created the list or have access to it. * * @param listTypeId Type of list */ getLists(listTypeId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of Accounts that contain meters of ALL of the commodities represented by the given Account's Bill List * * @param accountId A specific Account that should be used for finding matching Accounts (uses all Bills on the Account Bill List). */ getPossibleDestinationAccountsForAccountList(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bill List * * @param listId A specific Bill List that should be used for finding matching Accounts. */ getPossibleDestinationAccountsForList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param listId The list identifier */ listExport(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillList(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove meter bills * * @param meterId The meter to approve/unapprove all bills * @param body Boolean representing approve flag */ meterBillListApprove(meterId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action on a meter bill list. Custom bill actions are setup as webhooks * * @param meterId The meter against which all of its bills will have the custom action performed * @param body */ meterBillListCustomAction(meterId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills for meter * * @param meterId The meter to delete all bills from */ meterBillListDeleteBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param meterId The meter to export bills from */ meterBillListExcelExport(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all meter bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param meterId The meter to export all bills * @param body Bill Export Options */ meterBillListExport(meterId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release meter bills for export * * @param meterId The meter to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ meterBillListExportHold(meterId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport meter bills * * @param meterId The meter for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ meterBillListUnexport(meterId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid meter bills * * @param meterId The meter to void/unvoid all bills * @param body Boolean representing void flag */ meterBillListVoid(meterId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generate a bill import file from all bills in a meter bill list. * * @param meterId The meter from which to get all bills */ meterExportHistoricalBillList(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the bills from the given Account's Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"accountId\"> Account for the Bill List containing a list of bills that should be moved. All bills from this Account's Bill List will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param accountId * @param body */ moveBillsToAccountFromAccountList(accountId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the bills from the given Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"listId\"> Bill List containing a list of bills that should be moved. All bills from this list will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param listId * @param body */ moveBillsToAccountFromList(listId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reset a list to its default columns and filters. For a list to be reset you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier */ resetList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on an account bill list * * @param accountId The account that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseAccountBillList(accountId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on a bill list * * @param listId The bill list that all bills will be reversed on * @param body Batch settings for the reversed bill. If not provided, bills will be placed in the currently open batch. */ reverseBillList(listId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on a meter bill list * * @param meterId The meter that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseMeterBillList(meterId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param accountId The account whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setAccountBillListAccrualExclusion(accountId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param listId The list whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the provided list should be excluded from accruals or should have exclusion undone */ setBillListAccrualExclusion(listId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param meterId The meter whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setMeterBillListAccrualExclusion(meterId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Split all bills eligible to be split in a bill list * * @param listId The list identifier * @param body Optional note and batch settings can be provided. Batch Settings will allow custom batchcode and bill headers for the destination bills */ splitBillList(listId: number, body?: ChargebackProcessorSettingsForSplits, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport bill list * * @param listId The list identifier * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ unexportBillList(listId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates bill headers for the bills for an account's bill list Audits won't be fired * * @param accountId The account whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateAccountBillListHeaders(accountId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update all headers for a bill list If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bills audits won't be fired * * @param listId The list identifier * @param body Bill list header update action */ updateBillListHeaders(listId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates bill headers for all bills on a meter bill list Audits won't be fired * * @param meterId The meter whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateMeterBillListHeaders(meterId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid bill list * * @param listId The list identifier * @param body Boolean representing void flag */ voidBillList(listId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove account bills * * @param accountId The account to approve/unapprove all bills * @param body Boolean representing approve flag */ accountBillListApproveWithHttpInfo(accountId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action on an account bill list. Custom bill actions are setup as webhooks. * * @param accountId The account against which all of its bills will have the custom action performed * @param body */ accountBillListCustomActionWithHttpInfo(accountId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills for account * * @param accountId The account to delete all bills from */ accountBillListDeleteBillsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param accountId The account to export bills */ accountBillListExcelExportWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export all account bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param accountId The account to export all bills * @param body Bill Export Options */ accountBillListExportWithHttpInfo(accountId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Hold/release account bills for export * * @param accountId The account to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ accountBillListExportHoldWithHttpInfo(accountId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport account bills * * @param accountId The account for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ accountBillListUnexportWithHttpInfo(accountId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid account bills * * @param accountId The account to void/unvoid all bills * @param body Boolean representing void flag */ accountBillListVoidWithHttpInfo(accountId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from all bills in an account bill list. * * @param accountId The account from which to get all bills */ accountExportHistoricalBillListWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountListWithHttpInfo(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Approve/unapprove bill list * * @param listId The list identifier * @param body Boolean representing approve flag */ approveBillListWithHttpInfo(listId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action on a bill list * * @param listId The bill list against which all of its bills will have the custom action performed * @param body */ billListCustomActionWithHttpInfo(listId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordListWithHttpInfo(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param collectionId The collection to export records */ collectionRecordListExcelExportWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new list as a copy of an existing list * * @param listId The list identifier of the existing list * @param body The list create properties */ createAndCopyListWithHttpInfo(listId: number, body?: ListCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new list with default list settings * * @param body The list create properties */ createDefaultListWithHttpInfo(body?: ListCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills in a bill list * * @param listId The list identifier */ deleteBillsInBillListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a list. For a list to be deleted you must have created the list or have Manage permission and the list is shared with anyone. * * @param listId The id of the list to delete */ deleteListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the provided list which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param listId ID for the list containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInListWithHttpInfo(listId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a list * * @param listId The list identifier of the existing list * @param body The list edit properties */ editListWithHttpInfo(listId: number, body?: ListEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the column definition for the list. For list columns to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier * @param body */ editListColumnsWithHttpInfo(listId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Set list filters If a filter exists in the database, but is not passed in it will be deleted. For list filters to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier * @param body List of filters being set */ editListFiltersWithHttpInfo(listId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update the shared users and user groups for a list. To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to []. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission * * @param listId The list identifier * @param body Users and user groups to share the list with */ editListShareWithHttpInfo(listId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the visibility of a list for the current user. You must have created the list or have access to it. * * @param listId The shared list identifier * @param body Set shared list visibility */ editListShareVisibilityWithHttpInfo(listId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordListWithHttpInfo(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param emissionSourceId The emissionSource to export records */ emissionSourceRecordListExcelExportWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export all bills in a list to ap or gl Maximum of 10000 bills can be processed at one time. * * @param listId The list identifier * @param body Bill Export Options */ exportBillListWithHttpInfo(listId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from bills in a list. * * @param listId The id of the list to get bills from */ exportHistoricalBillListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Hold/release bill list for export * * @param listId The list identifier * @param body Boolean representing exportHold flag */ exportHoldBillListWithHttpInfo(listId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create and/or update flags for all bills in a list * * @param listId Bill list containing a list of bills that will have flags created or updated * @param body DTO containing the new state of the flags on each bill in the list */ flagBillListActionWithHttpInfo(listId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update flag issuess for all issues in a list * * @param listId Flag Issue list containing a list of flag issues to be updated * @param body DTO containing the new state of the flag Issue on each flag issue in the list */ flagIssueBillListActionWithHttpInfo(listId: number, body?: FlagIssueEditAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the definition and data for a list type * * @param listTypeId The list type for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body DTO containing the list of initial filters to apply and a flag indicating whether to reset the current columns. Only one list of the specified list type exists, so columns and filters are shared for every dynamic list of the list type. Filters provided will be saved to the database. */ getDynamicListWithDataWithHttpInfo(listTypeId: number, pageSize?: number, pageNumber?: number, body?: DynamicListRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the filters for a list * * @param listId The list for which the filters are to be retrieved */ getListFiltersWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the shared users and user groups for a list. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission * * @param listId The list identifier */ getListShareWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the definition and data for a list. For a list to be returned you must have created the list or have access to it. * * @param listId The list for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getListWithDataWithHttpInfo(listId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get lists. For a list to be returned you must have created the list or have access to it. * * @param listTypeId Type of list */ getListsWithHttpInfo(listTypeId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of Accounts that contain meters of ALL of the commodities represented by the given Account's Bill List * * @param accountId A specific Account that should be used for finding matching Accounts (uses all Bills on the Account Bill List). */ getPossibleDestinationAccountsForAccountListWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bill List * * @param listId A specific Bill List that should be used for finding matching Accounts. */ getPossibleDestinationAccountsForListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param listId The list identifier */ listExportWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillListWithHttpInfo(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Approve/unapprove meter bills * * @param meterId The meter to approve/unapprove all bills * @param body Boolean representing approve flag */ meterBillListApproveWithHttpInfo(meterId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action on a meter bill list. Custom bill actions are setup as webhooks * * @param meterId The meter against which all of its bills will have the custom action performed * @param body */ meterBillListCustomActionWithHttpInfo(meterId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills for meter * * @param meterId The meter to delete all bills from */ meterBillListDeleteBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param meterId The meter to export bills from */ meterBillListExcelExportWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export all meter bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param meterId The meter to export all bills * @param body Bill Export Options */ meterBillListExportWithHttpInfo(meterId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Hold/release meter bills for export * * @param meterId The meter to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ meterBillListExportHoldWithHttpInfo(meterId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport meter bills * * @param meterId The meter for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ meterBillListUnexportWithHttpInfo(meterId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid meter bills * * @param meterId The meter to void/unvoid all bills * @param body Boolean representing void flag */ meterBillListVoidWithHttpInfo(meterId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from all bills in a meter bill list. * * @param meterId The meter from which to get all bills */ meterExportHistoricalBillListWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the bills from the given Account's Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"accountId\"> Account for the Bill List containing a list of bills that should be moved. All bills from this Account's Bill List will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param accountId * @param body */ moveBillsToAccountFromAccountListWithHttpInfo(accountId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the bills from the given Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"listId\"> Bill List containing a list of bills that should be moved. All bills from this list will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param listId * @param body */ moveBillsToAccountFromListWithHttpInfo(listId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reset a list to its default columns and filters. For a list to be reset you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you. * * @param listId The list identifier */ resetListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on an account bill list * * @param accountId The account that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseAccountBillListWithHttpInfo(accountId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on a bill list * * @param listId The bill list that all bills will be reversed on * @param body Batch settings for the reversed bill. If not provided, bills will be placed in the currently open batch. */ reverseBillListWithHttpInfo(listId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on a meter bill list * * @param meterId The meter that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseMeterBillListWithHttpInfo(meterId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param accountId The account whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setAccountBillListAccrualExclusionWithHttpInfo(accountId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param listId The list whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the provided list should be excluded from accruals or should have exclusion undone */ setBillListAccrualExclusionWithHttpInfo(listId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param meterId The meter whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setMeterBillListAccrualExclusionWithHttpInfo(meterId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Split all bills eligible to be split in a bill list * * @param listId The list identifier * @param body Optional note and batch settings can be provided. Batch Settings will allow custom batchcode and bill headers for the destination bills */ splitBillListWithHttpInfo(listId: number, body?: ChargebackProcessorSettingsForSplits, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport bill list * * @param listId The list identifier * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ unexportBillListWithHttpInfo(listId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates bill headers for the bills for an account's bill list Audits won't be fired * * @param accountId The account whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateAccountBillListHeadersWithHttpInfo(accountId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update all headers for a bill list If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bills audits won't be fired * * @param listId The list identifier * @param body Bill list header update action */ updateBillListHeadersWithHttpInfo(listId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates bill headers for all bills on a meter bill list Audits won't be fired * * @param meterId The meter whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateMeterBillListHeadersWithHttpInfo(meterId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid bill list * * @param listId The list identifier * @param body Boolean representing void flag */ voidBillListWithHttpInfo(listId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Claim { /** * Type of claim */ claimType: string | null | undefined; /** * Claim value */ value: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyCapOptionsEnergyCapIDOptions { /** * */ baseUrl: string | null | undefined; /** * */ gatewayApiPath: string | null | undefined; /** * */ gatewayApplicationUrlApiPath: string | null | undefined; /** * */ loginAuthorityMap: { [key: string]: string; } | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarSettings { /** * Indicates to always configure ENERGY STAR on a per commodity basis */ submitByCommodityOnly: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGSettings { /** * The GHG Global Warming Assessment Report (AR) identifier */ globalWarmingAssessmentReportId: number | null | undefined; /** * The GHG Global Warming Assessment Report (AR) name */ globalWarmingAssessmentReportInfo: string | null | undefined; reportingUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PermissionProduct { /** * */ productId: number | null | undefined; /** * */ productCode: string | null | undefined; /** * */ productInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountingSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Accounts { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountsModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountsModuleActualData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccrualSettings { /** * */ view: boolean | null | undefined; /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AllInstalledReports { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApplicationSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApproveBills { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineEngine { /** * */ run: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillCAPture { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillListAdministrator { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillWorkflowSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillsAndBatches { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillsModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetsAndBudgetVersions { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingAndMeterGroups { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleActualData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleBudgets { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleCalendarizedData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleMeterIntervalData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleNormalizedData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleSavings { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleSustainability { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndOrganizations { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackReversals { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Chargebacks { /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebacksModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Collections { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCenters { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardAdministrator { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardAndMapsModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributedReportsSettings { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ENERGYSTARSubmissions { /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionsSources { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionsSourcesModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyManagerModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportBills { /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ run: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportHold { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FacilityProjects { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlaggedItems { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GlobalCostAvoidanceSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GreenhouseGasAdministrator { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupsAndBenchmarksModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalData { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalDataAnalysis { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalDataRollup { /** * */ run: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureAccountingExport { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureAccrualBills { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureBillCAPtureManagedServices { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureBillCapturePostPay { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureBillCapturePrePay { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureBudgets { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureCarbonHub { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureChargebacks { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureCostAvoidance { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureCustomBenchmarks { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureEnergyCAPPayments { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureGhg { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureGhgPremium { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureIntervalData { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureIntervalDataAnalysis { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureLegacyGHG { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureNonEnglishBills { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureReportDesigner { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureReportDistribution { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureUIDI { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class LicenseFeatureVendorManagementServices { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ManuallyAdjustSavings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterSavingsSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Meters { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MoveAccountsBetweenVendors { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MoveExistingBills { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NormalizationSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PublicDashboardsOrMaps { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateSchedules { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Records { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordsListAdministrator { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordsModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportAdministrator { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportGroups { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Reports { /** * */ run: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportsModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ResetUserPasswords { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Roles { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsAdjustments { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsEngine { /** * */ run: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SendNotifications { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedBillLists { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedDashboardsOrMaps { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedRecordsLists { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedReports { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UnitSystemSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateApprovedBills { /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateUnitsOnExistingBills { /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UsersAndRoles { /** * */ permissionName: string | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ licenseIndex: Array | null | undefined; /** * */ products: Array | null | undefined; /** * */ permissionId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UsersAndUserGroups { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Vendors { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorsAndRatesModule { /** * */ view: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherSettings { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; /** * */ permissionId: number | null | undefined; /** * */ permissionCode: string | null | undefined; /** * */ permissionName: string | null | undefined; /** * */ description: string | null | undefined; /** * */ permissionCategoryName: string | null | undefined; /** * */ isLicensed: boolean | null | undefined; /** * */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Permissions { licenseFeatureAccountingExport: LicenseFeatureAccountingExport | null | undefined; licenseFeatureAccrualBills: LicenseFeatureAccrualBills | null | undefined; licenseFeatureChargebacks: LicenseFeatureChargebacks | null | undefined; licenseFeatureCostAvoidance: LicenseFeatureCostAvoidance | null | undefined; licenseFeatureIntervalDataAnalysis: LicenseFeatureIntervalDataAnalysis | null | undefined; licenseFeatureReportDesigner: LicenseFeatureReportDesigner | null | undefined; licenseFeatureCustomBenchmarks: LicenseFeatureCustomBenchmarks | null | undefined; licenseFeatureReportDistribution: LicenseFeatureReportDistribution | null | undefined; licenseFeatureGhg: LicenseFeatureGhg | null | undefined; licenseFeatureGhgPremium: LicenseFeatureGhgPremium | null | undefined; licenseFeatureLegacyGHG: LicenseFeatureLegacyGHG | null | undefined; licenseFeatureBudgets: LicenseFeatureBudgets | null | undefined; licenseFeatureEnergyCAPPayments: LicenseFeatureEnergyCAPPayments | null | undefined; licenseFeatureBillCAPtureManagedServices: LicenseFeatureBillCAPtureManagedServices | null | undefined; licenseFeatureCarbonHub: LicenseFeatureCarbonHub | null | undefined; licenseFeatureIntervalData: LicenseFeatureIntervalData | null | undefined; licenseFeatureBillCapturePrePay: LicenseFeatureBillCapturePrePay | null | undefined; licenseFeatureBillCapturePostPay: LicenseFeatureBillCapturePostPay | null | undefined; licenseFeatureNonEnglishBills: LicenseFeatureNonEnglishBills | null | undefined; licenseFeatureVendorManagementServices: LicenseFeatureVendorManagementServices | null | undefined; licenseFeatureUIdI: LicenseFeatureUIDI | null | undefined; accountingSettings: AccountingSettings | null | undefined; accounts: Accounts | null | undefined; accountsModule: AccountsModule | null | undefined; accrualSettings: AccrualSettings | null | undefined; costCenters: CostCenters | null | undefined; moveAccountsBetweenVendors: MoveAccountsBetweenVendors | null | undefined; applicationSettings: ApplicationSettings | null | undefined; approveBills: ApproveBills | null | undefined; billWorkflowSettings: BillWorkflowSettings | null | undefined; billsAndBatches: BillsAndBatches | null | undefined; exportBills: ExportBills | null | undefined; exportHold: ExportHold | null | undefined; moveExistingBills: MoveExistingBills | null | undefined; sharedBillLists: SharedBillLists | null | undefined; unitSystemSettings: UnitSystemSettings | null | undefined; updateApprovedBills: UpdateApprovedBills | null | undefined; updateUnitsOnExistingBills: UpdateUnitsOnExistingBills | null | undefined; budgetsAndBudgetVersions: BudgetsAndBudgetVersions | null | undefined; chargebacksModule: ChargebacksModule | null | undefined; chargebacks: Chargebacks | null | undefined; chargebackReversals: ChargebackReversals | null | undefined; meterSavingsSettings: MeterSavingsSettings | null | undefined; savingsAdjustments: SavingsAdjustments | null | undefined; manuallyAdjustSavings: ManuallyAdjustSavings | null | undefined; savingsEngine: SavingsEngine | null | undefined; baselineEngine: BaselineEngine | null | undefined; globalCostAvoidanceSettings: GlobalCostAvoidanceSettings | null | undefined; dashboardAndMapsModule: DashboardAndMapsModule | null | undefined; dashboardAdministrator: DashboardAdministrator | null | undefined; publicDashboardsOrMaps: PublicDashboardsOrMaps | null | undefined; sharedDashboardsOrMaps: SharedDashboardsOrMaps | null | undefined; buildingsAndMetersModule: BuildingsAndMetersModule | null | undefined; groupsAndBenchmarksModule: GroupsAndBenchmarksModule | null | undefined; buildingAndMeterGroups: BuildingAndMeterGroups | null | undefined; buildingsAndOrganizations: BuildingsAndOrganizations | null | undefined; intervalData: IntervalData | null | undefined; intervalDataAnalysis: IntervalDataAnalysis | null | undefined; energystarSubmissions: ENERGYSTARSubmissions | null | undefined; facilityProjects: FacilityProjects | null | undefined; greenhouseGasAdministrator: GreenhouseGasAdministrator | null | undefined; intervalDataRollup: IntervalDataRollup | null | undefined; meters: Meters | null | undefined; normalizationSettings: NormalizationSettings | null | undefined; weatherSettings: WeatherSettings | null | undefined; reportsModule: ReportsModule | null | undefined; distributedReportsSettings: DistributedReportsSettings | null | undefined; reportAdministrator: ReportAdministrator | null | undefined; reportGroups: ReportGroups | null | undefined; sharedReports: SharedReports | null | undefined; reports: Reports | null | undefined; resetUserPasswords: ResetUserPasswords | null | undefined; usersAndUserGroups: UsersAndUserGroups | null | undefined; vendorsAndRatesModule: VendorsAndRatesModule | null | undefined; rateSchedules: RateSchedules | null | undefined; vendors: Vendors | null | undefined; flaggedItems: FlaggedItems | null | undefined; billListAdministrator: BillListAdministrator | null | undefined; allInstalledReports: AllInstalledReports | null | undefined; sendNotifications: SendNotifications | null | undefined; buildingsAndMetersModuleActualData: BuildingsAndMetersModuleActualData | null | undefined; buildingsAndMetersModuleCalendarizedData: BuildingsAndMetersModuleCalendarizedData | null | undefined; buildingsAndMetersModuleNormalizedData: BuildingsAndMetersModuleNormalizedData | null | undefined; buildingsAndMetersModuleSavings: BuildingsAndMetersModuleSavings | null | undefined; buildingsAndMetersModuleMeterIntervalData: BuildingsAndMetersModuleMeterIntervalData | null | undefined; buildingsAndMetersModuleSustainability: BuildingsAndMetersModuleSustainability | null | undefined; buildingsAndMetersModuleBudgets: BuildingsAndMetersModuleBudgets | null | undefined; accountsModuleActualData: AccountsModuleActualData | null | undefined; billsModule: BillsModule | null | undefined; roles: Roles | null | undefined; usersAndRoles: UsersAndRoles | null | undefined; emissionsSourcesModule: EmissionsSourcesModule | null | undefined; collections: Collections | null | undefined; emissionsSources: EmissionsSources | null | undefined; recordsModule: RecordsModule | null | undefined; records: Records | null | undefined; sharedRecordsLists: SharedRecordsLists | null | undefined; recordsListAdministrator: RecordsListAdministrator | null | undefined; billCAPture: BillCAPture | null | undefined; energyManagerModule: EnergyManagerModule | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Display settings for the user when viewing benchmark charts */ declare class GroupDisplaySetting { /** * Date period type Possible value include 1 (Last Twelve Months), 2 (Last Calendar Year), 3 (Last Fiscal Year), 4 (User Defined Range) One of '1', '2', '3', '4' Case sensitive */ periodType: number | null | undefined; /** * Benchmark Chart Start Period when using Period Type 4 (User Defined Range) Will return null for all other period types Required when PeriodType is set to 4, case sensitive. Valid billing period between 190001 and 300001 NULL Valid */ userDefinedRangeStartPeriod: number | null | undefined; /** * Benchmark Chart End Period when using Period Type 4 (User Defined Range) Will return null for all other period types Required when PeriodType is set to 4, case sensitive. Valid billing period between 190001 and 300001 NULL Valid Must be greater than or equal to UserDefinedRangeStartPeriod */ userDefinedRangeEndPeriod: number | null | undefined; /** * Data view (actual, calendarized, normalized) One of 'actual', 'calendarized', 'normalized' Case sensitive */ dataView: string | null | undefined; /** * Unique identifier of the commodity by which benchmark charts will be filtered */ commodityId: number | null | undefined; /** * Unique identifier of the commodity category by which benchmark charts will be filtered */ commodityCategoryId: number | null | undefined; /** * Indicates whether or not to show excluded group members */ showExcludedMembers: boolean | null | undefined; /** * Indicates whether or not to show zero averages in benchmark charts */ showZeroAverages: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WorkflowDisplaySetting { /** * Indicates whether or not to show the Unapproved bill list in Bill Processing */ showUnapprovedList: boolean | null | undefined; /** * Indicates whether or not to show the Waiting for Export to AP bill list in Bill Processing */ showAPExportList: boolean | null | undefined; /** * Indicates whether or not to show the Waiting for Export to GL bill list in Bill Processing */ showGLExportList: boolean | null | undefined; /** * Indicates whether or not to show the Held from Export bill list in Bill Processing */ showExportHoldList: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Preferences specific to the logged-in user */ declare class Preference { /** * Weather degree unit configured for the user's owner */ weatherDegreeUnit: number | null | undefined; /** * */ metersShowInactive: boolean | null | undefined; /** * Indicates whether or not to show inactive data points in the Data Points tree */ dataPointsShowInactive: boolean | null | undefined; /** * Indicates whether or not to show the datasource name */ showDataSource: boolean | null | undefined; /** * One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive */ buildingTreeDisplaySetting: string | null | undefined; /** * Indicates whether or not to show inactive accounts in the Accounts tree */ accountsShowInactive: boolean | null | undefined; /** * Indicates whether or not to show inactive emission sources in the Emission Sources tree */ emissionSourcesShowInactive: boolean | null | undefined; /** * Name/Code display settings for the Accounts tree One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive */ costCenterTreeDisplaySetting: string | null | undefined; /** * */ buildingTreeGroupToDisplay: number | null | undefined; /** * One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive */ vendorTreeDisplaySetting: string | null | undefined; /** * */ viewVendorsTreeByCommodity: boolean | null | undefined; groupDisplaySetting: GroupDisplaySetting | null | undefined; /** * Number of rows to display in bill lists */ billListRowsPerPage: number | null | undefined; /** * Date format for the user */ dateFormat: string | null | undefined; /** * Time format for the user */ timeFormat: string | null | undefined; /** * Code of the default time zone configured for the user's owner */ timeZoneCode: string | null | undefined; /** * Number of years to display in trend charts when the user views them */ trendChartNumberOfYears: number | null | undefined; /** * User's language preference */ language: string | null | undefined; /** * Value to use when displaying a single building or organization (name or code) */ buildingAndOrganizationIdentifier: string | null | undefined; /** * Value to use when displaying a single meter (name or code) */ meterIdentifier: string | null | undefined; /** * Value to use when displaying a single account (name or code) */ accountIdentifier: string | null | undefined; /** * Value to use when displaying generic items (name or code) */ otherIdentifier: string | null | undefined; /** * Value to use when displaying a single collection (name or code) */ collectionIdentifier: string | null | undefined; /** * Value to use when displaying a single emission source (name or code) */ emissionSourceIdentifier: string | null | undefined; /** * Value to use when displaying a single Space (name or code) */ spaceIdentifier: string | null | undefined; /** * Value to use when displaying a single Data Point (name or code) */ dataPointIdentifier: string | null | undefined; /** * Indicates whether or not in-app help is open */ helpOpen: boolean | null | undefined; workflowDisplaySetting: WorkflowDisplaySetting | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Target { /** * Is the target setting enabled */ enable: boolean | null | undefined; /** * What multiplier to use for the target */ multiplier: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TargetSettings { /** * Target line label */ label: string | null | undefined; /** * Target line base year */ baseYear: number | null | undefined; costTarget: Target | null | undefined; useTarget: Target | null | undefined; ghgTarget: Target | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeFormatResponse { /** * Display name for time format */ displayName: string | null | undefined; /** * Format mask for time format */ formatMask: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TopmostCollection { /** * User's topmost combines multiple collections */ isMultiTopmostCollection: boolean | null | undefined; /** * */ multiTopmostCollections: Array | null | undefined; /** * The collection identifier */ collectionId: number | null | undefined; /** * The collection code */ collectionCode: string | null | undefined; /** * The collection info */ collectionInfo: string | null | undefined; collectionIcon: Icon | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TopmostCostCenter { /** * User's topmost combines multiple cost centers */ isMultiTopmostCostCenter: boolean | null | undefined; /** * */ multiTopmostCostCenters: Array | null | undefined; /** * The cost center identifier */ costCenterId: number | null | undefined; /** * The cost center code */ costCenterCode: string | null | undefined; /** * The cost center info */ costCenterInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TopmostPlace { /** * User's topmost combines multiple places */ isMultiTopmostPlace: boolean | null | undefined; /** * */ multiTopmostPlaces: Array | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TopmostSpace { /** * User's topmost combines multiple places */ isMultiTopmostPlace: boolean | null | undefined; /** * */ multiTopmostPlaces: Array | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. */ isDataRolledUp: boolean | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UtilityPlatform { /** * Date Release file Url used to record Data access release */ dataReleaseFileUrl: string | null | undefined; /** * Identifier for the Utility Platform Provider Organization */ utilityPlatformProviderKey: string | null | undefined; /** * Name of the Utility Platform Provider Organization */ utilityPlatformProviderInfo: string | null | undefined; /** * Flag to indicate if Data Release requests from this Utility Provider can be declined */ canDeclineDataRelease: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Me { place: TopmostPlace | null | undefined; costCenter: TopmostCostCenter | null | undefined; collection: TopmostCollection | null | undefined; space: TopmostSpace | null | undefined; /** * User's authentication token */ token: string | null | undefined; /** * User's external user ID */ externalUserId: string | null | undefined; /** * Username */ systemUserCode: string | null | undefined; /** * Unique identifier for the user */ systemUserId: number | null | undefined; /** * Owner identifier */ ownerId: number | null | undefined; /** * User's full name */ fullName: string | null | undefined; /** * User's email address */ email: string | null | undefined; /** * Number of accounting periods configured for the user's owner */ numberOfAccountingPeriods: number | null | undefined; /** * Calendarization configured for user's owner */ calendarizationMethod: string | null | undefined; /** * Fiscal year start month configured for the user's owner */ fiscalYearStartMonth: number | null | undefined; /** * Method configured for identification of fiscal year for the user's owner */ fiscalYearMethod: string | null | undefined; /** * List of the user's claims */ claim: Array | null | undefined; preference: Preference | null | undefined; /** * Available date formats */ dateFormats: Array | null | undefined; /** * Available time formats */ timeFormats: Array | null | undefined; currencyUnit: UnitChild | null | undefined; /** * Current account period calculated from configuration for the user's owner */ currentAccountingPeriod: number | null | undefined; /** * User's user role */ userRoleName: string | null | undefined; permissions: Permissions | null | undefined; /** * List of enabled feature flags */ featureFlags: Array | null | undefined; /** * Upgrade version number (Version 3) */ upgradeVersionV3: string | null | undefined; /** * Upgrade version number (Version 7) */ upgradeVersionV7: string | null | undefined; /** * Application SKU as set in the license code Possible values are: SaaS (Express), Professional, Online (Enterprise), ConsultantPlatform, ConsultantPlatformPlus, UtilityCompanyPlatform, and Other. */ sku: string | null | undefined; /** * Current environment */ environment: string | null | undefined; /** * Build date for the current application version */ buildDate: Date | null | undefined; /** * The email address to use as the sender for report distribution */ reportDistributionFromEmailAddress: string | null | undefined; /** * The email name to use as the sender for report distribution */ reportDistributionFromEmailName: string | null | undefined; /** * The current mode of the application Values: Online, Offline */ applicationMode: string | null | undefined; /** * The current version of the database */ currentDatabaseVersion: number | null | undefined; utilityPlatformSettings: UtilityPlatform | null | undefined; /** * Node where unplaced meters are assigned */ unplacedMetersParentId: number | null | undefined; /** * Node where unplaced accounts are assigned */ unplacedAccountsParentId: number | null | undefined; /** * Node where unplaced emmission sources are assigned */ unplacedEmissionSourcesParentId: number | null | undefined; /** * Node where unplaced data points are assigned */ unplacedDataPointsParentId: number | null | undefined; floorAreaUnit: UnitChild | null | undefined; /** * Alternate URL to use as a Support link */ supportUrl: string | null | undefined; ghgSettings: GHGSettings | null | undefined; targetSettings: TargetSettings | null | undefined; /** * Months to exclude by default in charts */ chartMonthsToExclude: number | null | undefined; energyCapIdSettings: EnergyCapOptionsEnergyCapIDOptions | null | undefined; energyStarSettings: EnergyStarSettings | null | undefined; /** * Owner’s external Identifier */ externalOwnerId: string | null | undefined; /** * Indicates whether the user is in a production environment */ isProduction: boolean | null | undefined; /** * Indicates which approach is used for bill image URL 0 indicates owner is set to use bill image name, 1 indicates use control code of the bill, 2 indicates use batch code. */ webBillImageUseControlCode: Me.WebBillImageUseControlCodeEnum; /** * Indicates which extension should be used for bill images. */ webBillImageExt: string | null | undefined; /** * Base URL used for bill images. */ webBillImageUrl: string | null | undefined; /** * Cut over date when EnergyCAP officially takes over bill payments */ billPayCutoverBillEndDate: Date | null | undefined; /** * Unique identifier for special permissions for ENC Staff */ specialPermissionId: number | null | undefined; } declare namespace Me { enum WebBillImageUseControlCodeEnum { NUMBER_0, NUMBER_1, NUMBER_2 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Preferences specific to the logged-in user */ declare class PreferenceRequest { /** * Required (defined) */ metersShowInactive: boolean | null | undefined; /** * Indicates whether or not to show inactive data points in the Data Points tree Required (defined) */ dataPointsShowInactive: boolean | null | undefined; /** * Indicates whether or not to show the datasource name Required (defined) */ showDataSource: boolean | null | undefined; /** * One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive Required (defined) */ buildingTreeDisplaySetting: string | null | undefined; /** * Indicates whether or not to show inactive accounts in the Accounts tree Required (defined) */ accountsShowInactive: boolean | null | undefined; /** * Indicates whether or not to show inactive emission sources in the Emission Sources tree Required (defined) */ emissionSourcesShowInactive: boolean | null | undefined; /** * Name/Code display settings for the Accounts tree One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive Required (defined) */ costCenterTreeDisplaySetting: string | null | undefined; /** * Required (defined) */ buildingTreeGroupToDisplay: number | null | undefined; /** * One of 'name', 'code', 'namefirst', 'codefirst' Case sensitive Required (defined) */ vendorTreeDisplaySetting: string | null | undefined; /** * Required (defined) */ viewVendorsTreeByCommodity: boolean | null | undefined; groupDisplaySetting: GroupDisplaySetting | null | undefined; /** * Number of rows to display in bill lists Required (defined) */ billListRowsPerPage: number | null | undefined; /** * Date format for the user Required (defined) */ dateFormat: string | null | undefined; /** * Time format for the user Required (defined) */ timeFormat: string | null | undefined; /** * Code of the default time zone configured for the user's owner Required (defined) */ timeZoneCode: string | null | undefined; /** * Number of years to display in trend charts when the user views them Required (defined) */ trendChartNumberOfYears: number | null | undefined; /** * User's language preference Required (defined) */ language: string | null | undefined; /** * Value to use when displaying a single building or organization (name or code) Required (defined) */ buildingAndOrganizationIdentifier: string | null | undefined; /** * Value to use when displaying a single meter (name or code) Required (defined) */ meterIdentifier: string | null | undefined; /** * Value to use when displaying a single account (name or code) Required (defined) */ accountIdentifier: string | null | undefined; /** * Value to use when displaying generic items (name or code) Required (defined) */ otherIdentifier: string | null | undefined; /** * Value to use when displaying a single collection (name or code) Required (defined) */ collectionIdentifier: string | null | undefined; /** * Value to use when displaying a single emission source (name or code) Required (defined) */ emissionSourceIdentifier: string | null | undefined; /** * Value to use when displaying a single Space (name or code) Required (defined) */ spaceIdentifier: string | null | undefined; /** * Value to use when displaying a single Data Point (name or code) Required (defined) */ dataPointIdentifier: string | null | undefined; /** * Indicates whether or not in-app help is open Required (defined) */ helpOpen: boolean | null | undefined; workflowDisplaySetting: WorkflowDisplaySetting | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeRequest { preference: PreferenceRequest | null | undefined; /** * User's full name Max length of 32 Required (defined) */ fullName: string | null | undefined; /** * User's email address Max length of 128 Required (defined) */ email: string | null | undefined; } declare class MeService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Initial session starting point. Support authorization via a api key, bearer token, or session cookie * */ me(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ updateMe(body?: MeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run all actions that happen before login such as system upgrades and report installation by default to provide maximum compatibility with the latest application code. * * @param upgradesOnly Set to true to limit to only system data upgrades which improves performance but may not guarantee maximum compatibility with the latest application logic. */ upgrade(upgradesOnly?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Initial session starting point. Support authorization via a api key, bearer token, or session cookie * */ meWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param body */ updateMeWithHttpInfo(body?: MeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run all actions that happen before login such as system upgrades and report installation by default to provide maximum compatibility with the latest application code. * * @param upgradesOnly Set to true to limit to only system data upgrades which improves performance but may not guarantee maximum compatibility with the latest application logic. */ upgradeWithHttpInfo(upgradesOnly?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceLinkRequest { /** * The identifier for an Emission source. Set to null to remove the link. Topmost (EmissionSource) Required (defined) */ emissionSourceId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGTypeChild { /** * The identifier for the ghg type */ ghgTypeId: number | null | undefined; /** * The ghg type code */ ghgTypeCode: string | null | undefined; /** * The ghg type info */ ghgTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGFactorsResponse { /** * The identifier for ghg factor */ ghgFactorId: number | null | undefined; /** * The ghg factor */ ghgFactor: number | null | undefined; /** * The ghg CO2 factor */ ghgCO2Factor: number | null | undefined; /** * The start date */ startDate: Date | null | undefined; /** * The end date */ endDate: Date | null | undefined; /** * The description */ description: string | null | undefined; /** * The notes */ memo: string | null | undefined; ghgType: GHGTypeChild | null | undefined; commodityUnit: UnitChild | null | undefined; ghgUnit: UnitChild | null | undefined; commodity: CommodityChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterBillResponse { /** * The bill identifier */ billId: number | null | undefined; batch: BatchChild | null | undefined; account: AccountChild | null | undefined; /** * The bill's begin date */ beginDate: Date | null | undefined; /** * The bill's end date */ endDate: Date | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; /** * The bill's accounting period */ accountPeriod: number | null | undefined; /** * The meter's bill cost */ cost: number | null | undefined; /** * The meter's bill cost per date */ costPerDay: number | null | undefined; /** * The meter's bill cost per unit */ costPerUnit: number | null | undefined; /** * Indicates if the bill is estimated */ estimated: boolean | null | undefined; /** * Indicates if the bill has been approved */ approved: boolean | null | undefined; /** * The date and time the bill was approved */ approveDate: Date | null | undefined; approvedBy: UserChild | null | undefined; /** * Indicates if the bill has been exported */ exported: boolean | null | undefined; /** * The date and time the bill was exported */ exportDate: Date | null | undefined; exportedBy: UserChild | null | undefined; observationMethod: ObservationMethodChild | null | undefined; /** * The date and time of the bill statement */ statementDate: Date | null | undefined; /** * The date and time the bill is due */ dueDate: Date | null | undefined; /** * The date and time of the next reading */ nextReading: Date | null | undefined; /** * The bill's control code */ controlCode: string | null | undefined; /** * The bill's invoice number */ invoiceNumber: string | null | undefined; /** * The number of pages on the invoice */ invoicePages: number | null | undefined; /** * The check number */ checkNumber: string | null | undefined; /** * The date and time of the check */ checkDate: Date | null | undefined; /** * The pay status of the bill */ payStatus: string | null | undefined; /** * The cleared date */ clearedDate: Date | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the bill was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Indicates if the bill has been voided */ void: boolean | null | undefined; /** * Indicates if the bill record has been cleaned. Cleaning is an internal EnergyCAP process */ dirty: boolean | null | undefined; /** * Indicates if the import has been verified */ importVerified: boolean | null | undefined; /** * Indicates if the bill is an accrual */ accrual: boolean | null | undefined; /** * Indicates if the bill is a reversed accrual */ accrualReversed: boolean | null | undefined; /** * The date and time the accrual was reversed */ accrualReversedDate: Date | null | undefined; /** * Indicates if the bill is held for export */ exportHold: boolean | null | undefined; /** * Indicates if the bill has been gl exported */ glExported: boolean | null | undefined; glExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to gl */ glExportDate: Date | null | undefined; /** * Indicates if the bill has been bill payment exported */ paymentExported: boolean | null | undefined; paymentExportedBy: UserChild | null | undefined; /** * The date and time the bill was exported to bill payment */ paymentExportDate: Date | null | undefined; /** * Indicates if the bill is from a vendor */ fromVendor: boolean | null | undefined; /** * Indicates if the bill has been split */ hasBeenSplit: boolean | null | undefined; /** * The date and time the bill was split */ wasSplitDate: Date | null | undefined; /** * The transaction reference number of the bill */ transRefNum: string | null | undefined; /** * The payment type of the bill */ paymentType: string | null | undefined; /** * The actual amount paid */ actualAmountPaid: number | null | undefined; assignedTo: UserChild | null | undefined; /** * The date and time the bill was assigned to a user */ assignedDate: Date | null | undefined; /** * The bill's pay source */ paySource: string | null | undefined; /** * Indicates whom the bill paid */ payTo: string | null | undefined; /** * The balance of the previous bill */ previousBalance: number | null | undefined; /** * The amount of balance that was forwarded */ balanceForward: number | null | undefined; /** * The current charges */ currentCharges: number | null | undefined; /** * The meter's usage */ usage: number | null | undefined; /** * The meter's usage per day */ usePerDay: number | null | undefined; useUnit: UnitChild | null | undefined; /** * The meter's actual demand */ actualDemand: number | null | undefined; actualDemandUnit: UnitChild | null | undefined; /** * The meter's billed demand */ billedDemand: number | null | undefined; billedDemandUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCalendarizedUseVsWeatherResponse { /** * The year */ year: number | null | undefined; /** * Is heating weather sensitive? */ isHeatingWeatherSensitive: boolean | null | undefined; /** * Heating needed below this temperature */ winterBalancePoint: number | null | undefined; /** * The total base heating use per day */ heatingBaseUsePerDay: number | null | undefined; /** * The heating weather factor */ heatingWeatherFactor: number | null | undefined; /** * Is cooling weather sensitive? */ isCoolingWeatherSensitive: boolean | null | undefined; /** * Cooling needed above this temperature */ summerBalancePoint: number | null | undefined; /** * The total base cooling use per day */ coolingBaseUsePerDay: number | null | undefined; /** * The cooling weather factor */ coolingWeatherFactor: number | null | undefined; useUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RequiredAddressChild { /** * The address country Required Must be between 0 and 64 characters */ country: string | null; /** * The postal code for the address Required when the country is United States or Canada Must be between 0 and 32 characters */ postalCode: string | null | undefined; /** * The address type identifier */ addressTypeId: number | null | undefined; /** * Remit To field is the name of the person or company who should receive the payment. It's required for bill pay customers. Must be between 0 and 100 characters */ remitTo: string | null | undefined; /** * The line 1 of the address Must be between 0 and 100 characters */ line1: string | null | undefined; /** * The line 2 of the address Must be between 0 and 100 characters */ line2: string | null | undefined; /** * The line 3 of the address Must be between 0 and 100 characters */ line3: string | null | undefined; /** * The city of the place Must be between 0 and 100 characters */ city: string | null | undefined; /** * The state of the place Must be between 0 and 100 characters */ state: string | null | undefined; /** * The latitude of the place Required when the country is not United States or Canada Must be between -90 and 90 Required when Longitude is set */ latitude: number | null | undefined; /** * The longitude of the place Required when the country is not United States or Canada Must be between -180 and 180 Required when Latitude is set */ longitude: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCreate { /** * The meter code Required Must be between 0 and 32 characters */ meterCode: string | null; /** * The meter info Required Must be between 0 and 50 characters */ meterInfo: string | null; /** * The identifier for the meter's commodity Required */ commodityId: number | null; /** * The identifier for the place the meter is assigned to Topmost (Place) Required */ placeId: number | null; address: RequiredAddressChild | null; /** * The bill entry note Must be between 0 and 64 characters */ billEntryNote: string | null | undefined; /** * DEPRECATED To be included in ENERGY STAR a meter needs to be linked to a meter in Portfolio Manager This can be done with the PUT place/{placeId}/energyStar/link or the ENERGY STAR: Mappings Setup Sheet */ includeInEnergyStar: boolean | null | undefined; /** * An array of meter properties */ properties: { [key: string]: string; } | null | undefined; /** * The identifier for the meter's primary use */ primaryUseId: number | null | undefined; /** * The identifier for the meter type. Allowed values include: 1 (standard meter) and 6 (chargeback meter) Required */ meterTypeId: number | null; /** * The identifier for the meter's time zone. If one is not specified, the global default meter time zone will be used. */ meterTimeZoneId: number | null | undefined; /** * The use unit ID is the reporting unit for use for this meter. It is used to determine initial bill format for this meter. If not provided defaults to the common unit for the meter commodity */ useUnitId: number | null | undefined; /** * The demand unit ID is the reporting unit for demand for this meter. It is used to determine initial bill format for this meter. */ demandUnitId: number | null | undefined; /** * A description of the meter Must be between 0 and 4000 characters */ meterDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterEdit { /** * The meter code Required Must be between 0 and 32 characters */ meterCode: string | null; /** * The meter info Required Must be between 0 and 50 characters */ meterInfo: string | null; /** * The identifier for the place the meter is assigned to Topmost (Place) Required */ placeId: number | null; /** * The commodity identifier that the meter is assigned to. If different from original commodity id, then a commodity change will be attempted. Required */ commodityId: number | null; address: AddressChild | null | undefined; /** * The bill entry note Must be between 0 and 64 characters Required (defined) */ billEntryNote: string | null | undefined; /** * DEPRECATED To be included in ENERGY STAR a meter needs to be linked to a meter in Portfolio Manager This can be done with the PUT place/{placeId}/energyStar/link or the ENERGY STAR: Mappings Setup Sheet Required (defined) */ includeInEnergyStar: boolean | null | undefined; /** * The identifier for the meter's primary use Required (defined) */ primaryUseId: number | null | undefined; /** * The identifier for the meter's time zone. Required */ meterTimeZoneId: number | null; /** * Is this meter active? Required */ active: boolean | null; /** * An array of meter properties Required (defined) */ properties: { [key: string]: string; } | null | undefined; /** * The use unit ID is the reporting unit for use for this meter. If it is null the use unit will be removed (only if the commodity does not have a default use unit, otherwise an exception will be thrown) Required (defined) */ useUnitId: number | null | undefined; /** * The demand unit ID is the reporting unit for demand for this meter. If it is null the demand unit will be removed Required (defined) */ demandUnitId: number | null | undefined; /** * A description of the meter Must be between 0 and 4000 characters Required (defined) */ meterDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupMember { /** * The meter group this meter will belong to Required (defined) */ meterGroupId: number | null | undefined; /** * Whether to include this meter in the group's benchmark charts Required (defined) */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupCategoryChild { /** * */ meterGroupCategoryId: number | null | undefined; /** * */ meterGroupCategoryCode: string | null | undefined; /** * */ meterGroupCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupResponse { /** * The meter group identifier */ meterGroupId: number | null | undefined; /** * The meter group code */ meterGroupCode: string | null | undefined; /** * The meter group info */ meterGroupInfo: string | null | undefined; /** * Indicates if this meter group is an autogroup */ autoGroup: boolean | null | undefined; meterGroupCategory: MeterGroupCategoryChild | null | undefined; /** * Indicates if this meter group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; /** * The last time a member was inserted, updated, or deleted from the group */ lastUpdated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterAccountChild { /** * The MeterAccount meter identifier */ accountMeterId: number | null | undefined; /** * The MeterAccount identifier for this MeterAccount meter */ accountId: number | null | undefined; /** * The code of the MeterAccount for this MeterAccount meter */ accountCode: string | null | undefined; /** * The info of the MeterAccount for this MeterAccount meter */ accountInfo: string | null | undefined; /** * Indicates whether the Account is active or inactive */ active: boolean | null | undefined; /** * Indicates whether the Account has a child calculated meter */ hasCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Account is a recipient of a split */ hasSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Account has a child split meter */ hasSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Account has a sub-account */ hasSubAccount: boolean | null | undefined; /** * Indicates whether the Account is a sub-account */ isSubAccount: boolean | null | undefined; vendor: VendorChild | null | undefined; meterGeneralLedger: GeneralLedgerChild | null | undefined; accountGeneralLedger: GeneralLedgerChild | null | undefined; vendorType: VendorTypeChild | null | undefined; /** * The beginning date and time for this MeterAccount meter relationship */ startDate: Date | null | undefined; /** * The ending date and time for this MeterAccount meter relationship */ endDate: Date | null | undefined; /** * The data access release identifier for this MeterAccount meter relationship, null if there is no release */ dataAccessReleaseId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterRateResponse { /** * The meter tariff identifier */ rateId: number | null | undefined; /** * The rate name */ name: string | null | undefined; /** * The rate code */ rateCode: string | null | undefined; /** * The start date for the rate on the account meter */ startDate: Date | null | undefined; /** * The end date for the rate on the account meter */ endDate: Date | null | undefined; account: MeterAccountChild | null | undefined; commodity: CommodityChild | null | undefined; /** * The rate's note */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelChild { /** * The channel code Combines observationTypeCode:unitCode:observationMethodCode:observationRuleCode:interval in minutes */ channelCode: string | null | undefined; /** * The channel identifier */ channelId: number | null | undefined; /** * The channel interval in seconds. Monthly = 2592000 Weekly = 604800 Daily = 86400 Hourly = 3600 Thirty_Minutes = 1800 Fifteen_Minutes = 900 */ interval: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionSourceLink { /** * The identifier for an Emission source. */ emissionSourceId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterSerialNumberHistoryChild { /** * Previous serial number of the meter */ previousSerialNumber: string | null | undefined; /** * Date that serial number changed */ serialNumberChangeDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WatticsDataPoint { /** * The identifier for a SmartAnalytics (Wattics) meter */ watticsDataPointId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterResponse { /** * The identifier for the meter */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; /** * An array of channels assigned to this meter */ channels: Array | null | undefined; /** * */ accounts: Array | null | undefined; commodity: CommodityChild | null | undefined; place: PlaceChild | null | undefined; address: AddressChild | null | undefined; /** * The bill entry note */ billEntryNote: string | null | undefined; /** * Indicates if the building is included in ENERGY STAR submissions */ includeInEnergyStar: boolean | null | undefined; primaryUse: PrimaryUseChild | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the meter was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification of the meter */ modifiedDate: Date | null | undefined; /** * An array of meter properties */ properties: { [key: string]: string; } | null | undefined; /** * Indicates if the meter should be included in cost avoidance */ includeInCostAvoidance: boolean | null | undefined; route: RouteChild | null | undefined; meterTimeZone: TimeZoneChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; useUnit: UnitChild | null | undefined; demandUnit: UnitChild | null | undefined; /** * Meter's currently assigned serial number */ serialNumber: string | null | undefined; serialNumberHistory: MeterSerialNumberHistoryChild | null | undefined; /** * A description of the meter */ meterDescription: string | null | undefined; watticsDataPoint: WatticsDataPoint | null | undefined; emissionSource: EmissionSourceLink | null | undefined; /** * Provides some insight into the current Sentinel enabled status. */ sentinelStatus: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterSerialNumberHistoryRequest { /** * Serial number that will replace the existing one Required Must be between 0 and 255 characters */ newSerialNumber: string | null; /** * Date that serial number changed Required (defined) */ serialNumberChangeDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterSerialNumberHistoryResponse { /** * Meter identifier Required (defined) */ meterId: number | null | undefined; /** * Serial number of the meter Required (defined) */ serialNumber: string | null | undefined; serialNumberHistory: MeterSerialNumberHistoryChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterTemplateResponse { /** * The form template identifier */ formTemplateId: number | null | undefined; /** * The meter template display order */ displayOrder: number | null | undefined; /** * The begin date for the template on the account meter */ beginDate: Date | null | undefined; /** * The end date for the template on the account meter */ endDate: Date | null | undefined; template: TemplateChild | null | undefined; account: MeterAccountChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterUDFResponse { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * An array of user-defined fields (UDFs) */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WatticsDataPointRequest { /** * The identifier for a SmartAnalytics (Wattics) meter Set to null to remove the link Required (defined) */ watticsDataPointId: number | null | undefined; } declare class MeterService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Turn a Meter into an ESA Calculated Meter This is only possible if the Meter has NO EsaChannels. A Primary Value ESAChannel will be created, according to the EsaChannelCreateDTO. It must be a Formula Channel. The formula is only permitted to reference other ESA Meters. The referenced Meters' Primary Value Channels will be used in the formula calculation. * * @param meterId The identifier for the meter being converted to an ESA Calculated Meter * @param body */ convertToEsaCalculatedMeter(meterId: number, body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a meter * * @param body Data representing the meter being created */ createMeter(body?: MeterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a meter * * @param meterId The identifier for the meter being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteMeter(meterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a meter custom field * * @param meterId * @param udfId */ downloadMeterCustomFieldFile(meterId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit emission source data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Emission Source data to assign to the meter */ editEmissionSourceLink(meterId: number, body?: EmissionSourceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a meter's group memberships. Note that all groups a meter should belong to must be passed in. Passing in one group means that the meter will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param meterId The meter identifier whose group memberships are being edited * @param body The groups the meter will belong to */ editMeterGroupMembership(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param meterId * @param body */ editMeterSerialNumberVersion(meterId: number, body?: MeterSerialNumberHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular meter * * @param meterId The identifier for the meter * @param body Data representing the meter user defined fields / custom fields being edited */ editMeterUDFs(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a meter - unlike the original v3 EditMeter API, the meter use unit will be removed if it is null * * @param meterId The meter identifier for the meter being edited * @param body Data representing the meter being edited */ editMeterWithUnits(meterId: number, body?: MeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit SmartAnalytics (Wattics) data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Identifier for the SmartAnaltyics data point to assign to the meter */ editWatticsDataPointLink(meterId: number, body?: WatticsDataPointRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calendarized Use vs Weather data * * @param meterId The meter identifier */ getCalendarizedUseVsWeatherData(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ghg meter factors * * @param meterId The meter identifier for ghg factors are being retrieved */ getGHGMeterFactors(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one meter * * @param meterId The meter identifier for the meter being retrieved */ getMeter(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all bills for a particular meter * * @param meterId The meter identifier for which bill values are being retrieved */ getMeterBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Meter Groups for a particular meter * * @param meterId The meter identifier for which group values are being retrieved */ getMeterGroups(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all rates for a particular meter * * @param meterId The meter identifier for which rate values are being retrieved */ getMeterRates(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates for a particular meter * * @param meterId The meter identifier for which template values are being retrieved */ getMeterTemplates(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular meter * * @param meterId The meter identifier for which user defined field / custom field values are being retrieved */ getMeterUdfs(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of meters to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of meterIds to move under the parentPlaceId */ moveMeter(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom meter action. Custom meter actions are setup as webhooks * * @param body */ processMeterCustomAction(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Turn a Meter into an ESA Calculated Meter This is only possible if the Meter has NO EsaChannels. A Primary Value ESAChannel will be created, according to the EsaChannelCreateDTO. It must be a Formula Channel. The formula is only permitted to reference other ESA Meters. The referenced Meters' Primary Value Channels will be used in the formula calculation. * * @param meterId The identifier for the meter being converted to an ESA Calculated Meter * @param body */ convertToEsaCalculatedMeterWithHttpInfo(meterId: number, body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a meter * * @param body Data representing the meter being created */ createMeterWithHttpInfo(body?: MeterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a meter * * @param meterId The identifier for the meter being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteMeterWithHttpInfo(meterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a meter custom field * * @param meterId * @param udfId */ downloadMeterCustomFieldFileWithHttpInfo(meterId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit emission source data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Emission Source data to assign to the meter */ editEmissionSourceLinkWithHttpInfo(meterId: number, body?: EmissionSourceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a meter's group memberships. Note that all groups a meter should belong to must be passed in. Passing in one group means that the meter will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param meterId The meter identifier whose group memberships are being edited * @param body The groups the meter will belong to */ editMeterGroupMembershipWithHttpInfo(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param meterId * @param body */ editMeterSerialNumberVersionWithHttpInfo(meterId: number, body?: MeterSerialNumberHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular meter * * @param meterId The identifier for the meter * @param body Data representing the meter user defined fields / custom fields being edited */ editMeterUDFsWithHttpInfo(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits a meter - unlike the original v3 EditMeter API, the meter use unit will be removed if it is null * * @param meterId The meter identifier for the meter being edited * @param body Data representing the meter being edited */ editMeterWithUnitsWithHttpInfo(meterId: number, body?: MeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit SmartAnalytics (Wattics) data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Identifier for the SmartAnaltyics data point to assign to the meter */ editWatticsDataPointLinkWithHttpInfo(meterId: number, body?: WatticsDataPointRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calendarized Use vs Weather data * * @param meterId The meter identifier */ getCalendarizedUseVsWeatherDataWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ghg meter factors * * @param meterId The meter identifier for ghg factors are being retrieved */ getGHGMeterFactorsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one meter * * @param meterId The meter identifier for the meter being retrieved */ getMeterWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all bills for a particular meter * * @param meterId The meter identifier for which bill values are being retrieved */ getMeterBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all Meter Groups for a particular meter * * @param meterId The meter identifier for which group values are being retrieved */ getMeterGroupsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all rates for a particular meter * * @param meterId The meter identifier for which rate values are being retrieved */ getMeterRatesWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates for a particular meter * * @param meterId The meter identifier for which template values are being retrieved */ getMeterTemplatesWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular meter * * @param meterId The meter identifier for which user defined field / custom field values are being retrieved */ getMeterUdfsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Move list of meters to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of meterIds to move under the parentPlaceId */ moveMeterWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom meter action. Custom meter actions are setup as webhooks * * @param body */ processMeterCustomActionWithHttpInfo(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestActualAndCalendarizedMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * The number of days in the period */ days: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Native Unit Cost */ nativeUseUnitCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Native Actual Demand */ nativeActualDemand: number | null | undefined; /** * Native Actual Demand Unit Cost */ nativeActualDemandUnitCost: number | null | undefined; /** * Native Billed Demand */ nativeBilledDemand: number | null | undefined; /** * Native Billed Demand Unit Cost */ nativeBilledDemandUnitCost: number | null | undefined; /** * Load Factor */ loadFactor: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestActualAndCalendarizedMonthlyResponse { /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; nativeUseUnit: UnitChild | null | undefined; nativeDemandUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestActualAndCalendarizedYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Native Use Unit Cost */ nativeUseUnitCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Native Demand */ nativeDemand: number | null | undefined; /** * Native Demand Unit Cost */ nativeDemandUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestActualAndCalendarizedYearlyResponse { /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; nativeDemandUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestCalendarizedTrendResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * The number of days in the period */ days: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Native Unit Cost */ nativeUseUnitCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Native Actual Demand */ nativeActualDemand: number | null | undefined; /** * Native Actual Demand Unit Cost */ nativeActualDemandUnitCost: number | null | undefined; /** * Native Billed Demand */ nativeBilledDemand: number | null | undefined; /** * Native Billed Demand Unit Cost */ nativeBilledDemandUnitCost: number | null | undefined; /** * Load Factor */ loadFactor: number | null | undefined; /** * Average Daily Temperature */ averageDailyTemperature: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestCalendarizedTrendResponse { /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; nativeUseUnit: UnitChild | null | undefined; nativeDemandUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestNormalizedMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * The number of days in the period */ days: number | null | undefined; /** * Cumulative Native Use */ cumulativeNativeUse: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Native Actual Demand */ nativeActualDemand: number | null | undefined; /** * Native Billed Demand */ nativeBilledDemand: number | null | undefined; /** * Load Factor */ loadFactor: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestNormalizedMonthlyResponse { /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; nativeUseUnit: UnitChild | null | undefined; nativeDemandUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestNormalizedYearlyResponseResults { /** * year */ year: string | null | undefined; /** * Native use */ nativeUse: number | null | undefined; /** * Native demand */ nativeDemand: number | null | undefined; /** * Common use */ commonUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestNormalizedYearlyResponse { /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; nativeDemandUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCAPResponse { /** * The meter's baseline start date */ baseStart: Date | null | undefined; /** * The meter's savings start date */ savingStart: Date | null | undefined; /** * Indicates if the meter is included or not included in cost avoidance calculations */ includeInCAP: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestSavingsMonthlyResponseResults { /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Calendar Period Name */ periodName: string | null | undefined; /** * The number of days in the period */ days: number | null | undefined; /** * Total Cost */ savingsTotalCost: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Native Use */ batccNativeUse: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Savings Native Use = BATCCNativeUse - NativeUse */ savingsNativeUse: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Common Use */ batccCommonUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Savings Common Use = BATCCCommonUse - CommonUse */ savingsCommonUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestSavingsMonthlyResponse { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterCAP: MeterCAPResponse | null | undefined; nativeUseUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestSavingsYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Total Cost */ batccTotalCost: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Savings Total Cost = BATCCTotalCost - TotalCost */ savingsTotalCost: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Native Use */ batccNativeUse: number | null | undefined; /** * Native Use */ nativeUse: number | null | undefined; /** * Savings Native Use = BATCCNativeUse - NativeUse */ savingsNativeUse: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Common Use */ batccCommonUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Savings Common Use = BATCCCommonUse - CommonUse */ savingsCommonUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterDigestSavingsYearlyResponse { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterCAP: MeterCAPResponse | null | undefined; nativeUseUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Native Use */ allTimeBATCCNativeUse: number | null | undefined; /** * Program to Date Native Use */ allTimeNativeUse: number | null | undefined; /** * Program to Date Savings Native Use = allTimeBATCCNativeUse - allTimeNativeUse */ allTimeSavingsNativeUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Common Use */ allTimeBATCCCommonUse: number | null | undefined; /** * Program to Date Common Use */ allTimeCommonUse: number | null | undefined; /** * Program to Date Savings Common Use = allTimeBATCCCommonUse - allTimeCommonUse */ allTimeSavingsCommonUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Total Cost */ allTimeBATCCTotalCost: number | null | undefined; /** * Program to Date Total Cost */ allTimeTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost = allTimeBATCCTotalCost - allTimeTotalCost */ allTimeSavingsTotalCost: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * The saving program's start date */ savingsStartDate: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } declare class MeterDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterActualMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterActualYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedTrend(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterCalendarizedYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterNormalizedMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterNormalizedYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data for a given meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months */ getMeterSavingsMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves savings data for a single meter for a given number of years. * * @param meterId The meter for which to return data * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 */ getMeterSavingsYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterActualMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterActualYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedTrendWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterCalendarizedYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterNormalizedMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterNormalizedYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings billing data for a given meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months */ getMeterSavingsMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves savings data for a single meter for a given number of years. * * @param meterId The meter for which to return data * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 */ getMeterSavingsYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupMemberRequest { /** * The flag determining whether the member is included in group charts Required */ includeInCharts: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupMeterGroupResponse { /** * The meter group identifier */ meterGroupId: number | null | undefined; /** * The meter group code */ meterGroupCode: string | null | undefined; /** * The meter group info */ meterGroupInfo: string | null | undefined; /** * Indicates if this meter group is an autogroup */ autoGroup: boolean | null | undefined; /** * The number of meters in this group */ memberCount: number | null | undefined; /** * The number of meters within the currently authenticated user's topmost */ memberCountWithTopmost: number | null | undefined; meterGroupCategory: MeterGroupCategoryChild | null | undefined; /** * Indicates if the meter group has been set limit the list of members by the user's topmost */ limitMembersByTopmost: boolean | null | undefined; /** * Indicates if this meter group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; /** * The filters applied to determine the members of a user defined auto group */ userDefinedAutoGroupFilters: Array | null | undefined; /** * The last time a member was inserted, updated, or deleted from the group */ lastUpdated: Date | null | undefined; /** * The commodity code for the meters in this group - if all meters belong to the same commodity the commodity code will be used here if meters belong to different commodities, value will be \"MULTIPLE\" if this group has no meters, value will be \"\" */ memberCommodityCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCategoryRequest { /** * The meter category code Must be between 0 and 32 characters Required */ meterGroupCategoryCode: string | null; /** * The meter category info Must be between 0 and 32 characters Required */ meterGroupCategoryInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCategoryResponse { /** * The meter category identifier */ meterGroupCategoryId: number | null | undefined; /** * The meter category code */ meterGroupCategoryCode: string | null | undefined; /** * The meter category name */ meterGroupCategoryInfo: string | null | undefined; /** * Is this category an automatically maintained one? */ autoGroup: boolean | null | undefined; /** * Number of groups within this category */ numberOfGroups: number | null | undefined; /** * Number of groups within this category with members the logged in can see */ numberOfGroupsWithVisibleMembers: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupMemberChild { /** * The meter identifier Required (defined) */ meterId: number | null | undefined; /** * The meter code Required (defined) */ meterCode: string | null | undefined; /** * The meter info Required (defined) */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; place: PlaceChild | null | undefined; /** * The flag determining whether the meter is included in group charts Required (defined) */ includeInCharts: boolean | null | undefined; /** * Indicates whether the Meter is Active Required (defined) */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter Required (defined) */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split Required (defined) */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split Required (defined) */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupRequest { /** * The meter group info Must be between 0 and 255 characters Required */ meterGroupInfo: string | null; /** * The meter group category Required */ meterGroupCategoryId: number | null; /** * Should this group only return members within the current user's topmost Required */ limitMembersByTopmost: boolean | null; /** * List of filters to add members to an automatic meter group Either AutomaticGroupFilters or ManualGroupMembers, but not both, must be passed in Cannot be Empty NULL Valid Only one of AutomaticGroupFilters, ManualGroupMembers can be set */ automaticGroupFilters: Array | null | undefined; /** * List of members to add to the group Either AutomaticGroupFilters or ManualGroupMembers, but not both, must be passed in Members but be within the current user's topmost You can create an empty group by passing in an empty array Only one of AutomaticGroupFilters, ManualGroupMembers can be set */ manualGroupMembers: Array | null | undefined; } declare class MeterGroupService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a meter group category * * @param body Data representing the meter group category being created */ createMeterCategory(body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a meter group * * @param body Data representing the meter group being created */ createMeterGroup(body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a meter group category * * @param categoryId Id of the category to delete */ deleteMeterCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user-created meter group * * @param meterGroupId */ deleteMeterGroup(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a meter group category * * @param categoryId Id of the category to update * @param body Data to update the meter group category */ editMeterCategory(categoryId: number, body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a meter group * * @param meterGroupId Id of the group to edit * @param body Data representing the meter group being edited */ editMeterGroup(meterGroupId: number, body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of meter groups * * @param filter */ getAllMeterGroups(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter categories * */ getMeterCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a meter group category * * @param categoryId The identifier for the meter group category being retrieved */ getMeterCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a meter group * * @param meterGroupId */ getMeterGroup(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of meter group members * * @param groupId * @param alwaysLimitByTopmost */ getMeterGroupMembers(groupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of filters that can be used to create Meter Groups * */ getUserDefinedAutoMeterGroupFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Include all group members in charts * * @param meterGroupId */ includeAllMeterGroupMemberInCharts(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserMeterAutoGroupsMembership(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for a user defined auto group * * @param meterGroupId The meter group to refresh */ recalculateUserMeterAutoGroupMemebership(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a group member's include in charts flag * * @param meterGroupId * @param meterId * @param body */ updateMeterGroupMember(meterGroupId: number, meterId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a meter group category * * @param body Data representing the meter group category being created */ createMeterCategoryWithHttpInfo(body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a meter group * * @param body Data representing the meter group being created */ createMeterGroupWithHttpInfo(body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a meter group category * * @param categoryId Id of the category to delete */ deleteMeterCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user-created meter group * * @param meterGroupId */ deleteMeterGroupWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a meter group category * * @param categoryId Id of the category to update * @param body Data to update the meter group category */ editMeterCategoryWithHttpInfo(categoryId: number, body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a meter group * * @param meterGroupId Id of the group to edit * @param body Data representing the meter group being edited */ editMeterGroupWithHttpInfo(meterGroupId: number, body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter groups * * @param filter */ getAllMeterGroupsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of meter categories * */ getMeterCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieve a meter group category * * @param categoryId The identifier for the meter group category being retrieved */ getMeterCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a meter group * * @param meterGroupId */ getMeterGroupWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter group members * * @param groupId * @param alwaysLimitByTopmost */ getMeterGroupMembersWithHttpInfo(groupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of filters that can be used to create Meter Groups * */ getUserDefinedAutoMeterGroupFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Include all group members in charts * * @param meterGroupId */ includeAllMeterGroupMemberInChartsWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserMeterAutoGroupsMembershipWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for a user defined auto group * * @param meterGroupId The meter group to refresh */ recalculateUserMeterAutoGroupMemebershipWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a group member's include in charts flag * * @param meterGroupId * @param meterId * @param body */ updateMeterGroupMemberWithHttpInfo(meterGroupId: number, meterId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupDigestRankingChild { /** * */ cost: number | null | undefined; /** * */ use: number | null | undefined; /** * */ unitCost: number | null | undefined; /** * */ value: number | null | undefined; /** * */ days: number | null | undefined; /** * */ savingsOpportunity: number | null | undefined; /** * */ meterId: number | null | undefined; /** * */ meterCode: string | null | undefined; /** * */ meterInfo: string | null | undefined; /** * */ meterDisplay: string | null | undefined; commodity: CommodityChild | null | undefined; /** * */ includeInCharts: boolean | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupDigestRankingResponse { /** * */ highCost: number | null | undefined; /** * */ lowCost: number | null | undefined; /** * */ averageCost: number | null | undefined; /** * */ medianCost: number | null | undefined; /** * */ highUse: number | null | undefined; /** * */ lowUse: number | null | undefined; /** * */ averageUse: number | null | undefined; /** * */ medianUse: number | null | undefined; /** * */ highUnitCost: number | null | undefined; /** * */ lowUnitCost: number | null | undefined; /** * */ averageUnitCost: number | null | undefined; /** * */ medianUnitCost: number | null | undefined; /** * */ highValue: number | null | undefined; /** * */ lowValue: number | null | undefined; /** * */ averageValue: number | null | undefined; /** * */ medianValue: number | null | undefined; costUnit: UnitChild | null | undefined; useUnit: UnitChild | null | undefined; /** * */ benchmarkUnit: string | null | undefined; /** * */ benchmarkValueUnit: string | null | undefined; /** * */ benchmarkFactorUnit: string | null | undefined; /** * */ highSavingsOpportunity: number | null | undefined; /** * */ results: Array | null | undefined; /** * */ meterGroupId: number | null | undefined; /** * */ meterGroupCode: string | null | undefined; /** * */ meterGroupInfo: string | null | undefined; /** * */ meterGroupDisplay: string | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } declare class MeterGroupDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves cost, use, unit cost or demand per day ranking data by meter group. * Specify values for any query parameters whose database values are to be overridden. **PLEASE NOTE: As shown in the table below, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | -------- | ---------------------------------------- | | cost | MeterGroupDigestRankingResponseDTO | | use | MeterGroupDigestRankingResponseDTO | | unitCost | MeterGroupDigestRankingResponseDTO | | demand | MeterGroupDigestDemandRankingResponseDTO | * @param groupId The meter group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - cost, use, unitcost, demand * @param billingPeriodOption The billing period option - last12periods, lastyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getMeterGroupRanking(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves cost, use, unit cost or demand per day ranking data by meter group. * Specify values for any query parameters whose database values are to be overridden. **PLEASE NOTE: As shown in the table below, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | -------- | ---------------------------------------- | | cost | MeterGroupDigestRankingResponseDTO | | use | MeterGroupDigestRankingResponseDTO | | unitCost | MeterGroupDigestRankingResponseDTO | | demand | MeterGroupDigestDemandRankingResponseDTO | * @param groupId The meter group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - cost, use, unitcost, demand * @param billingPeriodOption The billing period option - last12periods, lastyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getMeterGroupRankingWithHttpInfo(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationBadgeResponse { /** * Total of unread and unarchived notifications */ totalNotifications: number | null | undefined; /** * Total of unread and unarchived notifications since the last checked date time */ newNotifications: number | null | undefined; /** * The date and time in UTC the query to get the badge data was run */ lastCheckDateTimeUtc: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationActionButtonResponse { /** * Url the action will link to */ url: string | null | undefined; /** * Label the action will display */ label: string | null | undefined; /** * Should clicking the action link open a new window */ openInNewWindow: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationCategory { /** * The id of the notification category */ notificationCategoryId: number | null | undefined; /** * The notification category name */ notificationCategoryInfo: string | null | undefined; /** * A description of the notification category */ notificationCategoryDescription: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationType { /** * The id of the notification type */ notificationTypeId: number | null | undefined; /** * The notification type name */ notificationTypeInfo: string | null | undefined; /** * A description of the notification type */ notificationTypeDescription: string | null | undefined; notificationCategory: NotificationCategory | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationDetailsResponse { /** * The full notification message */ message: string | null | undefined; createdByUser: UserChild | null | undefined; primaryAction: NotificationActionButtonResponse | null | undefined; secondaryAction: NotificationActionButtonResponse | null | undefined; /** * The id of the notification */ notificationId: number | null | undefined; /** * True if the notification has been read */ read: boolean | null | undefined; /** * True if the notification has been archived */ archived: boolean | null | undefined; /** * Subject of the notification */ subject: string | null | undefined; /** * The date and time the notification was generated */ createdDate: Date | null | undefined; notificationType: NotificationType | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationResponse { /** * The notification message with any html tags stripped out */ messagePreview: string | null | undefined; /** * The id of the notification */ notificationId: number | null | undefined; /** * True if the notification has been read */ read: boolean | null | undefined; /** * True if the notification has been archived */ archived: boolean | null | undefined; /** * Subject of the notification */ subject: string | null | undefined; /** * The date and time the notification was generated */ createdDate: Date | null | undefined; notificationType: NotificationType | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationSettingRequest { /** * The id of the notification type Required */ notificationTypeId: number | null; /** * Update the configured notification option To get the list of available options for each setting call the GetNotificationSystemSettings or GetNotificationUserSettings API If your database is not configured to send emails, passing in ShowInAppAndSendEmail will return an error One of 'ShowInAppAndSendEmail', 'ShowInAppOnly', 'Off' Required */ configuredNotificationOption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationSettingResponse { notificationType: NotificationType | null | undefined; /** * The currently configured notification option */ configuredNotificationOption: string | null | undefined; /** * All possible notification options for this setting */ availableNotificationOptions: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationSettingsResponse { /** * Are user's allowed to get email notifications */ allowUsersToEmailNotifications: boolean | null | undefined; /** * The list of notification settings available and their configured value */ notificationSettings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationSystemSettingsRequest { /** * Are user's allowed to get email notifications Required */ allowUsersToEmailNotifications: boolean | null; /** * The list of notification settings and the configured value If a notification type is not passed the configured value will remain what it was set to Required (defined) */ notificationSettings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NotificationUpdateRequest { /** * List of notification ids to perform the action on Cannot be Empty Required (defined) */ notificationIds: Array | null | undefined; /** * Action to perform Unread marks all notifications in the list as unread Read marks all notifications in the list as read Archived marks all notifications in the list as archived Unarchived marks all notifications in the list as unarchived One of 'Read', 'Unread', 'Archived', 'Unarchived' Required */ action: string | null; } declare class NotificationService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get a specific notification for the current user * * @param notificationId Id of the notification to get */ getNotification(notificationId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get total number of notifications that are unread and unarchived for the current user. Use lastCheckDateTimeUtc to get the number of new notifications since the passed in date and time. By default, only the latest 250 notifications will be taken into account. Use the 'noLimit' query parameter to override this behavior. * * @param lastCheckDateTimeUtc Used when calculating the number of new notifications. Must be a UTC DateTime in the format yyyy-MM-ddTHH:mm:ssZ. If not passed the TotalNotifications and NewNotifications will be equal. * @param noLimit If true, will return the badge totals for all of the user's notifications, not just the 250 most recent ones */ getNotificationBadgeTotals(lastCheckDateTimeUtc?: Date, noLimit?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a specific notification's details for the current user * * @param notificationId Id of the notification to get */ getNotificationDetails(notificationId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * The default notification settings assigned to new users * */ getNotificationSystemSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of notification types * */ getNotificationTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * The notification settings for the current user * */ getNotificationUserSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all notifications for the current user * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getNotifications(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a list of notifications based on the notification ids and action passed in Only notifications for the current user can be updated * * @param body List of notification ids and action to perform */ updateListOfNotifications(body?: NotificationUpdateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the default notification settings assigned to new users * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationSystemSettings(body?: NotificationSystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the notification settings for the current user * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationUserSettings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a specific notification for the current user * * @param notificationId Id of the notification to get */ getNotificationWithHttpInfo(notificationId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get total number of notifications that are unread and unarchived for the current user. Use lastCheckDateTimeUtc to get the number of new notifications since the passed in date and time. By default, only the latest 250 notifications will be taken into account. Use the 'noLimit' query parameter to override this behavior. * * @param lastCheckDateTimeUtc Used when calculating the number of new notifications. Must be a UTC DateTime in the format yyyy-MM-ddTHH:mm:ssZ. If not passed the TotalNotifications and NewNotifications will be equal. * @param noLimit If true, will return the badge totals for all of the user's notifications, not just the 250 most recent ones */ getNotificationBadgeTotalsWithHttpInfo(lastCheckDateTimeUtc?: Date, noLimit?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a specific notification's details for the current user * * @param notificationId Id of the notification to get */ getNotificationDetailsWithHttpInfo(notificationId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * The default notification settings assigned to new users * */ getNotificationSystemSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of notification types * */ getNotificationTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * The notification settings for the current user * */ getNotificationUserSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all notifications for the current user * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getNotificationsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update a list of notifications based on the notification ids and action passed in Only notifications for the current user can be updated * * @param body List of notification ids and action to perform */ updateListOfNotificationsWithHttpInfo(body?: NotificationUpdateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the default notification settings assigned to new users * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationSystemSettingsWithHttpInfo(body?: NotificationSystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the notification settings for the current user * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationUserSettingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingDelete { /** * The identifier for the channel of the reading Required */ channelId: number | null; /** * The begin date and time of the set of readings to be deleted. If provided, readings after but NOT including the provided begin date and time will be deleted. */ timeBegin: Date | null | undefined; /** * The end date and time of the set of readings to be deleted. If provided, readings up to and including the provided end date and time will be deleted. */ timeEnd: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DeleteReadingResponse { /** * The number of readings deleted */ deleted: number | null | undefined; /** * Data representing the failed reading deletion */ failures: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Reading { /** * The date and time of the reading Required Required */ time: Date | null; /** * The reading's value Required Required */ value: number | null; /** * Indicates if the reading is estimated Required (defined) */ estimated: boolean | null | undefined; /** * A note pertaining to the reading Required (defined) */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingCreate { /** * Channel Identification The channel that receives the reading is determined by the following rules: Direct pointers to a channel If the channelId is supplied, then import to that channel. If the channelId is not supplied look at the channelImportId property, which indicates a specific channel. Inferred pointers to a channel If the channelId and channelImportId are not supplied, look at the meterImportId property, which indicates a meter.If that meter has one channel, import to that channel. If that meter has more than one channel, find the channel with the same observation type as the observationTypeCode property.If only one is found, import to that channel. If more than one channel is found based on observation type, find the channel with the same output unit as the unitCode property.If only one is found, import to that channel. If more than one channel is found based on unit, find the channel with the same channelIntervalInSeconds property. If only one is found, import to that channel. Topmost (Channel) */ channelId: number | null | undefined; /** * The import identifier for the channel on which to create the reading. See the channelId property for more information Must be between 0 and 255 characters */ channelImportId: string | null | undefined; /** * The import identifier for the meter on which to create the reading. See the channelId property for more information Must be between 0 and 255 characters */ meterImportId: string | null | undefined; /** * */ channelIntervalInSeconds: number | null | undefined; /** * The observationType code of the reading. See the channelId property for more information Must be between 0 and 16 characters */ observationTypeCode: string | null | undefined; /** * The unit code of the reading. See the channelId property for more information Must be between 0 and 16 characters */ unitCode: string | null | undefined; /** * array of readings Required */ readings: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FailedReadings { /** * */ time: Date | null | undefined; /** * */ value: number | null | undefined; /** * */ estimated: boolean | null | undefined; /** * */ note: string | null | undefined; /** * */ error: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FailedReadingResponse { /** * */ channelId: number | null | undefined; /** * */ channelImportId: string | null | undefined; /** * */ meterImportId: string | null | undefined; /** * */ observationTypeCode: string | null | undefined; /** * */ unitCode: string | null | undefined; /** * */ channelIntervalInSeconds: number | null | undefined; /** * */ readings: Array | null | undefined; /** * */ error: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingResponse { /** * The number of successfully imported readings */ importedReadingsCount: number | null | undefined; /** * The number of failed reading imports */ failedReadingsCount: number | null | undefined; /** * Data representing the failed reading imports */ failedReadings: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingsObservation { /** * The unique ID for the reading Required (defined) */ observationId: number | null | undefined; /** * The date and time of the reading Required (defined) */ time: Date | null | undefined; /** * The raw or computed value of the reading Required (defined) */ value: number | null | undefined; /** * The raw value of the reading (before multiplier or delta are applied) Required (defined) */ rawValue: number | null | undefined; /** * Indicates if the reading is estimated Required (defined) */ estimated: boolean | null | undefined; /** * A note pertaining to the reading Required (defined) */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Readings { /** * The Id of the Channel */ channelId: number | null | undefined; /** * 1 = odometer, 2 = trip (to calculate delta) */ rule: number | null | undefined; unit: UnitChild | null | undefined; /** * */ readings: Array | null | undefined; } declare class ObservationService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates new readings * * @param body Data representing the readings being imported */ createReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes one or more sets of meter readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body The channel id, begin date and time and end date and time of the set of meter readings to be deleted */ deleteReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a single interval data reading by its ID * * @param readingId Unique ID of the reading to delete */ deleteSingleReading(readingId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a single interval data reading. Duplicate timestamps are not allowed for readings on a given channel. If the reading being edited has the same timestamp as another reading on the same channel, this end point throws an error * * @param readingId Unique ID of the reading to edit * @param body Updated reading properties */ editSingleReading(readingId: number, body?: Reading, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an array of readings * * @param channelId Specific Channel ID * @param beginDate The starting date of readings to return * @param endDate The end date of readings to return * @param originalValue If 'true', returns the original observation value. If 'false' returns the computed observation value based on the channel type. NOTE: this parameter is no longer used and has been deprecated. */ getReadings(channelId: number, beginDate?: Date, endDate?: Date, originalValue?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates new readings * * @param body Data representing the readings being imported */ createReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes one or more sets of meter readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body The channel id, begin date and time and end date and time of the set of meter readings to be deleted */ deleteReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a single interval data reading by its ID * * @param readingId Unique ID of the reading to delete */ deleteSingleReadingWithHttpInfo(readingId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a single interval data reading. Duplicate timestamps are not allowed for readings on a given channel. If the reading being edited has the same timestamp as another reading on the same channel, this end point throws an error * * @param readingId Unique ID of the reading to edit * @param body Updated reading properties */ editSingleReadingWithHttpInfo(readingId: number, body?: Reading, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of readings * * @param channelId Specific Channel ID * @param beginDate The starting date of readings to return * @param endDate The end date of readings to return * @param originalValue If 'true', returns the original observation value. If 'false' returns the computed observation value based on the channel type. NOTE: this parameter is no longer used and has been deprecated. */ getReadingsWithHttpInfo(channelId: number, beginDate?: Date, endDate?: Date, originalValue?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class ObservationTypeService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get the observation types for a given noun class code and/or noun code. * * @param filter */ getObservationTypes(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the observation types for a given noun class code and/or noun code. * * @param filter */ getObservationTypesWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceMetricsResponse { /** * The year and month for the ENERGY STAR score */ calendarPeriod: number | null | undefined; /** * The ENERGY STAR score */ score: number | null | undefined; /** * The date the score was received */ dateReceived: Date | null | undefined; /** * The weather-normalized property energy use (kBtu) */ siteEnergyUse: number | null | undefined; /** * The weather-normalized property energy use intensity (kBtu/ft²) */ siteEnergyUseIntensity: number | null | undefined; /** * The national median ENERGY STAR score for the same type of property */ nationalMedianScore: number | null | undefined; /** * The national median weather-normalized property energy use intensity (kBtu/ft²) */ nationalMedianSiteEnergyUseIntensity: number | null | undefined; /** * The percent difference in the property energy use intensity vs. the national median */ pctDiffNationalMedianSiteEnergyUseIntensity: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceHierarchyResponse { place: PlaceChild | null | undefined; placeSize: PlaceSizeChild | null | undefined; placeSubmissionType: SubmissionTypeResponse | null | undefined; /** * The status of the latest submission for this place */ latestSubmissionStatus: string | null | undefined; /** * The date that the latest submission for this place occurred */ latestSubmissionDate: Date | null | undefined; /** * The status of the latest metrics retrieval for this place */ latestMetricsRetrievalStatus: string | null | undefined; /** * ENERGY STAR score data for the place If there are multiple places returned in the response, will be the most recent score */ metrics: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarCommodityLinkRequest { /** * The commodity identifier Required */ commodityId: number | null; /** * The Portfolio Manager meter identifier. Set to null to unlink meter. Required (defined) */ pmMeterId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarMeterLinkRequest { /** * The meter identifier Required */ meterId: number | null; /** * The Portfolio Manager meter identifier. Set to null to unlink meter. Required (defined) */ pmMeterId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceLinkRequest { /** * The Portfolio Manager property identifier. Set to null to unlink place. Required (defined) */ pmPropertyId: number | null | undefined; /** * List of meter links for this place If PmPropertyId is null to unlink the place then Meters should be null. All meters under the place will be unlinked automatically. Required (defined) Only one of Meters, Commodities can be set */ meters: Array | null | undefined; /** * List of commodity links for this place If PmPropertyId is null to unlink the place then Commodities should be null. All commodities under the place will be unlinked automatically. Required (defined) Only one of Meters, Commodities can be set */ commodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarCommodityLinkChild { /** * The Portfolio Manager meter identifier */ pmMeterId: number | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates if the commodity is compatible with ENERGY STAR */ energyStarCompatible: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarMeterLinkChild { meter: MeterChild | null | undefined; /** * The Portfolio Manager meter identifier */ pmMeterId: number | null | undefined; /** * The meter's average use per day */ usePerDay: number | null | undefined; useUnit: UnitChild | null | undefined; /** * The meter's average cost per day */ costPerDay: number | null | undefined; costUnit: UnitChild | null | undefined; /** * Is this meter's commodity ENERGY STAR-compatible? */ energyStarCompatible: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyStarPlaceLinkResponse { place: PlaceChild | null | undefined; /** * The submit mode. Could be \"Meter\" or \"Commodity\" */ submitMode: string | null | undefined; /** * una co The Portfolio Manager property identifier */ pmPropertyId: number | null | undefined; /** * List of meters for this place */ meters: Array | null | undefined; /** * List of commodities for this place */ commodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceCreate { /** * The place code Required Must be between 0 and 32 characters Not ROOT */ placeCode: string | null; /** * The place info Required Must be between 0 and 50 characters */ placeInfo: string | null; /** * The identifier for the parent of the place. The parent is the place directly above the current place on the buildings and meters tree Required Topmost (Place) */ parentPlaceId: number | null; /** * The identifier for the place type Required */ placeTypeId: number | null; /** * The identifier for the place's primary use If this is a building and PrimaryUseId is null this will be set to Unknown (PrimaryUseId 55) */ primaryUseId: number | null | undefined; /** * The date and time the place was built */ buildDate: Date | null | undefined; address: AddressChild | null | undefined; /** * The code for the weather station the place is assigned to Must be between 0 and 32 characters */ weatherStationCode: string | null | undefined; /** * A description of the place Must be between 0 and 4000 characters */ placeDescription: string | null | undefined; /** * The Time Zone Id for the place. If not present or set to null, the owner's default time zone will be used if the place is a site. */ timeZoneId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceEdit { /** * The place code Required Must be between 0 and 32 characters Not ROOT */ placeCode: string | null; /** * The place info Required Must be between 0 and 50 characters */ placeInfo: string | null; /** * The identifier for the parent of the place. The parent is the place directly above the current place on the buildings and meters tree Required Topmost (Place) */ parentPlaceId: number | null; /** * The identifier for the place type Required */ placeTypeId: number | null; /** * The identifier for the place's primary use If this is a building and PrimaryUseId is null this will be set to Unknown (PrimaryUseId 55) Required (defined) */ primaryUseId: number | null | undefined; /** * The date and time the place was built Required (defined) */ buildDate: Date | null | undefined; address: AddressChild | null | undefined; /** * The code for the weather station the place is assigned to Must be between 0 and 32 characters Required (defined) */ weatherStationCode: string | null | undefined; /** * A description of the place Must be between 0 and 4000 characters Required (defined) */ placeDescription: string | null | undefined; /** * The Time Zone Id for the place. If not specified or set to null, the owner's default time zone will be used if the place is a site and doesn't already have a time zone. Required (defined) */ timeZoneId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupMember { /** * The place group this place will belong to Required (defined) */ placeGroupId: number | null | undefined; /** * Whether to include this place in the group's benchmark charts Required (defined) */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupCategoryChild { /** * */ placeGroupCategoryId: number | null | undefined; /** * */ placeGroupCategoryCode: string | null | undefined; /** * */ placeGroupCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupResponse { /** * The place group identifier */ placeGroupId: number | null | undefined; /** * The place group code */ placeGroupCode: string | null | undefined; /** * The place group info */ placeGroupInfo: string | null | undefined; /** * Indicates if this place group is an autogroup */ autoGroup: boolean | null | undefined; placeGroupCategory: PlaceGroupCategoryChild | null | undefined; /** * Indicates if this place group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; /** * The last time a member was inserted, updated, or deleted from the group */ lastUpdated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceResponse { parent: PlaceChild | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * The date and time the place was created */ createdDate: Date | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time of the most recent modification to the place */ modifiedDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; address: AddressChild | null | undefined; /** * The date and time the place was built */ buildDate: Date | null | undefined; primaryUse: PrimaryUseChild | null | undefined; weatherStation: WeatherStationChild | null | undefined; size: PlaceSizeChild | null | undefined; benchmark1: LatestBenchmarkValue | null | undefined; benchmark2: LatestBenchmarkValue | null | undefined; benchmark3: LatestBenchmarkValue | null | undefined; /** * Tells whether energy star is enabled for the given place */ energyStarEnabled: boolean | null | undefined; energyStarRating: EnergyStarRatingChild | null | undefined; /** * An array of child places. A child place is one directly beneath the current place */ places: Array | null | undefined; /** * An array of child meters. A child meter is one directly beneath the current place */ meters: Array | null | undefined; /** * An array of child data points. A child data point is one directly beneath the current place */ dataPoints: Array | null | undefined; contact: ContactChild | null | undefined; /** * A description of the place */ placeDescription: string | null | undefined; watticsSite: WatticsSite | null | undefined; /** * Tells whether the place area is calculated from its children (TODO: Use 'Area' instead of 'Size'? Would be inconsistent with Size property in DTO) */ isSizeCalculated: boolean | null | undefined; /** * Tells whether or not the place's data is rolled up to its parents. Currently only supported by ESA. */ isDataRolledUp: boolean | null | undefined; sizeInReportingUnit: PlaceSizeChild | null | undefined; /** * The name of the place's image. Currently only supported by ESA. */ imageFilename: string | null | undefined; timeZone: TimeZoneChild | null | undefined; /** * The place's schedules */ schedules: Array | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceSizeCreate { /** * The begin date for the place size Required Required */ beginDate: Date | null; /** * The place size value Required Must be between 0 and 2147483647 Required Must be between 0 and 2147483647 */ value: number | null; /** *

The place size's unit code

Options are SQFEET for Square Feet and SQMETER for Square Meters

One of 'SQFEET', 'SQMETER', 'HECTARE', 'SQKILOMETER', 'SQMILE', 'SQYARD', 'ACRE' Case sensitive Must be between 0 and 16 characters One of 'SQFEET', 'SQMETER', 'HECTARE', 'SQKILOMETER', 'SQMILE', 'SQYARD', 'ACRE' Case sensitive Must be between 0 and 16 characters Required (defined) */ unitCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceSubmissionTypeRequest { /** * The submission type to apply One of 'Automatic', 'Manual' Required (defined) */ submissionType: string | null | undefined; /** * The list of places whose submission types will be updated Cannot be Empty Required (defined) */ placeIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceTypeRequest { /** * The place type info Must be between 0 and 32 characters */ placeTypeInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceUDFResponse { /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * An array of user-defined fields (UDFs) */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WatticsSiteRequest { /** * The identifier for a SmartAnalytics (Wattics) site Set to null to remove the link Required (defined) */ watticsSiteId: number | null | undefined; } declare class PlaceService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a place * * @param body Data representing the place being created */ createPlace(body?: PlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place size version If a preceding place size version exists, the preceding record's end date will be changed to match the created record's begin date If a succeeding place size version exists the created records end date will match the succeeding version's begin date * * @param placeId The identifier of the place to add a place size to * @param body Data representing the place size being created */ createPlaceSize(placeId: number, body?: PlaceSizeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a place type * New place types will not be considered structures * @param body Definition of new place type */ createPlaceType(body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a place * * @param placeId The identifier for the place being deleted */ deletePlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a place size version The preceding version's end date will be shifted to the deleted record's end date to prevent any gaps * * @param placeId The identifier of the place * @param placeSizeId The identifier of the place size */ deletePlaceSize(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes the place type * * @param placeTypeId Unique identifier for the place type */ deletePlaceType(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a place custom field * * @param placeId * @param udfId */ downloadPlaceCustomFieldFile(placeId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the ENERGY STAR linking information for this place and its meters. Set PmPropertyId/PmMeterId to null to unlink a property/meter. Set PmMeterId to -1 to auto-create a new meter. * * @param placeId The place identifier * @param body Data representing the place link being edited */ editEnergyStarPlaceLink(placeId: number, body?: EnergyStarPlaceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a place * * @param placeId The identifier for the place being edited * @param body Data representing the place being edited */ editPlace(placeId: number, body?: PlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a place's group memberships. Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param placeId The place identifier whose group memberships are being edited * @param body The groups the place will belong to */ editPlaceGroupMembership(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk * * @param placeId The identifier of the place * @param body Data representing the place size being created */ editPlaceSizeList(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a current place type * * @param placeTypeId Unique identifier for the place type * @param body Definition of new place type */ editPlaceType(placeTypeId: number, body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular place * * @param placeId The identifier for the place * @param body Data representing the place user defined fields / custom fields being edited */ editPlaceUDFs(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit SmartAnalytics (Wattics) data on a place * * @param placeId The place identifier for the place to edit * @param body Identifier for the SmartAnalytics (Wattics) site to assign to the place */ editWatticsSiteLink(placeId: number, body?: WatticsSiteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children's energy projects * * @param placeId The place identifier for which energy projects are being retrieved */ getEnergyProjectsForPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR info for a place. * * @param placeId The place identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getEnergyStarPlace(placeId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get this place's ENERGY STAR child places * * @param placeId The place identifier * @param filter */ getEnergyStarPlaceHierarchy(placeId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR linking information for this place and its meters. PmPropertyId and PmMeterId will be null if no link yet exists. * * @param placeId The place identifier */ getEnergyStarPlaceLink(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the ENERGY STAR metrics for a place. * * @param placeId The place identifier * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarPlaceMetrics(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one place * * @param placeId The identifier for the place being retrieved */ getPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Place Groups for a particular place by placeId * * @param placeId The place identifier for which group values are being retrieved */ getPlaceGroups(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a place size record for a particular place * * @param placeId The identifier for the place being retrieved * @param placeSizeId The identifier for the place size being retrieved */ getPlaceSize(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all place size records for a particular place * * @param placeId The identifier for the place being retrieved */ getPlaceSizes(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one place type * * @param placeTypeId Unique identifier for the place type */ getPlaceType(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all place types * * @param filter */ getPlaceTypes(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular place * * @param placeId The place identifier for which user defined field / custom field values are being retrieved */ getPlaceUdfs(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of places to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of placeIds to move under the parentPlaceId */ movePlace(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink a list of places and their child meters from ENERGY STAR * * @param body List of place identifiers to unlink from ENERGY STAR */ unlinkPlacesAndChildMetersFromEnergyStar(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a list of places to be submitted to ENERGY STAR manually or automatically * * @param body The list of places to update, as well as the submission type to set */ updateEnergyStarSubmissionType(body?: PlaceSubmissionTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place * * @param body Data representing the place being created */ createPlaceWithHttpInfo(body?: PlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a place size version If a preceding place size version exists, the preceding record's end date will be changed to match the created record's begin date If a succeeding place size version exists the created records end date will match the succeeding version's begin date * * @param placeId The identifier of the place to add a place size to * @param body Data representing the place size being created */ createPlaceSizeWithHttpInfo(placeId: number, body?: PlaceSizeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a place type * New place types will not be considered structures * @param body Definition of new place type */ createPlaceTypeWithHttpInfo(body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a place * * @param placeId The identifier for the place being deleted */ deletePlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a place size version The preceding version's end date will be shifted to the deleted record's end date to prevent any gaps * * @param placeId The identifier of the place * @param placeSizeId The identifier of the place size */ deletePlaceSizeWithHttpInfo(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes the place type * * @param placeTypeId Unique identifier for the place type */ deletePlaceTypeWithHttpInfo(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a place custom field * * @param placeId * @param udfId */ downloadPlaceCustomFieldFileWithHttpInfo(placeId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the ENERGY STAR linking information for this place and its meters. Set PmPropertyId/PmMeterId to null to unlink a property/meter. Set PmMeterId to -1 to auto-create a new meter. * * @param placeId The place identifier * @param body Data representing the place link being edited */ editEnergyStarPlaceLinkWithHttpInfo(placeId: number, body?: EnergyStarPlaceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a place * * @param placeId The identifier for the place being edited * @param body Data representing the place being edited */ editPlaceWithHttpInfo(placeId: number, body?: PlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a place's group memberships. Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param placeId The place identifier whose group memberships are being edited * @param body The groups the place will belong to */ editPlaceGroupMembershipWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk * * @param placeId The identifier of the place * @param body Data representing the place size being created */ editPlaceSizeListWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit a current place type * * @param placeTypeId Unique identifier for the place type * @param body Definition of new place type */ editPlaceTypeWithHttpInfo(placeTypeId: number, body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular place * * @param placeId The identifier for the place * @param body Data representing the place user defined fields / custom fields being edited */ editPlaceUDFsWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit SmartAnalytics (Wattics) data on a place * * @param placeId The place identifier for the place to edit * @param body Identifier for the SmartAnalytics (Wattics) site to assign to the place */ editWatticsSiteLinkWithHttpInfo(placeId: number, body?: WatticsSiteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children's energy projects * * @param placeId The place identifier for which energy projects are being retrieved */ getEnergyProjectsForPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ENERGY STAR info for a place. * * @param placeId The place identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getEnergyStarPlaceWithHttpInfo(placeId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get this place's ENERGY STAR child places * * @param placeId The place identifier * @param filter */ getEnergyStarPlaceHierarchyWithHttpInfo(placeId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ENERGY STAR linking information for this place and its meters. PmPropertyId and PmMeterId will be null if no link yet exists. * * @param placeId The place identifier */ getEnergyStarPlaceLinkWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR metrics for a place. * * @param placeId The place identifier * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarPlaceMetricsWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one place * * @param placeId The identifier for the place being retrieved */ getPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Place Groups for a particular place by placeId * * @param placeId The place identifier for which group values are being retrieved */ getPlaceGroupsWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a place size record for a particular place * * @param placeId The identifier for the place being retrieved * @param placeSizeId The identifier for the place size being retrieved */ getPlaceSizeWithHttpInfo(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all place size records for a particular place * * @param placeId The identifier for the place being retrieved */ getPlaceSizesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one place type * * @param placeTypeId Unique identifier for the place type */ getPlaceTypeWithHttpInfo(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all place types * * @param filter */ getPlaceTypesWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular place * * @param placeId The place identifier for which user defined field / custom field values are being retrieved */ getPlaceUdfsWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Move list of places to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of placeIds to move under the parentPlaceId */ movePlaceWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink a list of places and their child meters from ENERGY STAR * * @param body List of place identifiers to unlink from ENERGY STAR */ unlinkPlacesAndChildMetersFromEnergyStarWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a list of places to be submitted to ENERGY STAR manually or automatically * * @param body The list of places to update, as well as the submission type to set */ updateEnergyStarSubmissionTypeWithHttpInfo(body?: PlaceSubmissionTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkEdit { /** * benchmark category Id Required */ benchmarkCategoryId: number | null; /** * benchmark name Required Not one of Area, Day Must be between 0 and 255 characters */ benchmarkInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkSettingsEdit { benchmark1: BenchmarkEdit | null | undefined; benchmark2: BenchmarkEdit | null | undefined; benchmark3: BenchmarkEdit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkWithUsedCountResponse { /** * Number of times benchmark is used */ usedCount: number | null | undefined; /** * Indicator for which benchmark factor */ benchmarkIndicator: number | null | undefined; /** * benchmark info */ benchmarkInfo: string | null | undefined; benchmarkCategory: BenchmarkCategoryResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkSettingsResponse { benchmark1: BenchmarkWithUsedCountResponse | null | undefined; benchmark2: BenchmarkWithUsedCountResponse | null | undefined; benchmark3: BenchmarkWithUsedCountResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkValueRequest { /** * The effective date for the benchmark Required Must be first of the month Required Must be first of the month */ effectiveDate: Date | null; /** * The benchmark value Required Max scale of 6 Must be between 0 and 1.7976931348623157E+308 Required Max scale of 6 Must be between 0 and 1.7976931348623157E+308 */ value: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BenchmarkValuesResponse { /** * List of benchmark values and their effective dates Required (defined) */ benchmarkValues: Array | null | undefined; /** * Indicator for which benchmark factor Required (defined) */ benchmarkIndicator: number | null | undefined; /** * benchmark info Required (defined) */ benchmarkInfo: string | null | undefined; benchmarkCategory: BenchmarkCategoryResponse | null | undefined; } declare class PlaceBenchmarkService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a place benchmark value If a preceding benchmark value exists, the preceding record's end date will be changed to match the created records begin date If a succeeding benchmark value exists, the created record's end date will match the succeeding benchmarks begin date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param body The new begin date and value for the benchmark */ createPlaceBenchmarkValue(benchmarkIndicator: number, placeId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a single benchmark value. If a preceding benchmark value exists, the preceding record’s end date will be changed to prevent any gaps in benchmark values * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Indicator for the place * @param placeBenchmarkId Indicator for the individual benchmark value */ deleteBenchmarkValue(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete the settings for the place benchmark defined by the benchmarkIndicator. Deletes all corresponding place benchmark values that were defined for that indicator. Updates user-defined autogroup membership for groups that contained filters for that indicator. * * @param benchmarkIndicator Indicator for the benchmark */ deletePlaceBenchmarkSetting(benchmarkIndicator: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * The user can edit the category and name for each benchmark If a benchmark has not been configured, it is configured User cannot delete a benchmark from this endpoint If the benchmark dto is null or not passed the API will ignore it If the benchmark dto is not null, the category and name are required * * @param body Dto containing what to edit on benchmark */ editPlaceBenchmarkSettings(body?: BenchmarkSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit all values for a benchmark factor on a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId * @param body */ editPlaceBenchmarkValues(benchmarkIndicator: number, placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves benchmark values for a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Identifier for the place */ getBenchmarkValues(benchmarkIndicator: number, placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all place benchmark categories in the database * */ getPlaceBenchmarkCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all the place benchmark names and categories for the owner * */ getPlaceBenchmarkSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates a place benchmark value If the begin date is being modified, the following will happen: * Records that now precede and previously preceded this benchmark will have their end dates modified to prevent gaps in benchmarks * If a succeeding benchmark value exists for the new begin date, the end date will be modified to match the succeeding benchmarks end date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param placeBenchmarkId The identifier for the benchmark being updated * @param body The new begin date and value for the benchmark */ updatePlaceBenchmarkValue(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place benchmark value If a preceding benchmark value exists, the preceding record's end date will be changed to match the created records begin date If a succeeding benchmark value exists, the created record's end date will match the succeeding benchmarks begin date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param body The new begin date and value for the benchmark */ createPlaceBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a single benchmark value. If a preceding benchmark value exists, the preceding record’s end date will be changed to prevent any gaps in benchmark values * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Indicator for the place * @param placeBenchmarkId Indicator for the individual benchmark value */ deleteBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete the settings for the place benchmark defined by the benchmarkIndicator. Deletes all corresponding place benchmark values that were defined for that indicator. Updates user-defined autogroup membership for groups that contained filters for that indicator. * * @param benchmarkIndicator Indicator for the benchmark */ deletePlaceBenchmarkSettingWithHttpInfo(benchmarkIndicator: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * The user can edit the category and name for each benchmark If a benchmark has not been configured, it is configured User cannot delete a benchmark from this endpoint If the benchmark dto is null or not passed the API will ignore it If the benchmark dto is not null, the category and name are required * * @param body Dto containing what to edit on benchmark */ editPlaceBenchmarkSettingsWithHttpInfo(body?: BenchmarkSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all values for a benchmark factor on a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId * @param body */ editPlaceBenchmarkValuesWithHttpInfo(benchmarkIndicator: number, placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves benchmark values for a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Identifier for the place */ getBenchmarkValuesWithHttpInfo(benchmarkIndicator: number, placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all place benchmark categories in the database * */ getPlaceBenchmarkCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all the place benchmark names and categories for the owner * */ getPlaceBenchmarkSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a place benchmark value If the begin date is being modified, the following will happen: * Records that now precede and previously preceded this benchmark will have their end dates modified to prevent gaps in benchmarks * If a succeeding benchmark value exists for the new begin date, the end date will be modified to match the succeeding benchmarks end date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param placeBenchmarkId The identifier for the benchmark being updated * @param body The new begin date and value for the benchmark */ updatePlaceBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose period range DTO */ declare class PeriodRange { /** * The start period for the range */ startPeriod: number | null | undefined; /** * The end period for the range */ endPeriod: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedMonthlyResponseCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Cumulative Total Cost */ cumulativeTotalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Cumulative Common Use */ cumulativeCommonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * */ cumulativeGlobalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; /** * Common Demand */ commonDemand: number | null | undefined; /** * Common Demand Unit Cost */ commonDemandUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestTargetComparisonMonthlyResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestTargetComparisonMonthly { /** * Target Year */ targetYear: number | null | undefined; /** * Target Label */ targetLabel: string | null | undefined; /** * Monthly Target Data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedMonthlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; /** * The commodity category identifier */ commodityCategoryId: number | null | undefined; /** * The commodity category name */ commodityCategoryInfo: string | null | undefined; commonUseUnit: UnitChild | null | undefined; commonDemandUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of commodity monthly data */ results: Array | null | undefined; targetComparison: PlaceDigestTargetComparisonMonthly | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Cumulative Total Cost */ cumulativeTotalCost: number | null | undefined; /** * Use */ globalUse: number | null | undefined; /** * Cumulative Use */ cumulativeGlobalUse: number | null | undefined; /** * Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedMonthlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; periodRange: PeriodRange | null | undefined; targetComparison: PlaceDigestTargetComparisonMonthly | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of monthly data per commodity */ commodities: Array | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; /** * Common Demand */ commonDemand: number | null | undefined; /** * Common Demand Unit Cost */ commonDemandUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedYearlyResponseTargetComparison { /** * Target year */ targetYear: number | null | undefined; /** * Target label */ targetLabel: string | null | undefined; /** * Total cost for the target year */ totalCost: number | null | undefined; /** * Total cost for the target year up to the target period that corresponds to the current period */ totalCostYtd: number | null | undefined; /** * Total use for the target year */ globalUse: number | null | undefined; /** * Total use for the target year up to the target period that corresponds to the current period */ globalUseYtd: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; targetComparison: PlaceDigestActualAndCalendarizedYearlyResponseTargetComparison | null | undefined; costUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; commonDemandUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedYearlyResponseResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Use */ globalUse: number | null | undefined; /** * Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestActualAndCalendarizedYearlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; targetComparison: PlaceDigestActualAndCalendarizedYearlyResponseTargetComparison | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose commodity value comparison DTO */ declare class CommodityValueComparison { commodity: CommodityChild | null | undefined; currentValue: ValueWithUnit | null | undefined; previousValue: ValueWithUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose value comparison DTO */ declare class ValueComparison { currentValue: ValueWithUnit | null | undefined; previousValue: ValueWithUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Comparison data for a place */ declare class PlaceDigestComparisonResponse { currentPeriodRange: PeriodRange | null | undefined; previousPeriodRange: PeriodRange | null | undefined; intensity: ValueComparison | null | undefined; total: ValueComparison | null | undefined; /** * Comparison values for each commodity */ commodities: Array | null | undefined; floorAreaUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestEnergyUseIntensityEuiCommodity { /** * The commodity identifier */ commodityId: number | null | undefined; /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The use for the commodity */ use: number | null | undefined; /** * The percent of the building's energy used by the commodity */ usePercent: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestEnergyUseIntensityEuiEnergyProject { /** * The energy project identifier */ energyProjectId: number | null | undefined; /** * The energy project code */ energyProjectCode: string | null | undefined; /** * The energy project info */ energyProjectInfo: string | null | undefined; /** * The energy project installation cost */ installationCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestEnergyUseIntensity { /** * The calendar period name */ periodName: string | null | undefined; /** * The calendar period number */ calendarPeriod: number | null | undefined; /** * The calendar year */ calendarYear: number | null | undefined; /** * The running average use per area for the prior 12 months */ usePerAreaTrend: number | null | undefined; globalUseUnit: UnitChild | null | undefined; /** * A list of energy projects for this building. To be listed, a project must end in this period. Projects are only displayed at the building level, but not at the organization level */ energyProjects: Array | null | undefined; /** * A breakdown of use per commodity */ commodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedCommodityTargetComparisonMonthlyCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Cumulative Common Use */ cumulativeCommonUse: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Demand */ commonDemand: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedCommodityTargetComparisonMonthly { /** * Target Year */ targetYear: number | null | undefined; /** * Target Label */ targetLabel: string | null | undefined; /** * Monthly Target Data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedMonthlyResponseCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Cumulative Common Use */ cumulativeCommonUse: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Demand */ commonDemand: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedMonthlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; commonDemandUnit: UnitChild | null | undefined; /** * An array of commodity monthly data */ results: Array | null | undefined; targetComparison: PlaceDigestNormalizedCommodityTargetComparisonMonthly | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedTargetComparisonMonthlyResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedTargetComparisonMonthly { /** * Target Year */ targetYear: number | null | undefined; /** * Target Label */ targetLabel: string | null | undefined; /** * Monthly Target Data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedMonthlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; targetComparison: PlaceDigestNormalizedTargetComparisonMonthly | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; /** * An array of monthly data per commodity */ commodities: Array | null | undefined; /** * An array of monthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedYearlyResponseTargetComparison { /** * Target year */ targetYear: number | null | undefined; /** * Target label */ targetLabel: string | null | undefined; /** * Total use for the target year */ globalUse: number | null | undefined; /** * Total use for the target year up to the target period that corresponds to the current period */ globalUseYtd: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; targetComparison: PlaceDigestNormalizedYearlyResponseTargetComparison | null | undefined; commonUseUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedYearlyResponseResults { /** * year */ year: string | null | undefined; /** * Use */ globalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestNormalizedYearlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; targetComparison: PlaceDigestNormalizedYearlyResponseTargetComparison | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsMonthlyResponseCommodityDataCommodityResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Savings Total Cost */ savingsTotalCost: number | null | undefined; /** * Savings Global Use */ savingsCommonUse: number | null | undefined; /** * Savings Global Use */ savingsGlobalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsMonthlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of SavingsMonthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsMonthlyResponseResults { /** * Calendar Period Name */ periodName: string | null | undefined; /** * Calendar Period */ calendarPeriod: number | null | undefined; /** * Calendar Year */ calendarYear: number | null | undefined; /** * Fiscal Period */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Savings Total Cost */ savingsTotalCost: number | null | undefined; /** * Savings Global Use */ savingsGlobalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsMonthlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of SavingsMonthly data per commodity */ commodities: Array | null | undefined; /** * An array of SavingsMonthly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsYearlyResponseCommodityDataCommodityResults { /** * Year */ year: string | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Total Cost */ batccTotalCost: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Savings Total Cost = BATCCTotalCost - TotalCost */ savingsTotalCost: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Global Use */ batccGlobalUse: number | null | undefined; /** * GlobalUse */ globalUse: number | null | undefined; /** * Savings Global Use = BATCCGlobalUse - GlobalUse */ savingsGlobalUse: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Common Use */ batccCommonUse: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Savings Common Use = BATCCCommonUse - CommonUse */ savingsCommonUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Common Use */ allTimeBATCCCommonUse: number | null | undefined; /** * Program to Date Common Use */ allTimeCommonUse: number | null | undefined; /** * Program to Date Savings Common Use = allTimeBATCCCommonUse - allTimeCommonUse */ allTimeSavingsCommonUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Global Use */ allTimeBATCCGlobalUse: number | null | undefined; /** * Program to Date Global Use */ allTimeGlobalUse: number | null | undefined; /** * Program to Date Savings Global Use = allTimeBATCCGlobalUse - allTimeGlobalUse */ allTimeSavingsGlobalUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Total Cost */ allTimeBATCCTotalCost: number | null | undefined; /** * Program to Date Total Cost */ allTimeTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost = allTimeBATCCTotalCost - allTimeTotalCost */ allTimeSavingsTotalCost: number | null | undefined; costUnit: UnitChild | null | undefined; commonUseUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Total Cost */ batccTotalCost: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Savings Total Cost = BATCCTotalCost - TotalCost */ savingsTotalCost: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Global Use */ batccGlobalUse: number | null | undefined; /** * GlobalUse */ globalUse: number | null | undefined; /** * Savings Global Use = BATCCGlobalUse - GlobalUse */ savingsGlobalUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestSavingsYearlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Global Use */ allTimeBATCCGlobalUse: number | null | undefined; /** * Program to Date Global Use */ allTimeGlobalUse: number | null | undefined; /** * Program to Date Savings Global Use = allTimeBATCCGlobalUse - allTimeGlobalUse */ allTimeSavingsGlobalUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Total Cost */ allTimeBATCCTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost */ allTimeTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost = allTimeBATCCTotalCost - allTimeTotalCost */ allTimeSavingsTotalCost: number | null | undefined; /** * An array of savings yearly data */ results: Array | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of savings yearly data per commodity */ commodities: Array | null | undefined; } declare class PlaceDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves energy use intensity data for a place. If data is requested for an organization, then all the places under the organization will be rolled up. * * @param placeId The place to retrieve data for */ getEuiChartData(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceActualMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceActualYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total cost and cost for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedCostComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Return the total ghg and ghg for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedGhgComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceCalendarizedMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceCalendarizedYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) */ getPlaceNomalizedMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total use and use for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceNormalizedUseComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceNormalizedYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceSavingsMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param placeId * @param numberOfYears */ getPlaceSavingsYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves energy use intensity data for a place. If data is requested for an organization, then all the places under the organization will be rolled up. * * @param placeId The place to retrieve data for */ getEuiChartDataWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceActualMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceActualYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Return the total cost and cost for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedCostComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total ghg and ghg for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedGhgComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceCalendarizedMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceCalendarizedYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) */ getPlaceNomalizedMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Return the total use and use for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceNormalizedUseComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceNormalizedYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceSavingsMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param placeId * @param numberOfYears */ getPlaceSavingsYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupPlaceGroupMember { /** * The place identifier Required (defined) */ placeId: number | null | undefined; /** * The place code Required (defined) */ placeCode: string | null | undefined; /** * The place info Required (defined) */ placeInfo: string | null | undefined; parent: PlaceChild | null | undefined; placeType: PlaceTypeResponse | null | undefined; /** * The flag determining whether the place is included in group charts Required (defined) */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupPlaceGroupResponse { /** * The place group identifier */ placeGroupId: number | null | undefined; /** * The place group code */ placeGroupCode: string | null | undefined; /** * The place group info */ placeGroupInfo: string | null | undefined; /** * Indicates if this place group is an autogroup */ autoGroup: boolean | null | undefined; /** * The number of places in this group */ memberCount: number | null | undefined; /** * The number of places within the currently authenticated user's topmost */ memberCountWithTopmost: number | null | undefined; placeGroupCategory: PlaceGroupCategoryChild | null | undefined; /** * Indicates if the place group has been set limit the list of members by the user's topmost */ limitMembersByTopmost: boolean | null | undefined; /** * Indicates if this place group is an user defined auto group */ userDefinedAutoGroup: boolean | null | undefined; /** * The filters applied to determine the members of a user defined auto group */ userDefinedAutoGroupFilters: Array | null | undefined; /** * The last time a member was inserted, updated, or deleted from the group */ lastUpdated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceCategoryRequest { /** * The place category info Required Must be between 0 and 32 characters */ placeGroupCategoryInfo: string | null; /** * The place category code Required Must be between 0 and 32 characters */ placeGroupCategoryCode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceCategoryResponse { /** * The place category identifier */ placeGroupCategoryId: number | null | undefined; /** * The place category code */ placeGroupCategoryCode: string | null | undefined; /** * The place category name */ placeGroupCategoryInfo: string | null | undefined; /** * Is this category an automatically maintained one? */ autoGroup: boolean | null | undefined; /** * Number of groups within this category */ numberOfGroups: number | null | undefined; /** * Number of groups within this category with members the logged in can see */ numberOfGroupsWithVisibleMembers: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupRequest { /** * The place group info Must be between 0 and 255 characters Required */ placeGroupInfo: string | null; /** * The place group category Required */ placeGroupCategoryId: number | null; /** * Should this group only return members within the current user's topmost Required */ limitMembersByTopmost: boolean | null; /** * List of filters to add members to an automatic place group Either AutomaticGroupFilters or ManualGroupMembers, but not both, must be passed in Cannot be Empty NULL Valid Only one of AutomaticGroupFilters, ManualGroupMembers can be set */ automaticGroupFilters: Array | null | undefined; /** * List of members to add to the group Either AutomaticGroupFilters or ManualGroupMembers, but not both, must be passed in Members but be within the current user's topmost You can create an empty group by passing in an empty array Only one of AutomaticGroupFilters, ManualGroupMembers can be set */ manualGroupMembers: Array | null | undefined; } declare class PlaceGroupService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a place group category * * @param body Data representing the place group category being created */ createPlaceCategory(body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a place group * * @param body Data representing the place group being created */ createPlaceGroup(body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a place group category * * @param categoryId Id of the category to delete */ deletePlaceCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user-created place group * * @param placeGroupId */ deletePlaceGroup(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a place group category * * @param categoryId Id of the category to update * @param body Data to update the place group category */ editPlaceCategory(categoryId: number, body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a place group * * @param placeGroupId Id of the group to edit * @param body Data representing the place group being edited */ editPlaceGroup(placeGroupId: number, body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of place groups * * @param filter */ getAllPlaceGroups(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place categories * */ getPlaceCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a Place Group Category * * @param categoryId The identifier for the place group category being retrieved */ getPlaceCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a place group * * @param placeGroupId */ getPlaceGroup(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of place group members * * @param placeGroupId * @param alwaysLimitByTopmost */ getPlaceGroupMembers(placeGroupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of filters that can be used to create Place Groups * */ getUserDefinedAutoPlaceGroupFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Include all group members in charts * * @param placeGroupId */ includeAllPlaceGroupMemberInCharts(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserPlaceAutoGroupsMembership(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for a user defined auto group * * @param placeGroupId The place group to refresh */ recalculateUserPlaceAutoGroupMemebership(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a group member's include in charts flag * * @param placeGroupId * @param placeId * @param body */ updatePlaceGroupMember(placeGroupId: number, placeId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place group category * * @param body Data representing the place group category being created */ createPlaceCategoryWithHttpInfo(body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a place group * * @param body Data representing the place group being created */ createPlaceGroupWithHttpInfo(body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a place group category * * @param categoryId Id of the category to delete */ deletePlaceCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user-created place group * * @param placeGroupId */ deletePlaceGroupWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a place group category * * @param categoryId Id of the category to update * @param body Data to update the place group category */ editPlaceCategoryWithHttpInfo(categoryId: number, body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a place group * * @param placeGroupId Id of the group to edit * @param body Data representing the place group being edited */ editPlaceGroupWithHttpInfo(placeGroupId: number, body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place groups * * @param filter */ getAllPlaceGroupsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of place categories * */ getPlaceCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieve a Place Group Category * * @param categoryId The identifier for the place group category being retrieved */ getPlaceCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a place group * * @param placeGroupId */ getPlaceGroupWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place group members * * @param placeGroupId * @param alwaysLimitByTopmost */ getPlaceGroupMembersWithHttpInfo(placeGroupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of filters that can be used to create Place Groups * */ getUserDefinedAutoPlaceGroupFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Include all group members in charts * * @param placeGroupId */ includeAllPlaceGroupMemberInChartsWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserPlaceAutoGroupsMembershipWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for a user defined auto group * * @param placeGroupId The place group to refresh */ recalculateUserPlaceAutoGroupMemebershipWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a group member's include in charts flag * * @param placeGroupId * @param placeId * @param body */ updatePlaceGroupMemberWithHttpInfo(placeGroupId: number, placeId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestAreaRankingChild { /** * The cost for this place */ cost: number | null | undefined; /** * The use for this place */ use: number | null | undefined; /** * The benchmark value for this place */ value: number | null | undefined; /** * The area for this place */ area: number | null | undefined; /** * The savings opportunity for this place */ savingsOpportunity: number | null | undefined; /** * Does this place have incomplete data? */ incompleteData: boolean | null | undefined; /** * */ placeId: number | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeDisplay: string | null | undefined; /** * */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestAreaDemandRankingResponse { /** * Highest cost for this group */ highCost: number | null | undefined; /** * Lowest cost for this group */ lowCost: number | null | undefined; /** * Average cost for this group */ averageCost: number | null | undefined; /** * Median cost for this group */ medianCost: number | null | undefined; /** * Highest use for this group */ highUse: number | null | undefined; /** * Lowest use for this group */ lowUse: number | null | undefined; /** * Average use for this group */ averageUse: number | null | undefined; /** * Median use for this group */ medianUse: number | null | undefined; /** * Highest benchmark value for this group */ highValue: number | null | undefined; /** * Lowest benchmark value for this group */ lowValue: number | null | undefined; /** * Median benchmark value for this group */ medianValue: number | null | undefined; /** * Total area for this group */ totalArea: number | null | undefined; /** * Highest area for this group */ highArea: number | null | undefined; /** * Lowest area for this group */ lowArea: number | null | undefined; /** * Median area for this group */ medianArea: number | null | undefined; /** * The highest savings opportunity for this group */ highSavingsOpportunity: number | null | undefined; /** * */ results: Array | null | undefined; /** * */ placeGroupId: number | null | undefined; /** * */ placeGroupCode: string | null | undefined; /** * */ placeGroupInfo: string | null | undefined; /** * This is the user's preferred way of viewing this entity - could be code or info based on the master \"data object view\" setting in DB */ placeGroupDisplay: string | null | undefined; /** * This will provide the benchmark unit eg:MMBTU/ft² or $/day */ benchmarkUnit: string | null | undefined; /** * This will provide the unit for the benchmarking factor eg:ft² or day */ benchmarkFactorUnit: string | null | undefined; /** * This will provide the unit for the benchmark value eg:$ for cost/day, MMBTU for annualized use/area */ benchmarkValueUnit: string | null | undefined; useUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } declare class PlaceGroupDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves ranking data by place group. * Depending on the \"chart\" parameter retrieved ranking data could be cost, use, or demand per area, cost or use per day, heating sensitivity or cooling sensitivity Specify values for any query parameters whose database values are to be overridden. For the heating sensitivity and cooling sensitivity charts we sort by weather sensitivity (slope) and exclude non-weather meters **PLEASE NOTE: As shown in the table above, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | ------------------ | -------------------------------------------- | | areaCost | PlaceGroupDigestAreaRankingResponseDTO | | areaUse | PlaceGroupDigestAreaRankingResponseDTO | | cost | PlaceGroupDigestRankingResponseDTO | | use | PlaceGroupDigestRankingResponseDTO | | areaDemand | PlaceGroupDigestAreaDemandRankingResponseDTO | | coolingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | heatingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | benchmark1Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark1Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | * @param groupId The place group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - areacost, areause, areademand, cost, use, heatingsensitivity, coolingsensitivity, benchmark1use, benchmark1cost, benchmark2use, benchmark2cost, benchmark3use, benchmark3cost * @param billingPeriodOption The billing period option - last12periods, currentyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getPlaceGroupRanking(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves ranking data by place group. * Depending on the \"chart\" parameter retrieved ranking data could be cost, use, or demand per area, cost or use per day, heating sensitivity or cooling sensitivity Specify values for any query parameters whose database values are to be overridden. For the heating sensitivity and cooling sensitivity charts we sort by weather sensitivity (slope) and exclude non-weather meters **PLEASE NOTE: As shown in the table above, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | ------------------ | -------------------------------------------- | | areaCost | PlaceGroupDigestAreaRankingResponseDTO | | areaUse | PlaceGroupDigestAreaRankingResponseDTO | | cost | PlaceGroupDigestRankingResponseDTO | | use | PlaceGroupDigestRankingResponseDTO | | areaDemand | PlaceGroupDigestAreaDemandRankingResponseDTO | | coolingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | heatingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | benchmark1Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark1Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | * @param groupId The place group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - areacost, areause, areademand, cost, use, heatingsensitivity, coolingsensitivity, benchmark1use, benchmark1cost, benchmark2use, benchmark2cost, benchmark3use, benchmark3cost * @param billingPeriodOption The billing period option - last12periods, currentyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getPlaceGroupRankingWithHttpInfo(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PostalCodeResponseWeatherStation { /** * The weather station Id */ weatherStationId: number | null | undefined; /** * The web station Id */ webStationId: number | null | undefined; /** * The weather station code */ weatherStationCode: string | null | undefined; /** * The city of the weather station */ city: string | null | undefined; /** * The state of the weather station */ state: string | null | undefined; /** * The country of the weather station */ country: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PostalCodeResponse { /** * The postal code */ postalCode: string | null | undefined; /** * The city of the postal code */ city: string | null | undefined; /** * The state of the postal code */ state: string | null | undefined; /** * The country of the postal code */ country: string | null | undefined; weatherStation: PostalCodeResponseWeatherStation | null | undefined; } declare class PostalCodeService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves the city, state, country, and weather station for a postal code * * @param postalCode */ getPostalCode(postalCode: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the city, state, country, and weather station for a postal code * * @param postalCode */ getPostalCodeWithHttpInfo(postalCode: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PrimaryUseCreate { /** * The Primary Use Code Required Must be between 0 and 64 characters */ primaryUseCode: string | null; /** * The Primary Use Info Required Must be between 0 and 64 characters */ primaryUseInfo: string | null; /** * The Primary Use Type. Possible value include: \"place\" and \"meter\" Required One of 'place', 'meter' */ primaryUseType: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PrimaryUseResponse { /** * */ primaryUseId: number | null | undefined; /** * */ primaryUseCode: string | null | undefined; /** * */ primaryUseInfo: string | null | undefined; /** * */ primaryUseType: string | null | undefined; } declare class PrimaryUseService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a Primary Use * * @param body Data representing the Primary Use being created */ createPrimaryUse(body?: PrimaryUseCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a primary use * * @param primaryUseId The identifier for the primary use being deleted */ deletePrimaryUse(primaryUseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Primary Uses. The array of Primary Uses can be filtered by Primary Use type. Possible values for this filter include: \"meter\", \"place\". See the filter property for more details * * @param filter */ getPrimaryUses(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a Primary Use * * @param body Data representing the Primary Use being created */ createPrimaryUseWithHttpInfo(body?: PrimaryUseCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a primary use * * @param primaryUseId The identifier for the primary use being deleted */ deletePrimaryUseWithHttpInfo(primaryUseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Primary Uses. The array of Primary Uses can be filtered by Primary Use type. Possible values for this filter include: \"meter\", \"place\". See the filter property for more details * * @param filter */ getPrimaryUsesWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateCreate { /** * Required Must be between 0 and 255 characters */ name: string | null; /** * Required */ vendorId: number | null; /** * Required */ commodityId: number | null; /** * Must be between 0 and 255 characters */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateEdit { /** * Must be between 0 and 255 characters Required (defined) */ name: string | null | undefined; /** * Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VersionResponse { /** * */ versionId: number | null | undefined; /** * */ beginDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateResponse { /** * */ rateId: number | null | undefined; /** * */ name: string | null | undefined; /** * */ note: string | null | undefined; vendor: VendorChild | null | undefined; commodity: CommodityChild | null | undefined; /** * */ versions: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateVersionRequest { /** * Effective date for the version Required Must be between 1899-12-31 and 3000-01-01 */ effectiveDate: Date | null; /** * Note for the version Must be between 0 and 255 characters Required (defined) */ note: string | null | undefined; /** * Unit cost for the use Required when UseUnitID is set Max scale of 8 NULL Valid */ useUnitCost: number | null | undefined; /** * Use unit ID Required when UseUnitCost is set */ useUnitId: number | null | undefined; /** * Unit cost for the demand Required when DemandUnitID is set Max scale of 8 NULL Valid */ demandUnitCost: number | null | undefined; /** * Demand unit ID Required when DemandUnitCost is set */ demandUnitId: number | null | undefined; /** * Cost bodylines for the account Required (defined) */ accountLineItems: Array | null | undefined; /** * Cost bodylines for the meter Required (defined) */ meterLineItems: Array | null | undefined; /** * List of user defined/custom fields and values for this version If the Udfs list is null or empty no values are assigned If a udf is omitted no value is assigned to that udf To remove a value from an existing Udf, pass in the UdfId and set the Value to null Required (defined) */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateVersionResponse { /** * ID of the rate schedule version */ versionId: number | null | undefined; /** * Begin date for the version */ beginDate: Date | null | undefined; /** * End date for the version */ endDate: Date | null | undefined; /** * Created date */ createdDate: Date | null | undefined; /** * Last modified date */ modifiedDate: Date | null | undefined; /** * Note */ note: string | null | undefined; createdBy: UserChild | null | undefined; modifiedBy: UserChild | null | undefined; /** * Unit cost for the use */ useUnitCost: number | null | undefined; useUnit: UnitChild | null | undefined; /** * Unit cost for the demand */ demandUnitCost: number | null | undefined; demandUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * Cost bodylines for the account */ accountLineItems: Array | null | undefined; /** * Cost bodylines for the meter */ meterLineItems: Array | null | undefined; /** * List of user defined/custom fields and values for this version */ udfs: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UnitResponse { /** * */ unitId: number | null | undefined; /** * */ unitCode: string | null | undefined; /** * */ unitInfo: string | null | undefined; unitType: UnitType | null | undefined; } declare class RateService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a rate schedule * * @param body The properties of the rate schedule to be created */ createRate(body?: RateCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a rate schedule version * Allows the user to create a new version for a rate schedule for use in chargeback scenarios where use or demand cost for calculated bills must be created from a predefined unit cost. ### Validation * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Inserting a rate version before an existing version will set the new version's end date to the effective date of the subsequent version. * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule to receive the new version * @param body The properties of the rate schedule version to be created */ createRateVersion(rateId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a rate schedule * * @param rateId Unique identifier of the rate schedule to be deleted */ deleteRate(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a version of a rate schedule * ### Validation * The last remaining rate version may not be deleted ### Other Remarks * When a rate version is deleted, if there is a preceding rate version, then its end date will be reset to the end date of the deleted rate version. * @param rateId Unique identifier of the rate schedule to which the version being deleted belongs * @param versionId Unique identifier of the rate schedule version to delete */ deleteRateVersion(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a rate custom field * * @param rateId * @param versionId * @param udfId */ downloadRateCustomFieldFile(rateId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a rate * * @param rateId Unique identifier of the rate schedule to be edited * @param body Updated properties of the rate schedule to be edited */ editRate(rateId: number, body?: RateEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a rate schedule version * ### Validation * Effective date of the edited version * Must be after the effective date of the previous version * Must be prior to the effective date of the next version * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule whose version will be edited * @param versionId Unique identifier of the rate schedule version to be edited * @param body Updated properties of the rate schedule version to be edited */ editRateVersion(rateId: number, versionId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a rate schedule * * @param rateId Unique ID of the rate schedule */ getRate(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the unit used by a rate. The unit is determined by the usage unit on the most recent template assigned to a meter with the given rate. * * @param rateId Unique identifier of the rate schedule for which the unit will be retrieved */ getRateUnit(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a rate version with its details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve * @param versionId ID of the rate schedule version to retrieve */ getRateVersion(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve */ getRateVersions(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRates(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a rate schedule * * @param body The properties of the rate schedule to be created */ createRateWithHttpInfo(body?: RateCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a rate schedule version * Allows the user to create a new version for a rate schedule for use in chargeback scenarios where use or demand cost for calculated bills must be created from a predefined unit cost. ### Validation * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Inserting a rate version before an existing version will set the new version's end date to the effective date of the subsequent version. * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule to receive the new version * @param body The properties of the rate schedule version to be created */ createRateVersionWithHttpInfo(rateId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a rate schedule * * @param rateId Unique identifier of the rate schedule to be deleted */ deleteRateWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a version of a rate schedule * ### Validation * The last remaining rate version may not be deleted ### Other Remarks * When a rate version is deleted, if there is a preceding rate version, then its end date will be reset to the end date of the deleted rate version. * @param rateId Unique identifier of the rate schedule to which the version being deleted belongs * @param versionId Unique identifier of the rate schedule version to delete */ deleteRateVersionWithHttpInfo(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a rate custom field * * @param rateId * @param versionId * @param udfId */ downloadRateCustomFieldFileWithHttpInfo(rateId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a rate * * @param rateId Unique identifier of the rate schedule to be edited * @param body Updated properties of the rate schedule to be edited */ editRateWithHttpInfo(rateId: number, body?: RateEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a rate schedule version * ### Validation * Effective date of the edited version * Must be after the effective date of the previous version * Must be prior to the effective date of the next version * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule whose version will be edited * @param versionId Unique identifier of the rate schedule version to be edited * @param body Updated properties of the rate schedule version to be edited */ editRateVersionWithHttpInfo(rateId: number, versionId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a rate schedule * * @param rateId Unique ID of the rate schedule */ getRateWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the unit used by a rate. The unit is determined by the usage unit on the most recent template assigned to a meter with the given rate. * * @param rateId Unique identifier of the rate schedule for which the unit will be retrieved */ getRateUnitWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a rate version with its details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve * @param versionId ID of the rate schedule version to retrieve */ getRateVersionWithHttpInfo(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve */ getRateVersionsWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRatesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateDigestActualYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateDigestActualYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateDigestActualYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateDigestActualYearlyResponse { /** * The rate name */ name: string | null | undefined; /** * The rate identifier */ rateId: number | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } declare class RateDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data by rate for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param rateId The rate to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getRateActualYearly(rateId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by rate for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param rateId The rate to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getRateActualYearlyWithHttpInfo(rateId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmailProperties { /** * Required */ subject: string | null; /** * */ body: string | null | undefined; /** * Cannot be Empty */ recipients: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributedReportsConfiguration { /** * Desired format for the resulting report. Available options are PDF, Excel, Excel formatted, Excel data only, Word, and CSV. Support for each format varies by report. */ format: string | null | undefined; /** * Indicates whether or not to use a copy of the report when generating it. When set to true, a one-time copy of the requested specific report will be created, set with the provided filters, and then deleted afterward. This functionality is useful when you want to run a report with a one-time filter set, without touching the original report's filters. */ useCopy: boolean | null | undefined; /** * List of filters to use when executing this report. How they are handled depends upon the other configuration options used in this request. */ filters: Array | null | undefined; /** * Indicates whether or not to clear out stored filters for the requested report during execution. When set to true, any stored filters for this report will be removed. Only filters provided in the Filters property will be applied. When set to false, any stored filters will still apply when the report is executed. */ clearFilters: boolean | null | undefined; /** * Indicates whether or not to save the filters provided in the Filters property. When set to true, any filters currently stored for the requested report will be overwritten with those provided in the Filters property. When set to false, any filters provided in the Filters property will not be saved after execution. However, they will be used for this report execution. */ saveFilters: boolean | null | undefined; /** * Indicates whether or not to email a report if it contains no data. When set to true, if distributing the requested report to an email list and the report contains no data, the report will not be emailed. When set to false, if the requested report has no data, it will still be sent to the email list. */ onlySendIfData: boolean | null | undefined; /** * Filename for the resulting report file. Do not provide file type suffix. Defaults to {specificReportCode}-{specificReportInfo}{fileNameExtension} */ fileName: string | null | undefined; distribution: EmailProperties | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OkResult { /** * */ statusCode: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class QuickReport { /** * Report code of the report to execute */ reportCode: string | null | undefined; /** * File name that the report file will receive */ fileName: string | null | undefined; /** * Desired format for the resulting report. Available options are PDF, Excel, Excel formatted, Excel data only, Word, and CSV. Support for each format varies by report. */ format: string | null | undefined; /** * The filters to apply to this execution of the report. They will not be saved, and stored filters will not be honored. */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportCreate { /** * New specific report code Required Must be between 0 and 255 characters */ reportCode: string | null; /** * New specific report name Required Must be between 0 and 255 characters */ reportInfo: string | null; /** * New specific report description Required */ reportDescription: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportEdit { /** * New specific report code Required Must be between 0 and 16 characters */ reportCode: string | null; /** * New specific report name Required Must be between 0 and 255 characters */ reportInfo: string | null; /** * New specific report description Required */ reportDescription: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportGroupRequest { /** * */ reportGroupCode: string | null | undefined; /** * */ reportGroupInfo: string | null | undefined; /** * */ reportIds: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportFormatChild { /** * */ exportFormatInfo: string | null | undefined; /** * */ preferred: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportType { /** * The identifier of the report type */ reportTypeId: number | null | undefined; /** * The report type code */ reportTypeCode: string | null | undefined; /** * The report type name */ reportTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TagChild { /** * */ tagTypeId: number | null | undefined; /** * */ tagTypeInfo: string | null | undefined; /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportChild { /** * The version of the report */ version: string | null | undefined; /** * The identifier of the report */ reportId: number | null | undefined; /** * The report code */ reportCode: string | null | undefined; /** * The report name */ reportInfo: string | null | undefined; reportType: ReportType | null | undefined; /** * The report description */ description: string | null | undefined; /** * Indicates whether or not the report is rendered in landscape */ isLandscape: boolean | null | undefined; /** * The last time this report was updated */ lastUpdated: Date | null | undefined; /** * Tags describing features of the report */ tags: Array | null | undefined; /** * Supported export formats (EnergyCAP currently supports PDF, Word, Excel, Excel data only, Excel formatted, and CSV) */ exportFormats: Array | null | undefined; /** * The rendering engine used for the report (EnergyCAP currently uses SSRS and Crystal) */ reportSource: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportGroupResponse { /** * */ reportGroupId: number | null | undefined; /** * */ reportGroupCode: string | null | undefined; /** * */ reportGroupInfo: string | null | undefined; /** * */ reports: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportSubscriptionRequest { /** * The subject line of the email Must be between 0 and 255 characters Required */ emailSubject: string | null; /** * The body of the email Required */ emailMessage: string | null; /** * The schedule type of the report Values may be: Daily: 1 Weekly: 2 Monthly: 3 Quarterly: 4 Required One of '1', '2', '3', '4' Case sensitive */ reportSubscriptionScheduleTypeId: number | null; /** * Indicates when to send the report for the given schedule type Values may be: Daily: 0 Weekly: Day of Week - 0 (Sunday) to 6 (Saturday) Monthly: Day of Month - 1 to 28 Quarterly: Month in Quarter - 1, 2, or 3 Must be between 0 and 28 Required */ dayIndicatorValue: number | null; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. Required */ onlySendIfData: boolean | null; /** * The format in which the generated report should be downloaded Required One of 'Excel', 'Excel data only', 'Csv', 'PDF', 'Word' */ reportFormat: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportSubscriptionDayIndicatorChild { /** * Indicates when to send the report for the given schedule type Values may be: Daily: 0 Weekly: Day of Week - 0 (Sunday) to 6 (Saturday) Monthly: Day of Month - 1 to 28 Quarterly: Month in Quarter - 1, 2, or 3 */ dayIndicatorValue: number | null | undefined; /** * Name of the day indicator Daily: None Weekly: One of Sunday to Saturday Monthly: One of 1 to 28 Quarterly: 1st day of month 1 of calendar quarter, 1st day of month 2 of calendar quarter, 1st day of month 3 of calendar quarter */ dayIndicatorInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportSubscriptionScheduleTypeResponse { /** * The identifier of the schedule type */ reportSubscriptionScheduleTypeId: number | null | undefined; /** * The name of the schedule type */ reportSubscriptionScheduleTypeName: string | null | undefined; /** * Available day indicators for this schedule type */ dayIndicators: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RelatedReportResponse { /** * Specific report id of the related report */ specificReportId: number | null | undefined; /** * Name of the related report */ name: string | null | undefined; /** * Description of the related report */ description: string | null | undefined; /** * The rendering engine used for the report (EnergyCAP currently uses SSRS and Crystal) */ reportSource: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportCategoryChild { /** * */ reportCategoryId: number | null | undefined; /** * */ reportCategoryCode: string | null | undefined; /** * */ reportCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportSubscriptionScheduleTypeChild { /** * The identifier of the subscription schedule type */ reportSubscriptionScheduleTypeId: number | null | undefined; /** * The name of the subscription schedule type */ reportSubscriptionScheduleTypeName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportSubscriptionChild { /** * The identifier of the report subscription */ reportSubscriptionId: number | null | undefined; user: UserChild | null | undefined; /** * The email address to send the report to */ emailRecipient: string | null | undefined; /** * The subject line of the email */ emailSubject: string | null | undefined; /** * The body of the email */ emailMessage: string | null | undefined; /** * Format of the report (EnergyCAP currently supports PDF, Word, Excel, and CSV) */ reportFormat: string | null | undefined; scheduleType: ReportSubscriptionScheduleTypeChild | null | undefined; dayIndicator: ReportSubscriptionDayIndicatorChild | null | undefined; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. */ onlySendIfData: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecificReportResponse { /** * Unique identifier for the report */ specificReportId: number | null | undefined; baseReport: ReportChild | null | undefined; /** * Report code */ specificReportCode: string | null | undefined; /** * Report name */ specificReportInfo: string | null | undefined; /** * Last time this report was run */ lastViewed: Date | null | undefined; /** * Indicates if this is a recommended report */ recommended: boolean | null | undefined; reportCategory: ReportCategoryChild | null | undefined; /** * The report description */ description: string | null | undefined; /** * Indicates if this report is visible to the current user */ visible: boolean | null | undefined; /** * Indicates if this report is shared */ shared: boolean | null | undefined; user: UserChild | null | undefined; subscription: ReportSubscriptionChild | null | undefined; /** * List of reports related to this report */ relatedReports: Array | null | undefined; } declare class ReportService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param body */ createReportGroup(body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Subscribe to a report and receive scheduled emails This must be a saved report that belongs to or is shared with the current user Only SSRS reports are supported * * @param specificReportId * @param body */ createReportSubscription(specificReportId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Save a specific report to Saved Reports * * @param specificReportId The specific report to save * @param body The specific report create properties */ createSpecificReport(specificReportId: number, body?: ReportCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a Report Group * * @param reportGroupId */ deleteReportGroup(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId */ deleteReportSubscription(specificReportId: number, reportSubscriptionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param specificReportId */ deleteSpecificReport(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Execute a report, save it in a given format, and email it to a list of recipients. If distributing reports, returns a 204 No Content if onlySendIfData is set to True and the report generated no data; returns a 200 and the generated report for download or an empty body if onlySendIfData is set to True * * @param specificReportId The ID of the specific report to run * @param body Allows the user to run one report and optionally email it to one or more recipients. They can optionally specify whether or not the report(s) should be sent if they contain no data. */ distributeReport(specificReportId: number, body?: DistributedReportsConfiguration, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be edited * @param body The list of filters to apply */ editReportFilters(specificReportId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param reportGroupId * @param body */ editReportGroup(reportGroupId: number, body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId * @param body */ editReportSubscription(specificReportId: number, reportSubscriptionId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a specific report * * @param specificReportId The specific report to edit * @param body The specific report edit properties */ editSpecificReport(specificReportId: number, body?: ReportEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be retrieved */ getReportFilters(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param reportGroupId */ getReportGroup(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ getReportGroups(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get sharing information for a report * Only the user who created the report or a report administrator is permitted to get sharing details for a report. * @param specificReportId The specific report for which to retrieve sharing information */ getReportSharingDetails(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all available report subscription schedule types, and their day indicator values * */ getReportSubscriptionScheduleTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a report by its specificReportID. * * @param specificReportId */ getSpecificReport(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a filterable list of installed, saved, and shared reports available to the current user. * * @param filter */ getSpecificReports(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * */ installReports(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Execute and email report subscriptions that are ready to be run * */ processReportSubscriptions(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generates a \"quick report\" in the specified export format (or in its preferred export format if not specified) as identified by the provided report code and applying ONLY the filters supplied. * * @param body */ runQuickReport(body?: QuickReport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run a report and download in the provided format * * @param specificReportId The ID of the specific report to run * @param format The format in which the generated report should be downloaded. Supported options are [\"excel\", \"csv\", \"pdf\", \"word\"] */ runReport(specificReportId: number, format?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Share a saved report with other users * * @param specificReportId ID of the saved report to share * @param body Updated sharing details for the report */ shareSavedReport(specificReportId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the visibility of a report for the current user This must be a report you can see Which means you must have created the report or have ReportAdministrator Manage permission and the report is shared at all or have SharedReports View permission and the report is shared with you * * @param specificReportId Specific dashboard * @param body Set Visibility */ toggleSharedReportVisibility(specificReportId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ createReportGroupWithHttpInfo(body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Subscribe to a report and receive scheduled emails This must be a saved report that belongs to or is shared with the current user Only SSRS reports are supported * * @param specificReportId * @param body */ createReportSubscriptionWithHttpInfo(specificReportId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Save a specific report to Saved Reports * * @param specificReportId The specific report to save * @param body The specific report create properties */ createSpecificReportWithHttpInfo(specificReportId: number, body?: ReportCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a Report Group * * @param reportGroupId */ deleteReportGroupWithHttpInfo(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId */ deleteReportSubscriptionWithHttpInfo(specificReportId: number, reportSubscriptionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param specificReportId */ deleteSpecificReportWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Execute a report, save it in a given format, and email it to a list of recipients. If distributing reports, returns a 204 No Content if onlySendIfData is set to True and the report generated no data; returns a 200 and the generated report for download or an empty body if onlySendIfData is set to True * * @param specificReportId The ID of the specific report to run * @param body Allows the user to run one report and optionally email it to one or more recipients. They can optionally specify whether or not the report(s) should be sent if they contain no data. */ distributeReportWithHttpInfo(specificReportId: number, body?: DistributedReportsConfiguration, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be edited * @param body The list of filters to apply */ editReportFiltersWithHttpInfo(specificReportId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param reportGroupId * @param body */ editReportGroupWithHttpInfo(reportGroupId: number, body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId * @param body */ editReportSubscriptionWithHttpInfo(specificReportId: number, reportSubscriptionId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a specific report * * @param specificReportId The specific report to edit * @param body The specific report edit properties */ editSpecificReportWithHttpInfo(specificReportId: number, body?: ReportEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be retrieved */ getReportFiltersWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param reportGroupId */ getReportGroupWithHttpInfo(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * */ getReportGroupsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get sharing information for a report * Only the user who created the report or a report administrator is permitted to get sharing details for a report. * @param specificReportId The specific report for which to retrieve sharing information */ getReportSharingDetailsWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available report subscription schedule types, and their day indicator values * */ getReportSubscriptionScheduleTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a report by its specificReportID. * * @param specificReportId */ getSpecificReportWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a filterable list of installed, saved, and shared reports available to the current user. * * @param filter */ getSpecificReportsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * */ installReportsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Execute and email report subscriptions that are ready to be run * */ processReportSubscriptionsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generates a \"quick report\" in the specified export format (or in its preferred export format if not specified) as identified by the provided report code and applying ONLY the filters supplied. * * @param body */ runQuickReportWithHttpInfo(body?: QuickReport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run a report and download in the provided format * * @param specificReportId The ID of the specific report to run * @param format The format in which the generated report should be downloaded. Supported options are [\"excel\", \"csv\", \"pdf\", \"word\"] */ runReportWithHttpInfo(specificReportId: number, format?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Share a saved report with other users * * @param specificReportId ID of the saved report to share * @param body Updated sharing details for the report */ shareSavedReportWithHttpInfo(specificReportId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the visibility of a report for the current user This must be a report you can see Which means you must have created the report or have ReportAdministrator Manage permission and the report is shared at all or have SharedReports View permission and the report is shared with you * * @param specificReportId Specific dashboard * @param body Set Visibility */ toggleSharedReportVisibilityWithHttpInfo(specificReportId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class ReportBuilderService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param kql * @param offset */ query(kql?: string, offset?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param kql * @param offset */ queryWithHttpInfo(kql?: string, offset?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionCreateRequest { /** * The id of the report to distribute A new copy of the report will be created for the distribution with the filters specified in this request Any changes to the existing report will not effect the distribution copy Only SSRS reports are supported Required */ specificReportId: number | null; /** * The name of the report distribution Must be between 0 and 255 characters Required */ reportDistributionName: string | null; /** * List of filters to apply to the report Required */ reportFilters: Array | null; /** * The email address the receiver should reply to Must be between 0 and 128 characters */ replyToEmail: string | null | undefined; /** * The id of each user group that should receive the report Cannot be Empty Required */ recipientUserGroupIds: Array | null; /** * The subject line of the email Must be between 0 and 255 characters Required */ emailSubject: string | null; /** * The body of the email Required */ emailMessage: string | null; /** * The schedule type of the report Values may be: Daily: 1 Weekly: 2 Monthly: 3 Quarterly: 4 Required One of '1', '2', '3', '4' Case sensitive */ reportSubscriptionScheduleTypeId: number | null; /** * Indicates when to send the report for the given schedule type Values may be: Daily: 0 Weekly: Day of Week - 0 (Sunday) to 6 (Saturday) Monthly: Day of Month - 1 to 28 Quarterly: Month in Quarter - 1, 2, or 3 Must be between 0 and 28 Required */ dayIndicatorValue: number | null; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. Required */ onlySendIfData: boolean | null; /** * The format in which the generated report should be downloaded Required One of 'Excel', 'Excel data only', 'Csv', 'PDF', 'Word' */ reportFormat: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionEmailSettings { /** * The email address the receiver should reply to */ replyToEmail: string | null | undefined; /** * The list of user groups that should receive the report */ recipientUserGroups: Array | null | undefined; /** * The subject line of the email */ emailSubject: string | null | undefined; /** * The body of the email */ emailMessage: string | null | undefined; /** * Format of the report (EnergyCAP currently supports PDF, Word, Excel, and CSV) */ reportFormat: string | null | undefined; scheduleType: ReportSubscriptionScheduleTypeChild | null | undefined; dayIndicator: ReportSubscriptionDayIndicatorChild | null | undefined; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. */ onlySendIfData: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionDetailsResponse { /** * The id of the report distribution */ reportDistributionId: number | null | undefined; /** * The name of the report distribution */ reportDistributionName: string | null | undefined; createdByUser: UserChild | null | undefined; /** * The date and time the report distribution was created */ createdDate: Date | null | undefined; modifiedByUser: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * Last time the report distribution was run */ lastRunDate: Date | null | undefined; /** * Next time the report distribution will run */ nextRunDate: Date | null | undefined; /** * Indicates if the report distribution is currently enabled */ enabled: boolean | null | undefined; /** * The id of the report being distributed */ specificReportId: number | null | undefined; baseReport: ReportChild | null | undefined; emailSettings: ReportDistributionEmailSettings | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionEditRequest { /** * Indicates if the report distribution is currently enabled Required */ enabled: boolean | null; /** * The name of the report distribution Must be between 0 and 255 characters Required */ reportDistributionName: string | null; /** * List of filters to apply to the report Required */ reportFilters: Array | null; /** * The email address the receiver should reply to Must be between 0 and 128 characters Required (defined) */ replyToEmail: string | null | undefined; /** * The id of each user group that should receive the report Cannot be Empty Required */ recipientUserGroupIds: Array | null; /** * The subject line of the email Must be between 0 and 255 characters Required */ emailSubject: string | null; /** * The body of the email Required */ emailMessage: string | null; /** * The schedule type of the report Values may be: Daily: 1 Weekly: 2 Monthly: 3 Quarterly: 4 Required One of '1', '2', '3', '4' Case sensitive */ reportSubscriptionScheduleTypeId: number | null; /** * Indicates when to send the report for the given schedule type Values may be: Daily: 0 Weekly: Day of Week - 0 (Sunday) to 6 (Saturday) Monthly: Day of Month - 1 to 28 Quarterly: Month in Quarter - 1, 2, or 3 Must be between 0 and 28 Required */ dayIndicatorValue: number | null; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. Required */ onlySendIfData: boolean | null; /** * The format in which the generated report should be downloaded Required One of 'Excel', 'Excel data only', 'Csv', 'PDF', 'Word' */ reportFormat: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserChildWithEmail { /** * Email ID of the user */ email: string | null | undefined; /** * The user identifier */ userId: number | null | undefined; /** * The user code */ userCode: string | null | undefined; /** * The user's full name */ fullName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserGroupWithMembers { /** * List of user group members */ members: Array | null | undefined; /** * The user group identifier */ userGroupId: number | null | undefined; /** * The user group name */ userGroupName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionLogEmailSettings { /** * The email address the the email was sent from */ sentFromEmail: string | null | undefined; /** * The list of user groups with members that should receive the report */ recipientUserGroups: Array | null | undefined; /** * The email address the receiver should reply to */ replyToEmail: string | null | undefined; /** * The subject line of the email */ emailSubject: string | null | undefined; /** * The body of the email */ emailMessage: string | null | undefined; /** * Format of the report (EnergyCAP currently supports PDF, Word, Excel, and CSV) */ reportFormat: string | null | undefined; scheduleType: ReportSubscriptionScheduleTypeChild | null | undefined; dayIndicator: ReportSubscriptionDayIndicatorChild | null | undefined; /** * Indicates whether or not to email a report if it contains no data. When set to true, the subscribed report will not be emailed, if the report does not contain data. When set to false, if the requested report has no data, it will still be sent. */ onlySendIfData: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionLogReportSettings { baseReport: ReportChild | null | undefined; /** * List of filters to apply to the report */ reportFilters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionLogDetailsResponse { emailSettings: ReportDistributionLogEmailSettings | null | undefined; reportSettings: ReportDistributionLogReportSettings | null | undefined; /** * Detailed errors that may have occurred during report distribution run */ errors: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionChild { /** * The id of the report distribution */ reportDistributionId: number | null | undefined; /** * The name of the report distribution */ reportDistributionName: string | null | undefined; /** * The report code to run as part of the report distribution */ reportCode: string | null | undefined; createdByUser: UserChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportDistributionLogResponse { /** * The report distribution log identifier */ reportDistributionLogId: number | null | undefined; reportDistribution: ReportDistributionChild | null | undefined; /** * The date and time the report distribution was started */ beginDate: Date | null | undefined; /** * The date and time the report distribution was completed */ endDate: Date | null | undefined; /** * The status of the report distribution Possible values - In Progress, Complete, Not sent, Some reports not sent */ status: string | null | undefined; /** * The number of unique recipients for the report If a user is a member of multiple groups assigned to the report distribution they will only be counted once */ numberOfRecipients: number | null | undefined; } declare class ReportDistributionService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a Report Distribution * * @param body Data representing the report distribution being created */ createReportDistribution(body?: ReportDistributionCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a Report Distribution * * @param reportDistributionId Id of the report distribution to delete */ deleteReportDistribution(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete report distribution logs older than the number of days provided only if the number of logs per distribution is in excess of 100. 100 latest logs per distribution will always be maintained * * @param olderThanDays Defaults to 3 */ deleteReportDistributionLogsOlderThan(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a Report Distribution * * @param reportDistributionId Id of the report distribution to edit * @param body Data representing the report distribution being edited */ editReportDistribution(reportDistributionId: number, body?: ReportDistributionEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run a report distribution and send the report out immediately This does not affect the current distribution schedule * * @param reportDistributionId Id of the report distribution to run * @param overrideUserIds List of systemuserIds to send the distribution to. If not provided the currently configured recipients will receive the report. If this is provided it is used in place of the currently configured recipients */ executeReportDistribution(reportDistributionId: number, overrideUserIds?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a Report Distribution * * @param reportDistributionId Id of the report distribution to get */ getReportDistribution(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a Report Distribution Filters * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionFilters(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the details for a report distribution log * * @param reportDistributionLogId Id of the report distribution log to get the details for */ getReportDistributionLogDetails(reportDistributionLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of report distribution logs * * @param includeInProgress Option to include in progress distributions. False by default */ getReportDistributionLogs(includeInProgress?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all Report Distributions * * @param filter */ getReportDistributions(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run all report distributions Sends reports based on configured schedule DistributedReportSettings - Manage permission required. * */ runReportDistributions(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a Report Distribution * * @param body Data representing the report distribution being created */ createReportDistributionWithHttpInfo(body?: ReportDistributionCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a Report Distribution * * @param reportDistributionId Id of the report distribution to delete */ deleteReportDistributionWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete report distribution logs older than the number of days provided only if the number of logs per distribution is in excess of 100. 100 latest logs per distribution will always be maintained * * @param olderThanDays Defaults to 3 */ deleteReportDistributionLogsOlderThanWithHttpInfo(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a Report Distribution * * @param reportDistributionId Id of the report distribution to edit * @param body Data representing the report distribution being edited */ editReportDistributionWithHttpInfo(reportDistributionId: number, body?: ReportDistributionEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run a report distribution and send the report out immediately This does not affect the current distribution schedule * * @param reportDistributionId Id of the report distribution to run * @param overrideUserIds List of systemuserIds to send the distribution to. If not provided the currently configured recipients will receive the report. If this is provided it is used in place of the currently configured recipients */ executeReportDistributionWithHttpInfo(reportDistributionId: number, overrideUserIds?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Report Distribution * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Report Distribution Filters * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionFiltersWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the details for a report distribution log * * @param reportDistributionLogId Id of the report distribution log to get the details for */ getReportDistributionLogDetailsWithHttpInfo(reportDistributionLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of report distribution logs * * @param includeInProgress Option to include in progress distributions. False by default */ getReportDistributionLogsWithHttpInfo(includeInProgress?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all Report Distributions * * @param filter */ getReportDistributionsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Run all report distributions Sends reports based on configured schedule DistributedReportSettings - Manage permission required. * */ runReportDistributionsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Class derived from MeterChildIncludePlaceDTO - has this meter's serial number /// */ declare class MeterChildIncludePlaceAndSerialNumber { parentPlace: PlaceChild | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteDetailsResponse { /** * The meters assigned to this route */ meters: Array | null | undefined; /** * The number of meters assigned to this route */ numberOfMeters: number | null | undefined; /** * The route identifier */ routeId: number | null | undefined; /** * The route info */ routeInfo: string | null | undefined; /** * The route code */ routeCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteMeter { /** * The identifier for the meter Required */ meterId: number | null; /** * The display order for this route meter */ displayOrder: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReadingChildBase { /** * The unique ID of the reading */ observationId: number | null | undefined; /** * The date and time of the reading */ time: Date | null | undefined; /** * The value of the reading */ value: number | null | undefined; /** * Indicates if the reading is estimated */ estimated: boolean | null | undefined; /** * A note pertaining to the reading */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChannelLatestReading { observationType: ObservationTypeChildBase | null | undefined; lastReading: ReadingChildBase | null | undefined; /** * The channel identifier */ channelId: number | null | undefined; /** * The channel interval in seconds. Monthly = 2592000 Weekly = 604800 Daily = 86400 Hourly = 3600 Thirty_Minutes = 1800 Fifteen_Minutes = 900 */ interval: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Class derived from MeterChildIncludePlaceDTO - has this meter's channels with latest reading /// */ declare class MeterChildIncludePlaceChannelLatestReading { /** * List of channels with their latest reading */ channels: Array | null | undefined; parentPlace: PlaceChild | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteMeterChannelLatestReadingResponse { /** * List of meters with channels and their latest reading */ meters: Array | null | undefined; /** * The route identifier */ routeId: number | null | undefined; /** * The route info */ routeInfo: string | null | undefined; /** * The route code */ routeCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteRequest { /** * The route info Must be between 0 and 32 characters Required */ routeInfo: string | null; /** * The route code This property has been deprecated. Route code will be generated from the value in route info Must be between 0 and 16 characters */ routeCode: string | null | undefined; /** * The list of IDs for meters to be assigned to the route. The order in which the meter IDs appear will determine their order on the route. NOTE: if the same meter ID is passed in multiple times, the first occurrence of the meter ID will be used to determine the order on the route Required */ meterIds: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RouteResponse { /** * The number of meters assigned to this route */ numberOfMeters: number | null | undefined; /** * The route identifier */ routeId: number | null | undefined; /** * The route info */ routeInfo: string | null | undefined; /** * The route code */ routeCode: string | null | undefined; } declare class RouteService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Adds a meter to a route * * @param routeId The identifier for the route to add the meters to * @param body Object representing meter to add to the route */ addMeter(routeId: number, body?: RouteMeter, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new route and assigns a group of meters to it * * @param body Data representing the route being created */ createRoute(body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a route * * @param id The identifier for the route being deleted */ deleteRoute(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a route * * @param id The identifier for the route being edited * @param body Data representing the route being edited */ editRoute(id: number, body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one route * * @param id The identifier for route being retrieved */ getRoute(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one route and all the meters on that route The meters are ordered by display order * * @param id The identifier for route being retrieved */ getRouteDetails(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all routes * */ getRoutes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of routes with their list of meters and a list of channels on each meter with the latest reading Meters are returned in order they appear on a route If the interval filter is passed and no channels match the filter, the route is not included in the response. * * @param filter */ getRoutesWithMetersChannelsLatestReading(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Removes a meter from a route * * @param routeId The identifier for the route the meter is being remove from * @param meterId The identifier for the meter being removed */ removeMeter(routeId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Adds a meter to a route * * @param routeId The identifier for the route to add the meters to * @param body Object representing meter to add to the route */ addMeterWithHttpInfo(routeId: number, body?: RouteMeter, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new route and assigns a group of meters to it * * @param body Data representing the route being created */ createRouteWithHttpInfo(body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a route * * @param id The identifier for the route being deleted */ deleteRouteWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a route * * @param id The identifier for the route being edited * @param body Data representing the route being edited */ editRouteWithHttpInfo(id: number, body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one route * * @param id The identifier for route being retrieved */ getRouteWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one route and all the meters on that route The meters are ordered by display order * * @param id The identifier for route being retrieved */ getRouteDetailsWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all routes * */ getRoutesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of routes with their list of meters and a list of channels on each meter with the latest reading Meters are returned in order they appear on a route If the interval filter is passed and no channels match the filter, the route is not included in the response. * * @param filter */ getRoutesWithMetersChannelsLatestReadingWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Removes a meter from a route * * @param routeId The identifier for the route the meter is being remove from * @param meterId The identifier for the meter being removed */ removeMeterWithHttpInfo(routeId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AdjustedCostTypeResponse { /** * Adjusted Cost Type identifier */ adjustedCostTypeId: number | null | undefined; /** * Adjusted Cost Type code */ adjustedCostTypeCode: string | null | undefined; /** * Adjusted Cost Type name */ adjustedCostTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AucRangeRequest { /** * The unique identifier for the commodity Required (defined) */ commodityId: number | null | undefined; /** * When the current bill's average unit cost is LOWER than this multiplier x the baseline bill's average unit cost, then the cost avoidance processor will use the average unit cost from the baseline bill instead of the current bill Must be between 0.1 and 20.0 Required (defined) */ lowerLimitMultiplier: number | null | undefined; /** * When the current bill's average unit cost is HIGHER than this multiplier x the baseline bill's average unit cost, then the cost avoidance processor will use the average unit cost from the baseline bill instead of the current bill Must be greater than LowerLimitMultiplier Must be between 0.1 and 20.0 Required (defined) */ upperLimitMultiplier: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AucRangeResponse { /** * Unique identifier for the commodity's average unit cost range */ commodityCapId: number | null | undefined; commodity: CommodityChild | null | undefined; /** * When the current bill's average unit cost is LOWER than this multiplier x the baseline bill's average unit cost, then the cost avoidance processor will use the average unit cost from the baseline bill instead of the current bill */ lowerLimitMultiplier: number | null | undefined; /** * When the current bill's average unit cost is HIGHER than this multiplier x the baseline bill's average unit cost, then the cost avoidance processor will use the average unit cost from the baseline bill instead of the current bill */ upperLimitMultiplier: number | null | undefined; /** * Indicates whether or not this commodity is used; i.e. there are meters that have been created with this commodity which are included in cost avoidance */ isUsed: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineProcessorRequestBaselineBill { /** * The identifier of the baseline bill */ billId: number | null | undefined; /** * Indicates if the bill should be included in the baseline regression */ isExcluded: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineProcessorRequest { /** * Indicates if the meter will be included in savings calculations */ includeInCAP: boolean | null | undefined; /** * Indicates if floor area adjustments should be made */ adjustArea: boolean | null | undefined; /** * The type of cost adjustment to perform. Possible values include 1 (current average unit cost) and 5 (net cost difference) */ adjustedCostTypeId: number | null | undefined; /** * Indicates if winter weather adjustments should be made */ adjustWinter: boolean | null | undefined; /** * Indicates if summer weather adjustments should be made */ adjustSummer: boolean | null | undefined; /** * The number of months in the baseline. Setting this to anything other than 12 will turn off weather adjustments irregardless of the settings in adjustWinter and adjustSummer */ baselineMonths: number | null | undefined; /** * The baseline's start date */ baselineStartDate: Date | null | undefined; /** * The savings period's start date */ savingsStartDate: Date | null | undefined; /** * The cooling balance point */ coolingTemp: number | null | undefined; /** * The heating balance point */ heatingTemp: number | null | undefined; /** * Indicates if extended weather should be used. Extended weather uses additional months prior to the baseline start date to determine weather sensitivity. */ useExtendedWeather: boolean | null | undefined; /** * The start date of the extended weather. This should be 1, 2 or 3 years prior to the baseline start date. Extended weather uses additional months prior to the baseline start date to determine weather sensitivity. */ extendedWeatherStartDate: Date | null | undefined; /** * Indicates if each bill in the baseline should be included in the baseline regression */ baselineBills: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineProcessorResponseBaselineBill { /** * Unique bill identifier */ billId: number | null | undefined; /** * Average Cooling Degree Days */ avgCoolingDegreeDays: number | null | undefined; /** * Average heating Degree Days */ avgHeatingDegreeDays: number | null | undefined; /** * Bill start date */ beginDate: Date | null | undefined; /** * Bill end date */ endDate: Date | null | undefined; /** * Indicates whether or not the bill is excluded from the baseline regression */ isExcluded: boolean | null | undefined; /** * Indicates whether or not the bill is an outlier */ isOutlier: boolean | null | undefined; /** * Native use */ nativeUse: number | null | undefined; /** * Number of days in the bill */ days: number | null | undefined; /** * Calendar period name (e.g. Jan) */ periodName: string | null | undefined; /** * Calendar period number */ calendarPeriod: number | null | undefined; /** * Calendar year */ calendarYear: number | null | undefined; /** * Fiscal period */ fiscalPeriod: number | null | undefined; /** * Fiscal year */ fiscalYear: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineProcessorResponse { /** * Indicates if the meter will be included in savings calculations */ includeInCAP: boolean | null | undefined; /** * Indicates if floor area adjustments should be made */ adjustArea: boolean | null | undefined; adjustedCostType: AdjustedCostTypeResponse | null | undefined; /** * Indicates if winter weather adjustments should be made */ adjustWinter: boolean | null | undefined; /** * Indicates if summer weather adjustments should be made */ adjustSummer: boolean | null | undefined; /** * Number of months in the baseline Setting this to anything other than 12 will turn off weather adjustments irregardless of the settings in adjustWinter and adjustSummer */ baselineMonths: number | null | undefined; /** * Baseline start date */ baselineStartDate: Date | null | undefined; /** * Savings Period start date */ savingsStartDate: Date | null | undefined; /** * Indicates if extended weather should be used. Extended weather uses additional months prior to the baseline start date to determine weather sensitivity. */ useExtendedWeather: boolean | null | undefined; /** * Start Date of the extended weather. This should be 1, 2 or 3 years prior to the baseline start date. Extended weather uses additional months prior to the baseline start date to determine weather sensitivity. */ extendedWeatherStartDate: Date | null | undefined; /** * Cooling balance point */ coolingTemp: number | null | undefined; /** * Cooling intercept */ coolingIntercept: number | null | undefined; /** * Cooling max Degree Days */ coolingMaxDegreeDays: number | null | undefined; /** * Cooling max use */ coolingMaxUse: number | null | undefined; /** * Cooling R2 */ coolingR2: number | null | undefined; /** * Adjusted Cooling R2 */ adjustedCoolingR2: number | null | undefined; /** * Cooling minimum R2 */ coolingMinR2: number | null | undefined; /** * Cooling calculated R2 */ coolingCalculatedR2: number | null | undefined; /** * Cooling slope */ coolingSlope: number | null | undefined; /** * Cooling standard deviation */ coolingStdDev: number | null | undefined; /** * Cooling CVRMSE */ coolingCVRMSE: number | null | undefined; /** * Cooling NDB */ coolingNDB: number | null | undefined; /** * Cooling standard error */ coolingStandardError: number | null | undefined; /** * Cooling base T-stat */ coolingBaseTStat: number | null | undefined; /** * Cooling weather T-stat */ coolingWeatherTStat: number | null | undefined; /** * Cooling FSU */ coolingFSU: number | null | undefined; /** * Heating balance point */ heatingTemp: number | null | undefined; /** * Heating intercept */ heatingIntercept: number | null | undefined; /** * Heating maximum Degree Days */ heatingMaxDegreeDays: number | null | undefined; /** * Heating maximum use */ heatingMaxUse: number | null | undefined; /** * Heating R2 */ heatingR2: number | null | undefined; /** * */ adjustedHeatingR2: number | null | undefined; /** * Heating minimum R2 */ heatingMinR2: number | null | undefined; /** * Heating calculated R2 */ heatingCalculatedR2: number | null | undefined; /** * Heating slope */ heatingSlope: number | null | undefined; /** * Heating standard deviation */ heatingStdDev: number | null | undefined; /** * Heating CVRMSE */ heatingCVRMSE: number | null | undefined; /** * Heating NDB */ heatingNDB: number | null | undefined; /** * Heating standard error */ heatingStandardError: number | null | undefined; /** * Heating base T-stat */ heatingBaseTStat: number | null | undefined; /** * Heating weather T-stat */ heatingWeatherTStat: number | null | undefined; /** * Heating FSU */ heatingFSU: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; /** * Indicates whether or not each bill in the baseline should be included in the baseline regression */ baselineBills: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BulkBaselineProcessorRequest { /** * Determines if weather adjustments are applied to the reprocessed baseline or not Defaults to \"false\" */ ignoreWeatherAdjustments: boolean | null | undefined; /** * Filter criteria which determine the meters whose cost avoidance baselines will be reprocessed Cannot be Empty */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BulkMeterCostAvoidanceSettings { /** * Indicates whether or not the cost avoidance processor will attempt cooling adjustments Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ attemptCoolingAdjustment: boolean | null | undefined; /** * Indicates whether or not the cost avoidance processor will attempt heating adjustments Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ attemptHeatingAdjustment: boolean | null | undefined; /** * Determines number of months of data included in the meter's cost avoidance baseline Must be between 12 and 36 Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ numBaselineMonths: number | null | undefined; /** * Determines the start date of the meter's cost avoidance baseline Must be between 1899-12-31 and 3000-01-01 Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ baselineStartDate: Date | null | undefined; /** * Determines the external temperature above which cooling is expected to take place Must be greater than or equal to HeatingNeededBelow Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ coolingNeededAbove: number | null | undefined; /** * Determines the external temperature below which heating is expected to take place Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ heatingNeededBelow: number | null | undefined; /** * Determines whether or not to include the meter in cost avoidance processing Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ includeMeterInCostAvoidance: boolean | null | undefined; /** * Determines the start date after which energy and cost savings are expected to accrue Must be between 1899-12-31 and 3000-01-01 Required (defined) At least one of AttemptCoolingAdjustment, AttemptHeatingAdjustment, NumBaselineMonths, BaselineStartDate, CoolingNeededAbove, HeatingNeededBelow, IncludeMeterInCostAvoidance, SavingsStartDate must not be null */ savingsStartDate: Date | null | undefined; /** * Filter criteria which determine the meters whose cost avoidance settings will be updated Required (defined) */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CalculateSavingsRequest { /** * Determines which option will be used to select the bills for this instance of the cost avoidance processor to process - \"AllBills\" means all bills will be processed - \"ModifiedOrNotProcessed\" means only new bills or bills which have been modified since the last time cost avoidance was run will be processed - \"BillingPeriod\" means that only bills with a billing period which is greater than or equal to the provided billing period will be processed One of 'AllBills', 'ModifiedOrNotProcessed', 'BillingPeriod' */ billSelectionOption: string | null | undefined; /** * When BillSelectionOption is 'BillingPeriod', this defines the billing period to be used to target bills for processing Valid billing period between 190001 and 300001 NULL Valid Required when BillSelectionOption is set to BillingPeriod, case sensitive. */ billingPeriod: number | null | undefined; /** * Allow the user to optionally exclude one or all special adjustments One of 'SkipAll', 'SkipOne', 'SkipNone' */ skipSpecialAdjustmentOption: string | null | undefined; /** * During cost avoidance processing, the special adjustment having the provided special adjustment type ID will not be applied (only if SkipSpecialAdjustmentOption = \"SkipOne\") Required when SkipSpecialAdjustmentOption is set to SkipOne, case sensitive. */ specialAdjustmentTypeIdToIgnore: number | null | undefined; /** * Filter criteria which determine the meters whose savings will be reprocessed */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineLog { /** * The status of baseline processing */ status: string | null | undefined; /** * Number of meters successfully processed */ successCount: number | null | undefined; /** * Number of meters processed with warning */ warningCount: number | null | undefined; /** * Number of meters processed with errors */ errorCount: number | null | undefined; /** * Number of meters to process */ numberOfMeters: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostAvoidanceSettings { /** * Only bills with a billing period greater than or equal to this value were included in Cost Avoidance processing Will be null unless BillSelectionOption is \"BillingPeriod\" and Reason is \"ProcessSavings\" */ minimumBillingPeriod: number | null | undefined; /** * Indicates if the Cost Avoidance processor skipped processing meters with multiple accounts if one of the bills was missing Will be empty unless Reason is \"ProcessSavings\" */ skippedMultiAccountIfBillsMissing: boolean | null | undefined; /** * Indicates if weather adjustments were ignored when the baseline processor was run Will be null unless Reason is \"ResetBaseline\" */ ignoredWeatherAdjustments: boolean | null | undefined; /** * Defines handling of meter special adjustments during Cost Avoidance processing. Can be either of two static values OR the special adjustment category that the user chose to skip. Will be empty unless Reason is \"ProcessSavings\" Possible static values: \"NONE\" - no special adjustment categories were skipped \"ALL\" - all special adjustment categories were skipped */ ignoredSpecialAdjustmentType: string | null | undefined; /** * For savings calculation, indicates which bills should have been processed Will be empty unless Reason is \"ProcessSavings\" Possible values: - \"AllBills\" means all bills were processed - \"ModifiedOrNotProcessed\" means only new bills or bills which have been modified since the last time cost avoidance was run have been processed - \"BillingPeriod\" means that only bills with a billing period which is greater than or equal to the MinimumBillingPeriod have been processed */ billSelectionOption: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsLog { /** * The status of savings processing */ status: string | null | undefined; /** * Number of meters successfully processed */ successCount: number | null | undefined; /** * Number of bills processed that have warnings across all meters processed A bill has a \"warning\" if it had 1) incomplete weather data or 2) exceeded the average unit cost range set for its commodity */ warningCount: number | null | undefined; /** * Number of meters processed with errors */ errorCount: number | null | undefined; /** * Number of meters to process */ numberOfMeters: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TaskType { /** * The task type identifier */ taskTypeId: number | null | undefined; /** * The code for task type */ taskTypeCode: string | null | undefined; /** * The task type information */ taskTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostAvoidanceTask { /** * Indicates whether or not the task has an output log available for download */ hasAttachments: boolean | null | undefined; /** * The task ID */ costAvoidanceTaskId: number | null | undefined; /** * The task GUID */ taskGUId: string | null | undefined; taskType: TaskType | null | undefined; /** * The date and time the task began */ beginDate: Date | null | undefined; /** * The date and time the task finished. If the task is not finished, endDate will have no value */ endDate: Date | null | undefined; user: UserChild | null | undefined; settings: CostAvoidanceSettings | null | undefined; /** * The task's filters */ filters: Array | null | undefined; /** * If there was a catastrophic error during task processing, it will go here */ message: string | null | undefined; /** * The reason for the cost avoidance task. Will be one of the following: * ResetBaseline * SavedAndReprocessedMeter * ProcessSavings * SpecialAdjustmentAddedEditedRemoved * SpecialAdjustmentAddedEditedRemovedSetupSheet * MeterCostAvoidanceSettingsGloballyUpdated * AucRangeModified * OtherSavingsAddedEdited * OtherSavingsAddedEditedSetupSheet */ reason: string | null | undefined; /** * The status of the cost avoidance task. Will be one of the following: * Processing * Complete * Error */ status: string | null | undefined; /** * Notes added to the cost avoidance task by the user */ taskNote: string | null | undefined; baselineLog: BaselineLog | null | undefined; savingsLog: SavingsLog | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GenericCount { /** * Number of items */ count: number | null | undefined; /** * A short description of the items counted */ description: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ManualAdjustmentRequest { /** * The manually adjusted Baseline Adjusted to Current Conditions (BATCC) native use Required when locked is set to True, case sensitive. */ batccNativeUse: number | null | undefined; /** * The manually adjusted Baseline Adjusted to Current Conditions (BATCC) cost Required when locked is set to True, case sensitive. */ batccCost: number | null | undefined; /** * The manual adjustment note explaining the reason for the adjustment Required */ billMtrNote: string | null; /** * Indicates whether or not the values in a savings record are locked (this is not changed by future runs of the savings processor) Set to true when a manual adjustment is being created. Set to false when a manual adjustment is being removed. If locked is set to false, all other values are ignored and will be set by the savings processor. Required */ locked: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OtherSavingsCategory { /** * Other savings category identifier */ otherSavingsCategoryId: number | null | undefined; /** * Other savings category name */ otherSavingsCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OtherSavingsCategoryRequest { /** * Other savings category name */ otherSavingsCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OtherSavingsRequest { /** * Other savings type Possible values are: one-time, continuous and recurring Required */ frequency: string | null; /** * Other savings category identifier Required */ otherSavingsCategoryId: number | null; /** * Description Required */ description: string | null; /** * Other savings start period Required */ startPeriod: number | null; /** * Other savings end period Required when frequency is set to continuous, or recurring, case sensitive. */ endPeriod: number | null | undefined; /** * Month in which the other savings should begin This should only be set when the other savings type is recurring Required when frequency is set to recurring, case sensitive. */ annualCycleStartMonth: number | null | undefined; /** * Month in which the other savings should end This should only be set when the other savings type is recurring Required when frequency is set to recurring, case sensitive. */ annualCycleEndMonth: number | null | undefined; /** * Amount saved Required */ value: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OtherSavingsResponse { /** * Other savings identifier */ otherSavingsId: number | null | undefined; /** * Other savings frequency Possible values are: one-time, continuous, and recurring */ frequency: string | null | undefined; otherSavingsCategory: OtherSavingsCategory | null | undefined; /** * Description */ description: string | null | undefined; /** * Begin period for the other savings */ startPeriod: number | null | undefined; /** * End period for the other savings */ endPeriod: number | null | undefined; /** * Month the other savings should begin This is only set when the other savings type is recurring */ annnualCycleStartMonth: number | null | undefined; /** * Month the other savings should end This is only set when the other savings type is recurring */ annualCycleEndMonth: number | null | undefined; /** * Amount saved */ value: number | null | undefined; createdBy: UserChild | null | undefined; /** * Create date */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * Last modified date */ modifiedDate: Date | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This class represents a message from the savings processor */ declare class Message { /** * Cost Avoidance message type */ messageType: string | null | undefined; /** * Cost Avoidance message */ message: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * SavingsDaily Data - a class that represents CA Savings for a given day per meter/bill */ declare class SavingsDailyData { /** * Baseline Adjusted to Current Conditions (BATCC) non-weather use in native units */ batccNonWeatherNativeUse: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) weather use in native units */ batccWeatherNativeUse: number | null | undefined; /** * Baseline non-weather Use in native units */ baselineNonWeatherNativeUse: number | null | undefined; /** * Baseline weather use in native units */ baselineWeatherNativeUse: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) cost */ batccCost: number | null | undefined; /** * Average unit cost */ averageUnitCost: number | null | undefined; /** * Number of cooling degrees used on this day in the baseline */ baselineCoolingDegreeDays: number | null | undefined; /** * Number of cooling degrees used on this day */ currentCoolingDegreeDays: number | null | undefined; /** * Number of heating degrees used on this day in the baseline */ baselineHeatingDegreeDays: number | null | undefined; /** * Number of heating degrees used on this day */ currentHeatingDegreeDays: number | null | undefined; /** * Indicates whether or not a Special Adjustment was in effect on this day */ specialAdjustment: boolean | null | undefined; /** * Indicates whether or not an Area Adjustment was in effect on this day */ areaAdjustment: boolean | null | undefined; /** * Indicates whether or not Weather Adjustment was in effect on this day */ weatherAdjustment: boolean | null | undefined; /** * Indicates whether or not Other Adjustment was in effect on this day */ otherAdjustment: boolean | null | undefined; /** * Daily savings date */ date: Date | null | undefined; /** * List of Processor Messages for this day */ messages: Array | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * SavingsMeterBillDailyResponseDTO - This class is the DTO for a meter's bill's Cost Avoidance savings in daily format It provides the meter, bill, use unit, and then an array of daily savings values Each daily value contains date that represents this day, non-weather use, weather use, BATCC Cost, average daily unit cost, whether any of the four adjustments (special, area, weather, other) were performed and a list of messages generated by the Savings Processor for this day */ declare class SavingsMeterBillDailyResponse { /** * Unique meter identifier */ meterId: number | null | undefined; /** * Meter Code */ meterCode: string | null | undefined; /** * Meter Name */ meterInfo: string | null | undefined; /** * Unique bill identifier */ billId: number | null | undefined; /** * Calendar Period Name (e.g. Jan) */ periodName: string | null | undefined; /** * Calendar period Number (e.g. 1) */ calendarPeriod: number | null | undefined; /** * Calendar year (e.g. 2019) */ calendarYear: number | null | undefined; /** * Fiscal period number */ fiscalPeriod: number | null | undefined; /** * Fiscal year */ fiscalYear: number | null | undefined; nativeUseUnit: UnitChild | null | undefined; /** * Cost avoidance savings for this meter, day by day */ daily: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Reviewed { /** * Indicates whether or not the savings has been reviewed */ reviewed: boolean | null | undefined; reviewedBy: UserChild | null | undefined; /** * Reviewed date */ reviewedDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsMeterBillResponse { /** * Unique ID for this savings record (Bill Meter CAP) */ billMtrCapId: number | null | undefined; /** * Unique ID of the bill processed for this savings record */ billId: number | null | undefined; /** * Calendar Period Name (e.g. Jan) */ periodName: string | null | undefined; /** * Calendar Period Number (e.g. 4) */ calendarPeriod: number | null | undefined; /** * Calendar Year (e.g. 2019) */ calendarYear: number | null | undefined; /** * Fiscal Period Number */ fiscalPeriod: number | null | undefined; /** * Fiscal Year */ fiscalYear: number | null | undefined; /** * Baseline Cost */ baselineCost: number | null | undefined; /** * Baseline Native Use */ baselineNativeUse: number | null | undefined; /** * Baseline Weather Native Use */ baselineWeatherNativeUse: number | null | undefined; /** * Baseline Nonweather Native Use */ baselineNonweatherNativeUse: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) Cost */ batccCost: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) Native Use */ batccNativeUse: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) Weather Native Use */ batccWeatherNativeUse: number | null | undefined; /** * Baseline Adjusted to Current Conditions (BATCC) Nonweather Native Use */ batccNonweatherNativeUse: number | null | undefined; /** * Actual Cost */ actualCost: number | null | undefined; /** * Actual Native Use */ actualNativeUse: number | null | undefined; /** * Savings Cost */ savingsCost: number | null | undefined; /** * Savings Native Use */ savingsNativeUse: number | null | undefined; /** * Savings Cost Percent */ savingsCostPercent: number | null | undefined; /** * Savings Native Use Percent */ savingsNativeUsePercent: number | null | undefined; /** * Heating Degree Days */ hdd: number | null | undefined; /** * Cooling Degree Days */ cdd: number | null | undefined; /** * Heating Degree Days Adjusted */ hddAdjusted: boolean | null | undefined; /** * Cooling Degree Days Adjusted */ cddAdjusted: boolean | null | undefined; /** * Heating Use Per Degree Day */ heatingUsePerDegreeDay: number | null | undefined; /** * Heating R2 */ heatR2: number | null | undefined; /** * Cooling Use Per Degree Day */ coolingUsePerDegreeDay: number | null | undefined; /** * Cooling R2 */ coolR2: number | null | undefined; /** * Cost Avoidance Status */ capStatus: string | null | undefined; /** * Indicates whether or not the bill's cost avoidance data is locked */ locked: boolean | null | undefined; /** * */ billMtrNotes: Array | null | undefined; nativeUseUnit: UnitChild | null | undefined; review: Reviewed | null | undefined; account: AccountChild | null | undefined; meter: MeterChild | null | undefined; place: PlaceChild | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecialAdjustmentCreate { /** * Special adjustment method identifier Required */ specialAdjustmentMethodId: number | null; /** * Reason for making the special adjustment Required */ comments: string | null; /** * Amount See special adjustment method list for acceptable precision Precision of -1 means the value should not be passed in */ value: number | null | undefined; /** * Special adjustment type identifier Required */ specialAdjustmentTypeId: number | null; /** * Frequency type One of 'Recurring', 'Continuous' Required */ frequency: string | null; /** * Start date Required */ startDate: Date | null; /** * End date Required Must be greater than StartDate */ endDate: Date | null; /** * Frequency start period Should only be passed when Frequency type is Recurring Required when frequency is set to recurring */ annualCycleStartMMDD: number | null | undefined; /** * Frequency end period Should only be passed when Frequency type is Recurring Required when frequency is set to recurring */ annualCycleEndMMDD: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecialAdjustmentEdit { /** * The special adjustment method identifier Required */ specialAdjustmentMethodId: number | null; /** * Reason for making the special adjustment Required */ comments: string | null; /** * The amount See special adjustment method list for acceptable precision Precision of -1 means the value should not be passed in Required (defined) */ value: number | null | undefined; /** * The special adjustment type identifier Required */ specialAdjustmentTypeId: number | null; /** * The start date Required */ startDate: Date | null; /** * The end date Required Must be greater than StartDate */ endDate: Date | null; /** * The frequency start period Should only be passed when frequency type is Recurring Required (defined) */ annualCycleStartMMDD: number | null | undefined; /** * The frequency end period Should only be passed when frequency type is Recurring Required (defined) */ annualCycleEndMMDD: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecialAdjustmentMethod { /** * Description of Special Adjustment method */ label: string | null | undefined; /** * Special Adjustment Method ID */ specialAdjustmentMethodId: number | null | undefined; /** * Indicates whether or not this method is for Electric meters only */ electricOnly: boolean | null | undefined; /** * The symbol for the Special Adjustment's input value */ symbol: string | null | undefined; /** * The precision on the Special Adjustment's input value */ precision: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AdjustmentBaseMethodChild { /** * Special adjustment method identifier */ specialAdjustmentMethodId: number | null | undefined; /** * Special adjustment method description */ label: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Frequency { /** * Frequency of special adjustment (Continuous or Recurring) */ frequency: string | null | undefined; /** * Start date */ startDate: Date | null | undefined; /** * End date */ endDate: Date | null | undefined; /** * Frequency start period */ annualCycleStartMMDD: number | null | undefined; /** * Frequency end period */ annualCycleEndMMDD: number | null | undefined; /** * Frequency cycle beginning of recurrence (format is MMM DD) */ annualCycleStartInfo: string | null | undefined; /** * Frequency cycle end of recurrence (format is MMM DD) */ annualCycleEndInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecialAdjustmentType { /** * Special Adjustment type identifier */ specialAdjustmentTypeId: number | null | undefined; /** * Special Adjustment type code */ specialAdjustmentTypeCode: string | null | undefined; /** * Special Adjustment type name */ specialAdjustmentTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SpecialAdjustmentResponse { /** * Special adjustment identifier */ specialAdjustmentId: number | null | undefined; /** * Sequence number; this controls the order in which special adjustments will be processed for this meter */ indexNumber: number | null | undefined; /** * Amount */ value: number | null | undefined; specialAdjustmentMethod: AdjustmentBaseMethodChild | null | undefined; frequency: Frequency | null | undefined; /** * Special adjustment comments */ comments: string | null | undefined; createdByUser: UserChild | null | undefined; /** * Created date */ createdDate: Date | null | undefined; modifiedByUser: UserChild | null | undefined; /** * Last modified date */ modifiedDate: Date | null | undefined; specialAdjustmentType: SpecialAdjustmentType | null | undefined; } declare class SavingsService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Mass update certain cost avoidance settings for meters that match the filter conditions Baseline and Savings will be reprocessed for affected meters * * @param body Filters and new cost avoidance setting values */ bulkEditMeterCostAvoidanceSettings(body?: BulkMeterCostAvoidanceSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings * * @param body Settings and filter conditions for baseline processing */ bulkGenerateBaseline(body?: BulkBaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Calculate savings for the meters that match the filter conditions, using the provided settings * * @param body Settings and filter conditions for savings processing */ calculateSavings(body?: CalculateSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which the other savings is being created * @param body Data representing the other savings adjustment being created */ createOtherSavings(meterId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create other savings category * * @param body Data representing the other saving category being created */ createOtherSavingsCategory(body?: OtherSavingsCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which to create a special adjustment * @param body Data representing the special adjustment being created */ createSpecialAdjustment(meterId: number, body?: SpecialAdjustmentCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an other savings adjustment * * @param meterId The meter for which the other savings is being deleted * @param otherSavingsId The other saving identifier which is being deleted */ deleteOtherSavings(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter from which to delete the special adjustment * @param specialAdjustmentId The special adjustment to delete */ deleteSpecialAdjustmentById(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the average unit cost \"acceptable range\" values for cost avoidance for one or more commodities Cost Avoidance Savings will be re-calculated for all bills for meters having the affected commodities * * @param body Data representing one or more average unit cost ranges to edit */ editAucRanges(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * */ editCostAvoidanceSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter whose other savings is being edited * @param otherSavingsId The other savings to edit * @param body Data representing the other savings adjustment being edited */ editOtherSavings(meterId: number, otherSavingsId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter with the special adjustment to edit * @param specialAdjustmentId The special adjustment to edit * @param body Data representing the special adjustment being edited */ editSpecialAdjustment(meterId: number, specialAdjustmentId: number, body?: SpecialAdjustmentEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Executes the baseline and cost avoidance processors with provided baseline and cost avoidance settings for the provided meter. Results are not saved unless the \"save\" flag is set to true. If \"save\" is true, MeterSavingsSettings-Manage permission is also required * * @param meterId ID of the meter for which baseline will be reprocessed * @param save If true, the baseline results will be saved to the database * @param body Provided baseline and avoidance settings */ generateBaseline(meterId: number, save?: boolean, body?: BaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Executes the baseline processor with stored baseline settings for the provided meter * * @param meterId ID of the meter for which baseline data will be returned */ generateBaselineGet(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a other savings for a meter * * @param meterId The meter for which the other savings are being retrieved */ getAllOtherSavings(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the average unit cost \"acceptable range\" values for cost avoidance for each commodity * */ getAucRanges(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return available filters for Cost Avoidance processors Filters: - Commodity ID - Commodity Name - Meter Group Name - Building Group Name - Topmost Place Code - Topmost Place Name * */ getCostAvoidanceFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Count the number of meters that match the filter conditions for cost avoidance bulk actions * * @param onlyMetersInCAP Whether or not to only include meters in the count which are already participating in cost avoidance * @param body The filters used when counting the meters */ getCostAvoidanceMeterCount(onlyMetersInCAP?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ getCostAvoidanceSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get one other savings for a meter * * @param meterId The meter for which the other savings are being retrieved * @param otherSavingsId The identifier for the other savings record which is being retrieved */ getOneOtherSavings(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get other savings categories * */ getOtherSavingsCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of the Adjusted Cost Types * */ getSavingsAdjustedCostTypeList(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single Savings Details record of usage and cost avoidance for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBill(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get cost avoidance savings by day for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillDaily(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get Savings Details of usage and cost avoidance for a meter's bills * * @param meterId The meter for which to retrieve data * @param numberOfYears Number of years of data to return; includes the current year - Defaults to 5 */ getSavingsMeterBillList(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single cost avoidance task by its unique ID * * @param taskId */ getSavingsTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single special adjustment by its unique ID * * @param meterId The meter for which to return the special adjustment * @param specialAdjustmentId Unique ID of the special adjustment to return */ getSpecialAdjustment(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get Special Adjustment Methods * */ getSpecialAdjustmentMethods(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Special Adjustment Types * */ getSpecialAdjustmentTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all the special adjustments for the meter * * @param meterId The meter for which to return special adjustment */ getSpecialAdjustments(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates or removes manual adjustments to savings for a provided meter and bill * * @param meterId The meter for which the manual adjustment is being made * @param billId The bill for which the manual adjustment is being made * @param body */ manualAdjustment(meterId: number, billId: number, body?: ManualAdjustmentRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Mass update certain cost avoidance settings for meters that match the filter conditions Baseline and Savings will be reprocessed for affected meters * * @param body Filters and new cost avoidance setting values */ bulkEditMeterCostAvoidanceSettingsWithHttpInfo(body?: BulkMeterCostAvoidanceSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings * * @param body Settings and filter conditions for baseline processing */ bulkGenerateBaselineWithHttpInfo(body?: BulkBaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Calculate savings for the meters that match the filter conditions, using the provided settings * * @param body Settings and filter conditions for savings processing */ calculateSavingsWithHttpInfo(body?: CalculateSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which the other savings is being created * @param body Data representing the other savings adjustment being created */ createOtherSavingsWithHttpInfo(meterId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create other savings category * * @param body Data representing the other saving category being created */ createOtherSavingsCategoryWithHttpInfo(body?: OtherSavingsCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which to create a special adjustment * @param body Data representing the special adjustment being created */ createSpecialAdjustmentWithHttpInfo(meterId: number, body?: SpecialAdjustmentCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an other savings adjustment * * @param meterId The meter for which the other savings is being deleted * @param otherSavingsId The other saving identifier which is being deleted */ deleteOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter from which to delete the special adjustment * @param specialAdjustmentId The special adjustment to delete */ deleteSpecialAdjustmentByIdWithHttpInfo(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the average unit cost \"acceptable range\" values for cost avoidance for one or more commodities Cost Avoidance Savings will be re-calculated for all bills for meters having the affected commodities * * @param body Data representing one or more average unit cost ranges to edit */ editAucRangesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * */ editCostAvoidanceSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter whose other savings is being edited * @param otherSavingsId The other savings to edit * @param body Data representing the other savings adjustment being edited */ editOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter with the special adjustment to edit * @param specialAdjustmentId The special adjustment to edit * @param body Data representing the special adjustment being edited */ editSpecialAdjustmentWithHttpInfo(meterId: number, specialAdjustmentId: number, body?: SpecialAdjustmentEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Executes the baseline and cost avoidance processors with provided baseline and cost avoidance settings for the provided meter. Results are not saved unless the \"save\" flag is set to true. If \"save\" is true, MeterSavingsSettings-Manage permission is also required * * @param meterId ID of the meter for which baseline will be reprocessed * @param save If true, the baseline results will be saved to the database * @param body Provided baseline and avoidance settings */ generateBaselineWithHttpInfo(meterId: number, save?: boolean, body?: BaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Executes the baseline processor with stored baseline settings for the provided meter * * @param meterId ID of the meter for which baseline data will be returned */ generateBaselineGetWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a other savings for a meter * * @param meterId The meter for which the other savings are being retrieved */ getAllOtherSavingsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the average unit cost \"acceptable range\" values for cost avoidance for each commodity * */ getAucRangesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Return available filters for Cost Avoidance processors Filters: - Commodity ID - Commodity Name - Meter Group Name - Building Group Name - Topmost Place Code - Topmost Place Name * */ getCostAvoidanceFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Count the number of meters that match the filter conditions for cost avoidance bulk actions * * @param onlyMetersInCAP Whether or not to only include meters in the count which are already participating in cost avoidance * @param body The filters used when counting the meters */ getCostAvoidanceMeterCountWithHttpInfo(onlyMetersInCAP?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * */ getCostAvoidanceSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get one other savings for a meter * * @param meterId The meter for which the other savings are being retrieved * @param otherSavingsId The identifier for the other savings record which is being retrieved */ getOneOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get other savings categories * */ getOtherSavingsCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of the Adjusted Cost Types * */ getSavingsAdjustedCostTypeListWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single Savings Details record of usage and cost avoidance for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillWithHttpInfo(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get cost avoidance savings by day for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillDailyWithHttpInfo(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Savings Details of usage and cost avoidance for a meter's bills * * @param meterId The meter for which to retrieve data * @param numberOfYears Number of years of data to return; includes the current year - Defaults to 5 */ getSavingsMeterBillListWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single cost avoidance task by its unique ID * * @param taskId */ getSavingsTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single special adjustment by its unique ID * * @param meterId The meter for which to return the special adjustment * @param specialAdjustmentId Unique ID of the special adjustment to return */ getSpecialAdjustmentWithHttpInfo(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Special Adjustment Methods * */ getSpecialAdjustmentMethodsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get Special Adjustment Types * */ getSpecialAdjustmentTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all the special adjustments for the meter * * @param meterId The meter for which to return special adjustment */ getSpecialAdjustmentsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Creates or removes manual adjustments to savings for a provided meter and bill * * @param meterId The meter for which the manual adjustment is being made * @param billId The bill for which the manual adjustment is being made * @param body */ manualAdjustmentWithHttpInfo(meterId: number, billId: number, body?: ManualAdjustmentRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleDayCreate { /** * The day of week that this record refers to. Required Must be a valid value for DayOfWeek: Sunday = 0, Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6 */ dayOfWeek: ScheduleDayCreate.DayOfWeekEnum; /** * The time of day that this schedule begins. It is serialized as a \"HH:MM:SS\" string. For example, \"17:29:59\". Should only be informed when Is24Hours = false AND IsClosed = false, otherwise it should be null. Must be null when IsClosed, or Is24Hours are set to True, case sensitive */ beginTime: string | null | undefined; /** * The time of day that this schedule ends. It is serialized as a \"HH:MM:SS\" string. For example, \"17:29:59\". Should only be informed when Is24Hours = false AND IsClosed = false, otherwise it should be null. Must be greater than BeginTime Must be null when IsClosed, or Is24Hours are set to True, case sensitive */ endTime: string | null | undefined; /** * Indicates whether the record represents an opening period of 24 hours. When Is24Hours = true, BeginTime and EndTime should be null because it will automatically be set to begin at \"00:00:00\" and finish at \"23:59:59\" */ is24Hours: boolean | null | undefined; /** * Indicates whether the record represents being closed for the entire day. When IsClosed = true, BeginTime and EndTime should be null because it does not apply for a closed day. */ isClosed: boolean | null | undefined; } declare namespace ScheduleDayCreate { enum DayOfWeekEnum { NUMBER_0, NUMBER_1, NUMBER_2, NUMBER_3, NUMBER_4, NUMBER_5, NUMBER_6 } } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleCreate { /** * Unique name of the schedule Required Must be between 0 and 50 characters */ scheduleInfo: string | null; /** * Optional description of the schedule Must be between 0 and 255 characters */ scheduleDescription: string | null | undefined; /** * List of schedule day definition for each day of the week All 7 days must be informed Cannot be Empty */ scheduleDays: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ScheduleEdit { /** * Unique name of the schedule Required Must be between 0 and 50 characters */ scheduleInfo: string | null; /** * Optional description of the schedule Must be between 0 and 255 characters Required (defined) */ scheduleDescription: string | null | undefined; /** * List of schedule day definition for each day of the week All 7 days must be informed Cannot be Empty Required (defined) */ scheduleDays: Array | null | undefined; } declare class ScheduleService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a schedule * * @param body Data representing the schedule being created */ createSchedule(body?: ScheduleCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a schedule * * @param scheduleId The schedule identifier */ deleteSchedule(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a schedule * * @param scheduleId The schedule identifier * @param body Data representing the schedule being edited */ editSchedule(scheduleId: number, body?: ScheduleEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the specified schedule * * @param scheduleId The schedule identifier */ getSchedule(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all schedules * */ getSchedules(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a schedule * * @param body Data representing the schedule being created */ createScheduleWithHttpInfo(body?: ScheduleCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a schedule * * @param scheduleId The schedule identifier */ deleteScheduleWithHttpInfo(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a schedule * * @param scheduleId The schedule identifier * @param body Data representing the schedule being edited */ editScheduleWithHttpInfo(scheduleId: number, body?: ScheduleEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the specified schedule * * @param scheduleId The schedule identifier */ getScheduleWithHttpInfo(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all schedules * */ getSchedulesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchAccountChildSearchAccountChild { /** * The Account identifier */ accountId: number | null | undefined; /** * The Account code Required Must be between 0 and 32 characters */ accountCode: string | null; /** * An array of account code aliases */ accountCodeAliases: Array | null | undefined; /** * The Account info Required Must be between 0 and 50 characters */ accountInfo: string | null; /** * Indicates whether the Account is active or inactive */ active: boolean | null | undefined; accountType: AccountTypeChild | null | undefined; vendor: VendorChild | null | undefined; address: AddressChild | null | undefined; /** * The collection of cost centers representing the path to its parent */ parentPath: Array | null | undefined; /** * Indicates whether the Account has a child calculated meter */ hasCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Account is a recipient of a split */ hasSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Account has a child split meter */ hasSplitChildMeter: boolean | null | undefined; /** * Indicates whether the Account is a sub-account */ isSubAccount: boolean | null | undefined; /** * Indicates whether the Account has a sub-account */ hasSubAccount: boolean | null | undefined; /** * The previous Account code */ previousAccountCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchAccountChild { result: SearchAccountChildSearchAccountChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchBillChildSearchBillAccountChild { /** * The Account identifier */ accountId: number | null | undefined; /** * The Account code */ accountCode: string | null | undefined; /** * The Account info */ accountInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchBillChildSearchBillChild { /** * The bill identifier */ billId: number | null | undefined; /** * The bill's billing period */ billingPeriod: number | null | undefined; account: SearchBillChildSearchBillAccountChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchBillChild { result: SearchBillChildSearchBillChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchCollectionChildSearchCollection { /** * The collection identifier */ collectionId: number | null | undefined; /** * The collection code */ collectionCode: string | null | undefined; /** * The collection info */ collectionInfo: string | null | undefined; collectionIcon: Icon | null | undefined; /** * The collection of CarbonHub collections representing the path to its parent */ parentPath: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchCollectionChild { result: SearchCollectionChildSearchCollection | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchCostCenterChildSearchCostCenter { /** * The cost center identifier */ costCenterId: number | null | undefined; /** * The cost center code Required Must be between 0 and 32 characters */ costCenterCode: string | null; /** * The cost center info Required Must be between 0 and 50 characters */ costCenterInfo: string | null; /** * The collection of cost centers representing the path to its parent */ parentPath: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchCostCenterChild { result: SearchCostCenterChildSearchCostCenter | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchEmissionSourceChildSearchEmissionSource { /** * The emissions source identifier */ emissionSourceId: number | null | undefined; /** * The emissions source code */ emissionSourceCode: string | null | undefined; /** * The emissions source info */ emissionSourceInfo: string | null | undefined; commodity: CommodityChild | null | undefined; /** * The collection of CarbonHub collections representing the path to its parent */ parentPath: Array | null | undefined; /** * Indicates whether or not the emissions source is active */ active: boolean | null | undefined; /** * The address postal code */ postalCode: string | null | undefined; /** * The address city */ city: string | null | undefined; /** * The address state */ state: string | null | undefined; /** * The address country */ country: string | null | undefined; /** * The address first line */ line1: string | null | undefined; /** * The address second line */ line2: string | null | undefined; /** * The address third line */ line3: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchEmissionSourceChild { result: SearchEmissionSourceChildSearchEmissionSource | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchParentPlaceChild { /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; placeType: PlaceTypeResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchMeterChildSearchMeterChild { /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code Required Must be between 0 and 32 characters */ meterCode: string | null; /** * The meter info Required Must be between 0 and 50 characters */ meterInfo: string | null; /** * The collection of accounts */ accounts: Array | null | undefined; commodity: CommodityChild | null | undefined; meterType: MeterTypeChild | null | undefined; /** * The address postal code */ postalCode: string | null | undefined; /** * The address city */ city: string | null | undefined; /** * The address state */ state: string | null | undefined; /** * The address country */ country: string | null | undefined; /** * The address first line */ line1: string | null | undefined; /** * The address second line */ line2: string | null | undefined; /** * The address third line */ line3: string | null | undefined; /** * The bill entry note */ billEntryNote: string | null | undefined; /** * Indicates if the building is included in ENERGY STAR submissions */ includeInEnergyStar: boolean | null | undefined; /** * An array of meter properties */ properties: { [key: string]: string; } | null | undefined; /** * The collection of places representing the path to its parent */ parentPath: Array | null | undefined; /** * Indicates whether the meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The previous serial number of the meter */ previousSerialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchMeterChild { result: SearchMeterChildSearchMeterChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchPlaceChildSearchPlaceChild { /** * The place identifier */ placeId: number | null | undefined; /** * The place code Required Must be between 0 and 32 characters */ placeCode: string | null; /** * The place info Required Must be between 0 and 50 characters */ placeInfo: string | null; placeType: PlaceTypeResponse | null | undefined; address: AddressChild | null | undefined; /** * The collection of places representing the path to its parent */ parentPath: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchPlaceChild { result: SearchPlaceChildSearchPlaceChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchPlaceGroup { result: PlaceGroupChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchVendorChildSearchVendorChild { /** * An array of vendor code aliases */ vendorCodeAliases: Array | null | undefined; remitAddress: AddressChild | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchVendorChild { result: SearchVendorChildSearchVendorChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SearchResponse { /** * The collection of cost centers */ costCenters: Array | null | undefined; /** * The collection of accounts */ accounts: Array | null | undefined; /** * The collection of places */ places: Array | null | undefined; /** * The collection of meters */ meters: Array | null | undefined; /** * The collection of place groups */ placeGroups: Array | null | undefined; /** * The collection of CarbonHub collections */ collections: Array | null | undefined; /** * The collection of CarbonHub emissions sources */ emissionSources: Array | null | undefined; /** * The collection of vendors */ vendors: Array | null | undefined; /** * The collection of bills */ bills: Array | null | undefined; } declare class SearchService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Searches for Accounts, Meters, Cost Centers, Places, Place Groups, Emissions Sources, Collections, Vendors, and Bills that match the provided query text. For the bill search to return any results, the query text should be an exact match to a bill ID. * Unless searching by id, not all properties on child objects are set in the response DTO, this is for performance reasons * @param query The text to search * @param limit The maximum number of items to return per entity type. Defaults to 10, valid range of 0 to 100. 0 is treated as default for backwards compatibility reasons. */ getSearchResult(query?: string, limit?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Searches for Accounts, Meters, Cost Centers, Places, Place Groups, Emissions Sources, Collections, Vendors, and Bills that match the provided query text. For the bill search to return any results, the query text should be an exact match to a bill ID. * Unless searching by id, not all properties on child objects are set in the response DTO, this is for performance reasons * @param query The text to search * @param limit The maximum number of items to return per entity type. Defaults to 10, valid range of 0 to 100. 0 is treated as default for backwards compatibility reasons. */ getSearchResultWithHttpInfo(query?: string, limit?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaSentinelPredictionResponse { /** * Prediction’s channel ID */ esaChannelId: number | null | undefined; /** * The local date and time of the prediction. Note that prediction entries will be rounded to hourly intervals. */ localDateTime: Date | null | undefined; /** * Total offset minutes that the local date and time differ from UTC. */ timeZoneTotalOffsetMinutes: number | null | undefined; /** * The predicted estimated upper limit for this date/time. */ estimatedUpperBound: number | null | undefined; /** * The predicted estimated lower limit for this date/time. */ estimatedLowerBound: number | null | undefined; /** * The predicted estimated value for this date/time. */ estimatedValue: number | null | undefined; /** * Details for the model that was used to generate the estimates for the date/time. This may be nothing more than a name assigned to the model (e.g. Facebook Prophet). */ sourceModel: string | null | undefined; } declare class SentinelService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves all sentinel predictions for a given ESA channel within a specified local date/time range. * * @param esaChannelId The ID of the ESA channel to retrieve predictions for. * @param startLocalDate The start local date/time of the range for which predictions are requested. If equal to endLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions since this date and time (exclusive). * @param endLocalDate The end local date/time of the range for which predictions are requested If equal to startLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions up to (and including) this date and time. */ getSentinelPredictions(esaChannelId: number, startLocalDate?: Date, endLocalDate?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all sentinel predictions for a given ESA channel within a specified local date/time range. * * @param esaChannelId The ID of the ESA channel to retrieve predictions for. * @param startLocalDate The start local date/time of the range for which predictions are requested. If equal to endLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions since this date and time (exclusive). * @param endLocalDate The end local date/time of the range for which predictions are requested If equal to startLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions up to (and including) this date and time. */ getSentinelPredictionsWithHttpInfo(esaChannelId: number, startLocalDate?: Date, endLocalDate?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Setup { /** * Type of importer */ type: Setup.TypeEnum; /** * Type of sheet that was imported */ sheetType: string | null | undefined; /** * Action that was performed - create, update, convert */ action: string | null | undefined; /** * Count of rows that succeeded */ success: number | null | undefined; /** * Count of rows that failed */ failure: number | null | undefined; /** * Count of rows that were skipped */ skip: number | null | undefined; /** * A stream that represents the kickout file */ kickout: string | null | undefined; /** * Time at which the import started */ start: Date | null | undefined; /** * Time at which the import finished */ finish: Date | null | undefined; /** * Unique identifier for this import */ taskId: number | null | undefined; } declare namespace Setup { enum TypeEnum { UNKNOWNTYPE, CREATEAccountsAndMeters, CREATEBuildingsAndOrganizations, CREATECostAvoidanceOtherSavings, CREATECostAvoidanceSpecialAdjustments, CREATECostCenters, CREATECustomers, CREATEChargebackDistributionsVersions, CREATERateSchedules, CREATEVendors, CREATEChannels, UPDATECostCenters, UPDATEBuildingsAndOrganizations, UPDATEAccountingCalendar, UPDATEAccounts, UPDATECustomFieldsAccount, UPDATECostAvoidanceOtherSavings, UPDATECostAvoidanceSpecialAdjustments, UPDATECustomers, CREATEGLCodesAndSubcodes, UPDATEGLCodesAndSubcodes, UPDATEMeters, UPDATECustomFieldsMeter, UPDATECustomFieldsPlace, UPDATEUsers, UPDATEVendors, UPDATECustomFieldsVendor, CREATEUsers, UPDATEChannels, UPDATEBillCalculations, CREATEBillCalculations, UPDATEBillSplits, CREATEBillSplits, UPDATEMeterGroups, UPDATEBuildingGroups, CREATEReadings, UPDATEReadings, CREATEMonthlyReadings, CREATEPlaceBenchmarks, UPDATEPlaceBenchmarks, CREATEUserGroups, UPDATEUserGroups, UPDATEUserGroupMembers, UPDATEPlaceEnergyStarLink, CREATEBuildingForecastWorksheet, UPDATEMeterEmissionSourceLink, UPDATECustomGhgFactors, CREATEEmissionRecords, UPDATEEmissionRecords, UPDATEBasicUnitConversions, CREATECollections, UPDATECollections, UPDATEAdvancedUnitConversions, CREATEEmissionSources, UPDATEEmissionSources, UPDATEBudgetMonthlyMeter, UPDATEBudgetMonthlyBuilding, UPDATEBillPaymentDetails, UPDATEBillLineTypeMapping, UPDATECostCategoryMapping, CREATESpaces, UPDATESpaces, CREATEDataPoints, UPDATEDataPoints, CREATEEsaReadings, UPDATEEsaReadings, CREATESitesAndSpaces, UPDATESitesAndSpaces, CREATEEsaChannels, UPDATEEsaChannels, CREATEEsaMonthlyReadings } } declare class SetupService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Returns an Excel file used within SetupSheets * * @param type * @param filter */ getSetupSheet(type?: string, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the applicable filters for a given type to filter down SetupSheet Templates * * @param type */ getSetupSheetFilters(type?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Import a budget setup sheet * * @param budgetId The budget identifier * @param versionId The budget version identifier * @param body The budget sheet file contents */ postBudgetSetupSheet(budgetId: number, versionId: number, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Processes a SetupSheet Excel file Accepts a base64 string representation of an xlsx file File must be Microsoft Excel 2007 or later. * * @param body */ postSetupSheet(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns an Excel file used within SetupSheets * * @param type * @param filter */ getSetupSheetWithHttpInfo(type?: string, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the applicable filters for a given type to filter down SetupSheet Templates * * @param type */ getSetupSheetFiltersWithHttpInfo(type?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Import a budget setup sheet * * @param budgetId The budget identifier * @param versionId The budget version identifier * @param body The budget sheet file contents */ postBudgetSetupSheetWithHttpInfo(budgetId: number, versionId: number, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Processes a SetupSheet Excel file Accepts a base64 string representation of an xlsx file File must be Microsoft Excel 2007 or later. * * @param body */ postSetupSheetWithHttpInfo(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Filter to select accounts to add as sub accounts If multiple filters are provided, they are combined with AND Properties with a null value are not included when filtering */ declare class LinkSubAccountsFilters { /** * Account info contains the specified string At least one of AccountInfoContains, AccountCodeContains, VendorId, TopmostCostCenterId must not be null */ accountInfoContains: string | null | undefined; /** * Account code contains the specified string At least one of AccountInfoContains, AccountCodeContains, VendorId, TopmostCostCenterId must not be null */ accountCodeContains: string | null | undefined; /** * All accounts with the specified vendor id At least one of AccountInfoContains, AccountCodeContains, VendorId, TopmostCostCenterId must not be null */ vendorId: number | null | undefined; /** * All accounts under the specified topmost cost center id Topmost (CostCenter) At least one of AccountInfoContains, AccountCodeContains, VendorId, TopmostCostCenterId must not be null */ topmostCostCenterId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Sub accounts to add to a summary account Either a list of SubAccountIds or use filter to find all accounts to add */ declare class LinkSubAccountsRequest { /** * List of AccountIds to assign as sub accounts Cannot be Empty NULL Valid Only one of SubAccountIds, LinkSubAccountsFilters can be set */ subAccountIds: Array | null | undefined; linkSubAccountsFilters: LinkSubAccountsFilters | null | undefined; } declare class SummaryAccountService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Link sub accounts to a summary account This only adds sub accounts to a summary account. It will not remove any links. Use the Delete to remove accounts. Because the number of linked sub accounts can be large we just return the total number of accounts linked To get the list of all sub accounts linked to a summary account call the Get All Accounts API with the summaryAccountID filter. * * @param summaryAccountId * @param body */ linkSubAccounts(summaryAccountId: number, body?: LinkSubAccountsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink a sub account from a summary account * * @param summaryAccountId * @param subAccountId */ unlinkSubAccount(summaryAccountId: number, subAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink all sub accounts from a summary account * * @param summaryAccountId */ unlinkSubAccounts(summaryAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Link sub accounts to a summary account This only adds sub accounts to a summary account. It will not remove any links. Use the Delete to remove accounts. Because the number of linked sub accounts can be large we just return the total number of accounts linked To get the list of all sub accounts linked to a summary account call the Get All Accounts API with the summaryAccountID filter. * * @param summaryAccountId * @param body */ linkSubAccountsWithHttpInfo(summaryAccountId: number, body?: LinkSubAccountsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink a sub account from a summary account * * @param summaryAccountId * @param subAccountId */ unlinkSubAccountWithHttpInfo(summaryAccountId: number, subAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink all sub accounts from a summary account * * @param summaryAccountId */ unlinkSubAccountsWithHttpInfo(summaryAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserCreateRequest { /** * The user code. This is the user name that is used on sign-in Required Must be between 0 and 65 characters */ userCode: string | null; /** * The user's full name Required Must be between 0 and 32 characters */ fullName: string | null; /** * The user's password. Password is not changed if this field is empty. Not available for users whose identity is managed externally. Required Must be between 0 and 128 characters */ password: string | null; /** * The user's email address Required Must be between 0 and 128 characters */ email: string | null; /** * Create User with one or multiple topmost cost center ids The CostCenterIds must be in the creating user's topmost Required Cannot be Empty */ topmostCostCenterIds: Array | null; /** * Create User with one or multiple topmost place ids The PlaceIds must be in the creating user's topmost Required Cannot be Empty */ topmostPlaceIds: Array | null; /** * Update a user to one or multiple topmost EsaSpace ids The EsaSpaceIds must be in the editing user's topmost Required Cannot be Empty */ topmostSpaceIds: Array | null; /** * Create User with one or multiple topmost collection ids The CollectionIds must be in the creating user's topmost Required Cannot be Empty */ topmostCollectionIds: Array | null; /** * Whether or not the user signs in using active directory. This is used for install client only */ activeDirectory: boolean | null | undefined; /** * Whether or not the user is active */ active: boolean | null | undefined; /** * Days until the user's password expires Must be set to 0 for users whose identity is managed externally. Required */ passwordExpirationInterval: number | null; /** * Force the user's password to have a minimum of 8 characters, containing at least 1 uppercase, 1 lowercase, 1 number, and 1 symbol. Must be set to false for users whose identity is managed externally. Required */ strongPassword: boolean | null; /** * Force the user to change their password on next login. Must be set to false for users whose identity is managed externally. Required */ forcePasswordChange: boolean | null; /** * User role id of the user being created User role id is required Required */ userRoleId: number | null; /** * The maximum bill amount (in dollars) the user can approve If not included, the user has no max limit */ maxApprovalAmount: number | null | undefined; /** * The user's report group. If not included, set to the default report group */ reportGroupId: number | null | undefined; /** * List of user group ids If null or not passed the groups a user assigned to will NOT be modified If an empty list the user will be removed from all groups */ userGroups: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserEditRequest { /** * The user code. This is the user name that is used on sign-in Required Must be between 0 and 65 characters */ userCode: string | null; /** * The user's full name Required Must be between 0 and 32 characters */ fullName: string | null; /** * The user's password. Password is not changed if this field is empty. Not available for users whose identity is managed externally. Must be between 0 and 128 characters Required (defined) */ password: string | null | undefined; /** * The user's email address Required Must be between 0 and 128 characters */ email: string | null; /** * Update a user to one multiple topmost cost center ids The CostCenterIds must be in the editing user's topmost Required Cannot be Empty */ topmostCostCenterIds: Array | null; /** * Update a user to one or multiple topmost place ids The PlaceIds must be in the editing user's topmost Required Cannot be Empty */ topmostPlaceIds: Array | null; /** * Update a user to one or multiple topmost EsaSpace ids The EsaSpaceIds must be in the editing user's topmost Required Cannot be Empty */ topmostSpaceIds: Array | null; /** * Update a user to one or multiple topmost collection ids The CollectionIds must be in the editing user's topmost Required Cannot be Empty */ topmostCollectionIds: Array | null; /** * Whether or not the user signs in using active directory. This is used for install client only Required */ activeDirectory: boolean | null; /** * Whether or not the user is active Required */ active: boolean | null; /** * Days until the user's password expires Must be set to 0 for users whose identity is managed externally. Required */ passwordExpirationInterval: number | null; /** * Force the user's password to have a minimum of 8 characters, containing at least 1 uppercase, 1 lowercase, 1 number, and 1 symbol. Must be set to false for users whose identity is managed externally. Required */ strongPassword: boolean | null; /** * Force the user to change their password on next login. Must be set to false for users whose identity is managed externally. Required */ forcePasswordChange: boolean | null; /** * The user's role Required */ userRoleId: number | null; /** * The maximum bill amount (in dollars) the user can approve If not included, the user has no max limit Required (defined) */ maxApprovalAmount: number | null | undefined; /** * The user's report group. If not included, set to the default report group Required */ reportGroupId: number | null; /** * List of user group ids If null or not passed the groups a user assigned to will NOT be modified If an empty list the user will be removed from all groups Required (defined) */ userGroups: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportGroupChildResponse { /** * */ reportGroupId: number | null | undefined; /** * */ reportGroupCode: string | null | undefined; /** * */ reportGroupInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserResponse { /** * User Identifier */ userId: number | null | undefined; /** * User Code */ userCode: string | null | undefined; /** * Full name of the user */ fullName: string | null | undefined; userRole: SystemUserRoleChild | null | undefined; costCenter: TopmostCostCenter | null | undefined; place: TopmostPlace | null | undefined; collection: TopmostCollection | null | undefined; /** * Is this a active directory user? */ activeDirectory: boolean | null | undefined; /** * User is active or inactive */ active: boolean | null | undefined; /** * Email ID of the user */ email: string | null | undefined; /** * Days until password expires */ passwordExpirationInterval: number | null | undefined; /** * Does user need a strong password - at least 8 character long, one upper case, one number, one special char */ strongPassword: boolean | null | undefined; /** * Should the user be forced to change password on next login */ forcePasswordChange: boolean | null | undefined; /** * Max Total cost of bill this user is allowed to approve */ maxApprovalAmount: number | null | undefined; /** * last time the user logged in */ lastLogin: Date | null | undefined; reportGroup: ReportGroupChildResponse | null | undefined; /** * The external identifier for the user. This is only used for federated login. */ externalUserId: string | null | undefined; /** * List of groups a user is a part of */ userGroups: Array | null | undefined; space: TopmostSpace | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserRoleRequest { /** * The user role id to set for the user Required (defined) */ userRoleId: number | null | undefined; } declare class SystemUserService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new user. Requires Manage permission for Users & Roles * * @param body The object defining the properties for the new user */ createUser(body?: UserCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a system user's role. * * @param userId * @param body */ editSystemUsersRole(userId: number, body?: UserRoleRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing user. Requires Manage permission for Users & Roles. Please note that password is optional; all other items are required. MaxApprovalAmount may be null; if there is an existing value and null is passed, the existing value will be overwritten. * * @param userId The ID of the user to edit * @param body The object defining the updated properties of the existing user. */ editUser(userId: number, body?: UserEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Return a specific user and its properties. Requires View permission for Users & Roles * * @param userId The ID of the user to return */ getUser(userId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. There is a paginated version of GetUsers available at /api/v202512/user/paginated * * @param filter */ getUsers(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a paginated list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUsersPaginated(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new user. Requires Manage permission for Users & Roles * * @param body The object defining the properties for the new user */ createUserWithHttpInfo(body?: UserCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a system user's role. * * @param userId * @param body */ editSystemUsersRoleWithHttpInfo(userId: number, body?: UserRoleRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing user. Requires Manage permission for Users & Roles. Please note that password is optional; all other items are required. MaxApprovalAmount may be null; if there is an existing value and null is passed, the existing value will be overwritten. * * @param userId The ID of the user to edit * @param body The object defining the updated properties of the existing user. */ editUserWithHttpInfo(userId: number, body?: UserEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return a specific user and its properties. Requires View permission for Users & Roles * * @param userId The ID of the user to return */ getUserWithHttpInfo(userId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. There is a paginated version of GetUsers available at /api/v202512/user/paginated * * @param filter */ getUsersWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a paginated list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUsersPaginatedWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TagResponse { /** * */ tagTypeId: number | null | undefined; /** * */ tagTypeInfo: string | null | undefined; /** * */ values: Array | null | undefined; } declare class TagService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get a list of tags within a tag category. Report tags are the only supported category at this time. * * @param filter Currently only supports the 'tagCategory' filter with a value of 'report', may be expanded in the future */ getTags(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of tags within a tag category. Report tags are the only supported category at this time. * * @param filter Currently only supports the 'tagCategory' filter with a value of 'report', may be expanded in the future */ getTagsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TaskEdit { /** * Required */ taskNote: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TaskResponse { /** * Deprecated property - HasAttachments always returns true */ hasAttachments: boolean | null | undefined; /** * */ taskId: number | null | undefined; /** * The task guid */ taskGUId: string | null | undefined; taskType: TaskType | null | undefined; /** * The date and time the task began */ beginDate: Date | null | undefined; /** * The date and time the task finished. If the task is not finished, endDate will have no value */ endDate: Date | null | undefined; user: UserChild | null | undefined; /** * The task's message */ message: string | null | undefined; /** * The task's output. For certain task types, this field could be sizable */ output: any | null | undefined; /** * The task's settings */ settings: any | null | undefined; /** * The task's status */ status: string | null | undefined; /** * User provided note/comment for this Task */ taskNote: string | null | undefined; /** * Count of bills that are in the analyzing state, used by bill import tasks only */ analyzingCount: number | null | undefined; /** * The count of bills with unresolved flags on this task, used by bill import tasks only */ unresolvedFlagCount: number | null | undefined; /** * The count of successful bills that still exist (i.e. have not been deleted), used by bill import tasks only */ currentSuccessCount: number | null | undefined; batch: BatchChild | null | undefined; } declare class TaskService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits the note/comment associated with a task * * @param taskId The identifier for the task being edited * @param body Data representing the note */ editTask(taskId: number, body?: TaskEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a task by its GUID. The output property could potentially contain a large amount of data. If response time or size becomes an issue, use field reduction to eliminate the output field. * * @param taskGuid The GUID of the task */ getTask(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a task's error log as an EXCEL file by its GUID. At this time error logs can be downloaded for \"ReadingImport\" task type only * * @param taskGuid The GUID of the task */ getTaskOutputFile(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of tasks * * @param taskTypeCode Task type code. Acceptable values are: AuditGroup, CostAvoidance, Report, Chargeback, SetupSheet, UnitsOfMeasure, Accrual, BillImport, EnergyStar, BillExport, ReadingImport, SummarizeReading, BillUnexport, V7CostAvoidance, V7Accrual, Budget CostUnitUpdate, RecordImportPfl, EsaReadingImpPfl, RecordImport *This combines record import setup sheet tasks and record import with a profile tasks, EsaReadingImport *This combines Esa readings import setup sheet tasks and Esa Reading import with a profile tasks * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTasks(taskTypeCode?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits the note/comment associated with a task * * @param taskId The identifier for the task being edited * @param body Data representing the note */ editTaskWithHttpInfo(taskId: number, body?: TaskEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a task by its GUID. The output property could potentially contain a large amount of data. If response time or size becomes an issue, use field reduction to eliminate the output field. * * @param taskGuid The GUID of the task */ getTaskWithHttpInfo(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a task's error log as an EXCEL file by its GUID. At this time error logs can be downloaded for \"ReadingImport\" task type only * * @param taskGuid The GUID of the task */ getTaskOutputFileWithHttpInfo(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of tasks * * @param taskTypeCode Task type code. Acceptable values are: AuditGroup, CostAvoidance, Report, Chargeback, SetupSheet, UnitsOfMeasure, Accrual, BillImport, EnergyStar, BillExport, ReadingImport, SummarizeReading, BillUnexport, V7CostAvoidance, V7Accrual, Budget CostUnitUpdate, RecordImportPfl, EsaReadingImpPfl, RecordImport *This combines record import setup sheet tasks and record import with a profile tasks, EsaReadingImport *This combines Esa readings import setup sheet tasks and Esa Reading import with a profile tasks * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTasksWithHttpInfo(taskTypeCode?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CreateTemplateFromBill { /** * The template code Always converted to uppercase Required Must be between 0 and 32 characters */ templateCode: string | null; /** * The template note Must be between 0 and 255 characters */ note: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VersionChild { /** * */ versionId: number | null | undefined; /** * */ beginDate: Date | null | undefined; /** * */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemplateResponse { /** * */ templateId: number | null | undefined; /** * */ templateCode: string | null | undefined; /** * */ templateInfo: string | null | undefined; /** * */ note: string | null | undefined; commodity: CommodityChild | null | undefined; demandUnit: UnitChild | null | undefined; useUnit: UnitChild | null | undefined; /** * */ versions: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ObservationType { /** * */ observationTypeId: number | null | undefined; /** * */ credit: number | null | undefined; /** * */ timeOfUse: number | null | undefined; /** * */ creation: number | null | undefined; /** * */ noun: number | null | undefined; /** * Must be between 0 and 16 characters */ observationTypeCode: string | null | undefined; /** * Must be between 0 and 32 characters */ observationTypeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemplateLine { /** * The template line identifier */ templateLineId: number | null | undefined; /** * The begin day */ beginDay: number | null | undefined; /** * The end day */ endDay: number | null | undefined; /** * The display order */ displayOrder: number | null | undefined; /** * The caption */ caption: string | null | undefined; /** * The help tag */ helpTag: string | null | undefined; /** * Indicates whether a template line value is required or not required */ isRequired: boolean | null | undefined; /** * The from previous template line identifier */ fromPrevTemplateLineId: number | null | undefined; unit: UnitResponse | null | undefined; costUnit: UnitResponse | null | undefined; commodity: CommodityChild | null | undefined; observationType: ObservationType | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemplateVersion { /** * The identifier for the template */ templateId: number | null | undefined; /** * The identifier for the template version */ versionId: number | null | undefined; /** * The begin date of the template version */ beginDate: Date | null | undefined; /** * The end date of the template version */ endDate: Date | null | undefined; /** * An array of template lines belonging to the template version */ templateLines: Array | null | undefined; } declare class TemplateService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a new Template from an existing Bill's cost-only line items belonging to the provided Account (lines which came from a vendor template will be dropped). * * @param billId Id of Bill from which to create the Template * @param accountId Id of Account whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createAccountTemplateFromBill(billId: number, accountId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new Template from an existing Bill's line items belonging to the provided Meter * * @param billId Id of Bill from which to create the Template * @param meterId Id of Meter whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createTemplateFromBill(billId: number, meterId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one template * * @param templateId The template identifier for the template being retrieved */ getTemplate(templateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one template version for a given template * * @param templateId The template identifier for the template version being retrieved * @param versionId The identifier for the template version being retrieved */ getTemplateVersion(templateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all template versions for a given template * * @param templateId The template identifier for the template version being retrieved */ getTemplateVersions(templateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTemplates(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update current template for all passed in accountMeterIds If the accountMeter is an account only record the template must be for the 'Money' commodity or an error will be thrown If the accountMeter has no template assigned one will be created If the accountMeter's latest template assignment is end dated, a new assignment will be created starting from the latest end date All must be successfully updated otherwise none are updated and an error is returned * * @param templateId The template to apply to the provided accountMeterIds * @param body List of accountMeterIds whose template will be updated */ updateAccountMetersLatestTemplate(templateId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new Template from an existing Bill's cost-only line items belonging to the provided Account (lines which came from a vendor template will be dropped). * * @param billId Id of Bill from which to create the Template * @param accountId Id of Account whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createAccountTemplateFromBillWithHttpInfo(billId: number, accountId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new Template from an existing Bill's line items belonging to the provided Meter * * @param billId Id of Bill from which to create the Template * @param meterId Id of Meter whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createTemplateFromBillWithHttpInfo(billId: number, meterId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one template * * @param templateId The template identifier for the template being retrieved */ getTemplateWithHttpInfo(templateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one template version for a given template * * @param templateId The template identifier for the template version being retrieved * @param versionId The identifier for the template version being retrieved */ getTemplateVersionWithHttpInfo(templateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all template versions for a given template * * @param templateId The template identifier for the template version being retrieved */ getTemplateVersionsWithHttpInfo(templateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTemplatesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update current template for all passed in accountMeterIds If the accountMeter is an account only record the template must be for the 'Money' commodity or an error will be thrown If the accountMeter has no template assigned one will be created If the accountMeter's latest template assignment is end dated, a new assignment will be created starting from the latest end date All must be successfully updated otherwise none are updated and an error is returned * * @param templateId The template to apply to the provided accountMeterIds * @param body List of accountMeterIds whose template will be updated */ updateAccountMetersLatestTemplateWithHttpInfo(templateId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class TimeZoneService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves the list of Time Zones * */ getTimeZones(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the list of Time Zones * */ getTimeZonesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFSelectValueCreate { /** * The UDF select option's value Required Must be between 0 and 255 characters */ value: string | null; /** * The UDF select option's display order Required */ displayOrder: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFCreate { /** * The UDF type. Possible value include: \"Vendor\", \"Place\", \"Account\", \"Meter\", \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\". Required Must be between 0 and 32 characters */ udfType: string | null; /** * The UDF's name Required Must be between 0 and 32 characters */ name: string | null; /** * Description for the UDF. Displayed next to the field name during data entry. Must be between 0 and 128 characters */ description: string | null | undefined; /** * The UDF's data type identifier. Possible value include: 1 (boolean), 2 (integer), 3 (string), 4 (double), 6 (date), 12 (select list), 13 (url), 15 (formatted text), 16 (image), 17 (pdf), 18 (document file), 19 (JSON text) Required */ dataTypeId: number | null; /** *

The UDF's display order

A value of 1 or less will put this record the beginning of the list

If the display order exists it will put this record at that spot. Display orders greater than or equal to this will be incremented by 1

A value greater than the stored max will put this record at the end of the list

Required */ displayOrder: number | null; /** *

An array of options to populate a UDF select list.

Required when dataTypeId is 12 otherwise this will be ignored.

Required when dataTypeId is set to 12, case sensitive. */ udfSelectValues: Array | null | undefined; /** * Marks a UDF as important. Important fields are highlighted during data entry. */ important: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFSelectValueEdit { /** * The UDF select value identifier. When creating a new option, assign null to this property. Required (defined) */ udfSelectValueId: number | null | undefined; /** * The UDF select option's value Required Must be between 0 and 255 characters */ value: string | null; /** * The UDF select option's display order Required */ displayOrder: number | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFEdit { /** * The UDF's name Required Must be between 0 and 32 characters */ name: string | null; /** * The description for the UDF. Not required, if left blank the description will not be updated. Must be between 0 and 128 characters */ description: string | null | undefined; /** *

The UDF's display order

A value of 1 or less will put this record the beginning of the list

A value greater than the stored max will put this record at the end of the list

When the old display order of the UDF being updated is less than the new specified display order, decrement the display order of all other UDFs falling between the old and new display order

When the old display order of the UDF being updated is greater than the new specified display order, increment the display order of all other UDFs falling between the old and new display order

All UDF lying outside the range of display orders being updated retain their original values

Required */ displayOrder: number | null; /** *

An array of options to populate a UDF select list.

Required when the UDF being edited has a dataTypeId of 12 otherwise this will be ignored.

To remove an option from the select list, omit it from this array. Options that are in use may not be deleted. To add a new option, pass in null as the udfSelectValueId

*/ udfSelectValues: Array | null | undefined; /** * Important flag for the UDF. UDFs marked as important will be highlighted during data entry. Not required, if left blank the flag's value will not be changed. */ important: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFSelectValueResponse { /** * */ udfSelectValueId: number | null | undefined; /** * */ value: string | null | undefined; /** * */ displayOrder: number | null | undefined; /** * */ count: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFResponse { /** * The identifier of the custom field. Required (defined) */ udfId: number | null | undefined; /** * The name of the custom field. Required (defined) */ name: string | null | undefined; /** * The description for the custom field. Required (defined) */ description: string | null | undefined; /** * The type of the udf. Values include: Account, Meter, Vendor, Place, ChannelVersion, Rate, Bill, \"EnergyProject\", \"Collection\", and \"EmissionSource\". Required (defined) */ udfType: string | null | undefined; dataType: DataTypeResponse | null | undefined; /** * The display order of the custom field. Required (defined) */ displayOrder: number | null | undefined; /** * Select values of the custom field, if it is a select list (DataType = 12). Required (defined) */ udfSelectValues: Array | null | undefined; /** * The number of times this custom field has been used. Required (defined) */ count: number | null | undefined; /** * If true, then this udf is a system custom field Required (defined) */ locked: boolean | null | undefined; /** * If true, this custom field is important. Required (defined) */ important: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFSelectValueUpdate { /** * The UDF select value identifier. When creating a new option, assign null to this property. Required (defined) */ udfSelectValueId: number | null | undefined; /** * The UDF select option's value Required Must be between 0 and 255 characters */ value: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UDFUpdate { /** * The Udf's ID. When creating a new UDF, assign null to this property. Required (defined) */ udfId: number | null | undefined; /** * The UDF's name Required Must be between 0 and 32 characters */ name: string | null; /** * The UDF's description Must be between 0 and 128 characters Required (defined) */ description: string | null | undefined; /** * The UDF's data type identifier. Possible value include 1 (boolean), 2 (integer), 3 (string), 4 (double), 6 (date), 12 (select list) and 13 (url) Required */ dataTypeId: number | null; /** *

An array of options to populate a UDF select list.

Required when the UDF being edited has a dataTypeId of 12 otherwise this will be ignored.

To remove an option from the select list, omit it from this array. Options that are in use may not be deleted. To add a new option, pass in null as the udfSelectValueId

Required when dataTypeId is set to 12, case sensitive. */ udfSelectValues: Array | null | undefined; /** * Used to mark a UDF as important. Important UDFs are highlighted during data entry. Required (defined) */ important: boolean | null | undefined; } declare class UDFService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a user defined field / custom field * * @param body Data representing the user defined field / custom field being created */ createUDF(body?: UDFCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a user defined field / custom field. Currently NO confirmation is required * * @param udfId The identifier for the user defined field / custom field being deleted */ deleteUDF(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a list of user defined fields / custom fields * * @param udfType Valid udfTypes include \"Account\", \"Vendor\", \"Place\", \"Meter, \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\" * @param body */ editCustomFields(udfType: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a user defined field / custom field * * @param udfId * @param body Data representing the UDF being edited */ editUDF(udfId: number, body?: UDFEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one user defined field / custom field * * @param udfId The user defined field / custom field identifier */ getUDF(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all User defined fields/custom fields. The array of UDFs can be filtered by UDF type. Possible values for this filter include: \"Account\", \"Meter\", \"Place\", \"Vendor\", \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\". See the filter property for more details * * @param filter */ getUDFs(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a user defined field / custom field * * @param body Data representing the user defined field / custom field being created */ createUDFWithHttpInfo(body?: UDFCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a user defined field / custom field. Currently NO confirmation is required * * @param udfId The identifier for the user defined field / custom field being deleted */ deleteUDFWithHttpInfo(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a list of user defined fields / custom fields * * @param udfType Valid udfTypes include \"Account\", \"Vendor\", \"Place\", \"Meter, \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\" * @param body */ editCustomFieldsWithHttpInfo(udfType: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits a user defined field / custom field * * @param udfId * @param body Data representing the UDF being edited */ editUDFWithHttpInfo(udfId: number, body?: UDFEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one user defined field / custom field * * @param udfId The user defined field / custom field identifier */ getUDFWithHttpInfo(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all User defined fields/custom fields. The array of UDFs can be filtered by UDF type. Possible values for this filter include: \"Account\", \"Meter\", \"Place\", \"Vendor\", \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\". See the filter property for more details * * @param filter */ getUDFsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RollupUnitUpdateCommonUnit { /** * The commodity identifier Required (defined) */ commodityId: number | null | undefined; /** * The unit identifier that this commodity will roll up to Required (defined) */ commonRollupUnitId: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RollupUnitUpdate { /** * List of commodities and their rollup units to update Required (defined) */ commonRollups: Array | null | undefined; /** * The global rollup unit. Automatically assigned to ENERGY commodity. Pass in null to leave alone. Required (defined) */ globalRollupUnitId: number | null | undefined; } declare class UnitService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves all units * * @param filter */ getUnits(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update common and global use units * * @param body */ updateUseRollupUnits(body?: RollupUnitUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all units * * @param filter */ getUnitsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update common and global use units * * @param body */ updateUseRollupUnitsWithHttpInfo(body?: RollupUnitUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserGroupRequest { /** * The user group name Must be between 0 and 64 characters Required */ userGroupName: string | null; /** * A description of the user group Must be between 0 and 255 characters */ description: string | null | undefined; /** * List of system user ids in the group Hidden users cannot be added to groups On PUT request, if this property is null or not passed the group membership will not change To remove all members pass an empty list */ members: Array | null | undefined; /** * List of new users to create and add to the group The email cannot be currently used by another user Users are created as limited users with the Contact role and default topmost */ newUserEmail: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UserGroupResponse { /** * The user group identifier */ userGroupId: number | null | undefined; /** * The user group name */ userGroupName: string | null | undefined; /** * The user group description */ description: string | null | undefined; /** * The number of users in this group */ memberCount: number | null | undefined; /** * The last time a member was inserted, updated, or deleted from the group */ lastUpdated: Date | null | undefined; } declare class UserGroupService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a user group * * @param body Data representing the user group being created */ createUserGroup(body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user group * * @param userGroupId Id of the user group to delete */ deleteUserGroup(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a user group * * @param userGroupId Id of the user group to edit * @param body Data representing the user group being edited */ editUserGroup(userGroupId: number, body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a user group * * @param userGroupId Id of the user group to return */ getUserGroup(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of user group members * * @param userGroupId Id of the user group to get the list of members */ getUserGroupMembers(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of user groups * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUserGroups(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a user group * * @param body Data representing the user group being created */ createUserGroupWithHttpInfo(body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user group * * @param userGroupId Id of the user group to delete */ deleteUserGroupWithHttpInfo(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a user group * * @param userGroupId Id of the user group to edit * @param body Data representing the user group being edited */ editUserGroupWithHttpInfo(userGroupId: number, body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a user group * * @param userGroupId Id of the user group to return */ getUserGroupWithHttpInfo(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of user group members * * @param userGroupId Id of the user group to get the list of members */ getUserGroupMembersWithHttpInfo(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of user groups * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUserGroupsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HiddenRequest { /** * Set a system user role to be hidden or shown Roles Manage permission is required to access hidden roles Required */ hidden: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class Product { /** * The product identifier */ productId: number | null | undefined; /** * The product code */ productCode: string | null | undefined; /** * The product info */ productInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SystemUserRoleResponse { /** * Identifier for the system user role */ systemUserRoleId: number | null | undefined; /** * Name of the system user role */ systemUserRoleName: string | null | undefined; /** * Description of the system user role */ description: string | null | undefined; /** * Number of users currently assigned to the system user role */ usersAssignedCount: number | null | undefined; permissions: Permissions | null | undefined; /** * Indicates the system user role that cannot be modified These roles can be hidden using the SetUserRoleHidden API */ readOnly: boolean | null | undefined; /** * Hidden status of the system user role Roles Manage permission is required to access hidden roles */ hidden: boolean | null | undefined; /** * List of products this system user role applies to */ products: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountingSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountsModuleActualDataClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccountsModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AccrualSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AllInstalledReportsClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApplicationSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApproveBillsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BaselineEngineClassPermission { /** * */ run: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillCAPtureClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillListAdministratorClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillWorkflowSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillsAndBatchesClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillsModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BudgetsAndBudgetVersionsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingAndMeterGroupsClassPermission { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleActualDataClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleBudgetsClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleCalendarizedDataClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleMeterIntervalDataClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleNormalizedDataClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleSavingsClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndMetersModuleSustainabilityClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BuildingsAndOrganizationsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackReversalsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebacksClassPermission { /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebacksModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CollectionsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CostCentersClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardAdministratorClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DashboardAndMapsModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DistributedReportsSettingsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ENERGYSTARSubmissionsClassPermission { /** * */ run: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionsSourcesClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EmissionsSourcesModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EnergyManagerModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportBillsClassPermission { /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; /** * */ run: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportHoldClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FacilityProjectsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class FlaggedItemsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GlobalCostAvoidanceSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GreenhouseGasAdministratorClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GroupsAndBenchmarksModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalDataAnalysisClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalDataClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IntervalDataRollupClassPermission { /** * */ run: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ManuallyAdjustSavingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterSavingsSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MetersClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MoveAccountsBetweenVendorsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MoveExistingBillsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class NormalizationSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PublicDashboardsOrMapsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RateSchedulesClassPermission { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordsListAdministratorClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RecordsModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportAdministratorClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportGroupsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportsClassPermission { /** * */ run: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ReportsModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ResetUserPasswordsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RolesClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsAdjustmentsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SavingsEngineClassPermission { /** * */ run: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SendNotificationsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedBillListsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedDashboardsOrMapsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedRecordsListsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SharedReportsClassPermission { /** * */ view: boolean | null | undefined; /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UnitSystemSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateApprovedBillsClassPermission { /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdateUnitsOnExistingBillsClassPermission { /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UsersAndRolesClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UsersAndUserGroupsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorsAndRatesModuleClassPermission { /** * */ view: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorsClassPermission { /** * */ create: boolean | null | undefined; /** * */ edit: boolean | null | undefined; /** * */ delete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherSettingsClassPermission { /** * */ view: boolean | null | undefined; /** * */ manage: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PermissionsRequest { accountingSettings: AccountingSettingsClassPermission | null | undefined; accounts: AccountsClassPermission | null | undefined; accountsModule: AccountsModuleClassPermission | null | undefined; accrualSettings: AccrualSettingsClassPermission | null | undefined; costCenters: CostCentersClassPermission | null | undefined; moveAccountsBetweenVendors: MoveAccountsBetweenVendorsClassPermission | null | undefined; applicationSettings: ApplicationSettingsClassPermission | null | undefined; approveBills: ApproveBillsClassPermission | null | undefined; billWorkflowSettings: BillWorkflowSettingsClassPermission | null | undefined; billsAndBatches: BillsAndBatchesClassPermission | null | undefined; exportBills: ExportBillsClassPermission | null | undefined; exportHold: ExportHoldClassPermission | null | undefined; moveExistingBills: MoveExistingBillsClassPermission | null | undefined; sharedBillLists: SharedBillListsClassPermission | null | undefined; unitSystemSettings: UnitSystemSettingsClassPermission | null | undefined; updateApprovedBills: UpdateApprovedBillsClassPermission | null | undefined; updateUnitsOnExistingBills: UpdateUnitsOnExistingBillsClassPermission | null | undefined; budgetsAndBudgetVersions: BudgetsAndBudgetVersionsClassPermission | null | undefined; chargebacksModule: ChargebacksModuleClassPermission | null | undefined; chargebacks: ChargebacksClassPermission | null | undefined; chargebackReversals: ChargebackReversalsClassPermission | null | undefined; meterSavingsSettings: MeterSavingsSettingsClassPermission | null | undefined; savingsAdjustments: SavingsAdjustmentsClassPermission | null | undefined; manuallyAdjustSavings: ManuallyAdjustSavingsClassPermission | null | undefined; savingsEngine: SavingsEngineClassPermission | null | undefined; baselineEngine: BaselineEngineClassPermission | null | undefined; globalCostAvoidanceSettings: GlobalCostAvoidanceSettingsClassPermission | null | undefined; dashboardAndMapsModule: DashboardAndMapsModuleClassPermission | null | undefined; dashboardAdministrator: DashboardAdministratorClassPermission | null | undefined; publicDashboardsOrMaps: PublicDashboardsOrMapsClassPermission | null | undefined; sharedDashboardsOrMaps: SharedDashboardsOrMapsClassPermission | null | undefined; buildingsAndMetersModule: BuildingsAndMetersModuleClassPermission | null | undefined; groupsAndBenchmarksModule: GroupsAndBenchmarksModuleClassPermission | null | undefined; buildingAndMeterGroups: BuildingAndMeterGroupsClassPermission | null | undefined; buildingsAndOrganizations: BuildingsAndOrganizationsClassPermission | null | undefined; intervalData: IntervalDataClassPermission | null | undefined; intervalDataAnalysis: IntervalDataAnalysisClassPermission | null | undefined; energystarSubmissions: ENERGYSTARSubmissionsClassPermission | null | undefined; facilityProjects: FacilityProjectsClassPermission | null | undefined; greenhouseGasAdministrator: GreenhouseGasAdministratorClassPermission | null | undefined; intervalDataRollup: IntervalDataRollupClassPermission | null | undefined; meters: MetersClassPermission | null | undefined; normalizationSettings: NormalizationSettingsClassPermission | null | undefined; weatherSettings: WeatherSettingsClassPermission | null | undefined; reportsModule: ReportsModuleClassPermission | null | undefined; distributedReportsSettings: DistributedReportsSettingsClassPermission | null | undefined; reportAdministrator: ReportAdministratorClassPermission | null | undefined; reportGroups: ReportGroupsClassPermission | null | undefined; sharedReports: SharedReportsClassPermission | null | undefined; reports: ReportsClassPermission | null | undefined; resetUserPasswords: ResetUserPasswordsClassPermission | null | undefined; usersAndUserGroups: UsersAndUserGroupsClassPermission | null | undefined; vendorsAndRatesModule: VendorsAndRatesModuleClassPermission | null | undefined; rateSchedules: RateSchedulesClassPermission | null | undefined; vendors: VendorsClassPermission | null | undefined; flaggedItems: FlaggedItemsClassPermission | null | undefined; billListAdministrator: BillListAdministratorClassPermission | null | undefined; allInstalledReports: AllInstalledReportsClassPermission | null | undefined; sendNotifications: SendNotificationsClassPermission | null | undefined; buildingsAndMetersModuleActualData: BuildingsAndMetersModuleActualDataClassPermission | null | undefined; buildingsAndMetersModuleCalendarizedData: BuildingsAndMetersModuleCalendarizedDataClassPermission | null | undefined; buildingsAndMetersModuleNormalizedData: BuildingsAndMetersModuleNormalizedDataClassPermission | null | undefined; buildingsAndMetersModuleMeterIntervalData: BuildingsAndMetersModuleMeterIntervalDataClassPermission | null | undefined; buildingsAndMetersModuleSustainability: BuildingsAndMetersModuleSustainabilityClassPermission | null | undefined; buildingsAndMetersModuleSavings: BuildingsAndMetersModuleSavingsClassPermission | null | undefined; buildingsAndMetersModuleBudgets: BuildingsAndMetersModuleBudgetsClassPermission | null | undefined; accountsModuleActualData: AccountsModuleActualDataClassPermission | null | undefined; billsModule: BillsModuleClassPermission | null | undefined; roles: RolesClassPermission | null | undefined; emissionsSourcesModule: EmissionsSourcesModuleClassPermission | null | undefined; collections: CollectionsClassPermission | null | undefined; emissionsSources: EmissionsSourcesClassPermission | null | undefined; recordsModule: RecordsModuleClassPermission | null | undefined; records: RecordsClassPermission | null | undefined; sharedRecordsLists: SharedRecordsListsClassPermission | null | undefined; recordsListAdministrator: RecordsListAdministratorClassPermission | null | undefined; billCAPture: BillCAPtureClassPermission | null | undefined; energyManagerModule: EnergyManagerModuleClassPermission | null | undefined; usersAndRoles: UsersAndRolesClassPermission | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SystemUserRoleWithHiddenRequest { /** * Set a system user role to be hidden or shown Roles Manage permission is required to access hidden roles */ hidden: boolean | null | undefined; /** * Name of the system user role Required Must be between 0 and 64 characters */ systemUserRoleName: string | null; /** * Description of the system user role Required Must be between 0 and 1000 characters */ description: string | null; permissions: PermissionsRequest | null | undefined; } declare class UserRoleService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param body */ createUserRole(body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a user role * * @param userRoleId The identifier for the role being deleted */ deleteUserRole(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param userRoleId * @param body */ editUserRole(userRoleId: number, body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a specific user role and its permissions You need Roles.Manage or UsersAndUserGroups.View for this API * * @param userRoleId The userRoleId to get */ getUserRole(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets user roles and their permissions You need Roles.Manage or UsersAndUserGroups.View for this API * */ getUserRoles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param userRoleId * @param body */ setUserRoleHidden(userRoleId: number, body?: HiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ createUserRoleWithHttpInfo(body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a user role * * @param userRoleId The identifier for the role being deleted */ deleteUserRoleWithHttpInfo(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param userRoleId * @param body */ editUserRoleWithHttpInfo(userRoleId: number, body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a specific user role and its permissions You need Roles.Manage or UsersAndUserGroups.View for this API * * @param userRoleId The userRoleId to get */ getUserRoleWithHttpInfo(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets user roles and their permissions You need Roles.Manage or UsersAndUserGroups.View for this API * */ getUserRolesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param userRoleId * @param body */ setUserRoleHiddenWithHttpInfo(userRoleId: number, body?: HiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AddressLookup { /** * */ addressTypeId: number | null | undefined; /** * */ line1: string | null | undefined; /** * */ line2: string | null | undefined; /** * */ line3: string | null | undefined; /** * */ city: string | null | undefined; /** * */ state: string | null | undefined; /** * */ country: string | null | undefined; /** * */ postalCode: string | null | undefined; /** * */ latitude: number | null | undefined; /** * */ longitude: number | null | undefined; /** * */ uniqueLocationIdentifier: string | null | undefined; /** * */ locationProperties: { [key: string]: any; } | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ChargebackProcessorSettingsForAggregations { /** * End period of Billing Period range to be processed Valid billing period between 190001 and 300001 */ billingPeriod: number | null | undefined; /** * Optional note/comment */ note: string | null | undefined; batchSettings: BatchCreate | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class CreateUtilityPlatformMeter { /** * The meter code Required Must be between 0 and 32 characters */ meterCode: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessReleaseMetaData { /** * */ accountNumber: string | null | undefined; /** * */ nameOnBill: string | null | undefined; /** * */ serviceAddress: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessRelease { /** * Data Access Release Identifier */ dataAccessReleaseId: number | null | undefined; metaData: DataAccessReleaseMetaData | null | undefined; /** * File name of the uploaded release form This is only saved on a manual data release request Null when request was completed by email */ releaseForm: string | null | undefined; /** * Date and time the data release request was submitted */ submittedDate: Date | null | undefined; /** * Email address of the person who completed the request */ submittedBy: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessReleaseNoFileRequest { /** * Account Number Should be a 12 digit number starting with 2. Required */ accountNumber: string | null; /** * Required */ nameOnBill: string | null; /** * Required */ serviceAddress: string | null; /** * Is the data release declined If true is passed the data provider must support declining a data release otherwise this will throw an exception */ declined: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessReleaseRequest { /** * The response from uploading the file to the file store API: POST /api/v202105/fileStore/fileDataType/{fileDataTypeId}/upload SDK Operation: UploadFile */ dataReleaseFile: string | null | undefined; /** * Account Number Should be a 12 digit number starting with 2. Required */ accountNumber: string | null; /** * Required */ nameOnBill: string | null; /** * Required */ serviceAddress: string | null; /** * Is the data release declined If true is passed the data provider must support declining a data release otherwise this will throw an exception */ declined: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessReleaseStatus { /** * Id of the Data Access Release Status Possible values are: 1 - Not Applicable 2 - Required 3 - Pending 4 - Released 5 - Declined */ dataAccessReleaseStatusId: number | null | undefined; /** * Data Access Release Status Information Possible values are: Not Applicable Required Pending Released Declined */ dataAccessReleaseStatusInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class DataAccessReleaseState { /** * The date that the data access release was submitted. Null if there is not a release yet. */ submittedDate: Date | null | undefined; releaseStatus: DataAccessReleaseStatus | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Parameters to use for performing a utility platform meter search */ declare class MeterSearchRequest { /** * Type of input to use for meter search One of 'Address', 'SerialNumber' */ searchType: string | null | undefined; /** * List of premise ids to search for Required when SearchType is set to Address List cannot be empty Only one of Addresses, SerialNumbers can be set */ addresses: Array | null | undefined; /** * List of serial numbers to search for Required when SearchType is set to SerialNumber List cannot be empty Only one of Addresses, SerialNumbers can be set */ serialNumbers: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * */ declare class MoveCreateMeter { /** * The meter code */ meterCode: string | null | undefined; /** * The meter display name */ meterDisplay: string | null | undefined; commodity: CommodityChild | null | undefined; /** * The meter serial number */ serialNumber: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SendDataAccessReleaseRequest { /** * Sets the reply-to email address Must be between 0 and 128 characters Required */ replyTo: string | null; /** * The list of recipient email addresses Cannot be Empty */ recipients: Array | null | undefined; /** * The subject of the data access release request email Required Must be between 0 and 255 characters */ subject: string | null; /** * The body of the data access release request email Required */ message: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpsertAggregateMeterRequest { /** * Aggregation Meter Identifier If AggregateMeterId is null: a new aggregate meter and version is always created If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error If AggregateMeterId exists: we will always update the Aggregate's MeterInfo and AccountInfo If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated Required (defined) */ aggregateMeterId: number | null | undefined; /** * Begin period for the version in the format YYYYMM Required Valid billing period between 190001 and 300001 */ beginPeriod: number | null; /** * Meters to aggregate All meters must match the commodity of the aggregate meter All meters must be on the place the aggregate is created All meters should be hidden Required Cannot be Empty */ sourceMeterIds: Array | null; /** * The identifier for the aggregate meter's commodity Required */ commodityId: number | null; /** * The aggregate meter info Required Must be between 0 and 50 characters */ aggregateMeterInfo: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MostRecentAggregate { /** * The identifier of the aggregate meter */ aggregateMeterId: number | null | undefined; /** * The effective date of the aggregation */ effectiveDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UtilityPlatformMeter { meterAddress: AddressChild | null | undefined; dataAccessReleaseStatus: DataAccessReleaseStatus | null | undefined; mostRecentAggregate: MostRecentAggregate | null | undefined; /** * The meter identifier */ meterId: number | null | undefined; /** * The meter code */ meterCode: string | null | undefined; /** * The meter info */ meterInfo: string | null | undefined; meterType: MeterTypeChild | null | undefined; commodity: CommodityChild | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is an ESA calculated meter */ isEsaCalculatedMeter: boolean | null | undefined; /** * Indicates whether the meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; /** * The meter's current serial number */ serialNumber: string | null | undefined; } declare class UtilityPlatformService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Apply a release to a meter * * @param meterId The id of the meter * @param body */ assignDataAccessRelease(meterId: number, body?: DataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create meters on a particular place * * @param placeId The id of the place * @param body The meters to create on the place */ createUtilityPlatformMetersByPlace(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process one or more Calculated Bill aggregations within a billing period range ending with the specified billing period. If billing period is not supplied, the current period will be assumed. * * @param body */ executeProcessorAggregations(body?: ChargebackProcessorSettingsForAggregations, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get data access release details * * @param dataAccessReleaseId The id of the data access release */ getDataAccessReleaseDetails(dataAccessReleaseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the status of a meter's data access release * * @param meterId The meter to get release state for */ getDataAccessReleaseState(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get meters on a particular place * * @param placeId The id of the place */ getUtilityPlatformMetersByPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Release all account and meters to a specific place * * @param placeId The id of the place for the released meters * @param body */ releaseAccountAndAllMeterToABuilding(placeId: number, body?: DataAccessReleaseNoFileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMeters(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddresses(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Email a data access release request * * @param meterId The meter that the release is for * @param body The release request details */ sendDataAccessReleaseRequestEmail(meterId: number, body?: SendDataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new aggregate meter, update an existing version, create a new version If AggregateMeterId is null: a new aggregate meter and version is always created If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error If AggregateMeterId exists: we will always update the Aggregate's MeterInfo and AccountInfo If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated * * @param placeId The id of the place to insert the aggregate meter * @param body The release request details */ upsertAggregateMeter(placeId: number, body?: UpsertAggregateMeterRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Apply a release to a meter * * @param meterId The id of the meter * @param body */ assignDataAccessReleaseWithHttpInfo(meterId: number, body?: DataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create meters on a particular place * * @param placeId The id of the place * @param body The meters to create on the place */ createUtilityPlatformMetersByPlaceWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Process one or more Calculated Bill aggregations within a billing period range ending with the specified billing period. If billing period is not supplied, the current period will be assumed. * * @param body */ executeProcessorAggregationsWithHttpInfo(body?: ChargebackProcessorSettingsForAggregations, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get data access release details * * @param dataAccessReleaseId The id of the data access release */ getDataAccessReleaseDetailsWithHttpInfo(dataAccessReleaseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the status of a meter's data access release * * @param meterId The meter to get release state for */ getDataAccessReleaseStateWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get meters on a particular place * * @param placeId The id of the place */ getUtilityPlatformMetersByPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Release all account and meters to a specific place * * @param placeId The id of the place for the released meters * @param body */ releaseAccountAndAllMeterToABuildingWithHttpInfo(placeId: number, body?: DataAccessReleaseNoFileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMetersWithHttpInfo(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddressesWithHttpInfo(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Email a data access release request * * @param meterId The meter that the release is for * @param body The release request details */ sendDataAccessReleaseRequestEmailWithHttpInfo(meterId: number, body?: SendDataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new aggregate meter, update an existing version, create a new version If AggregateMeterId is null: a new aggregate meter and version is always created If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error If AggregateMeterId exists: we will always update the Aggregate's MeterInfo and AccountInfo If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated * * @param placeId The id of the place to insert the aggregate meter * @param body The release request details */ upsertAggregateMeterWithHttpInfo(placeId: number, body?: UpsertAggregateMeterRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemplateVendorLineRequest { /** * Specifies the type of line to create Only cost observation types are allowed To get the valid list of observation type ids call the GetObservationTypes API with ?filter=nounId one of '4'|'6'|'23' Required */ observationTypeId: number | null; /** * The label for this line, that will be shown on the bill Required Must be between 0 and 100 characters */ caption: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class UpdatedOnlyResult { /** * Required (defined) */ updated: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorAuditEnable { /** * True to allow all vendor accounts' bills to be audited False to exclude all vendor accounts' bills from being audited Required (defined) */ auditEnabled: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorContractResponse { /** * The contract identifier */ contractId: number | null | undefined; /** * The contract code */ contractCode: string | null | undefined; /** * The contract info */ contractInfo: string | null | undefined; /** * The start date of the contract */ startDate: Date | null | undefined; /** * The expiration date of the contract */ expirationDate: Date | null | undefined; /** * Contract notes */ notes: string | null | undefined; vendor: VendorChild | null | undefined; commodity: CommodityChild | null | undefined; /** * The date a reminder will be sent for the contract expiration */ renewalReminderDate: Date | null | undefined; /** * Is this a Green Energy contract */ isGreenEnergy: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorEdit { /** * An array of vendor code aliases. Vendor alias cannot match an existing vendor code or another alias in the system. All alias entries will replace existing ones. Empty or null array will remove all existing aliases. Maximum of 5 aliases, each with a maximum length of 50 characters. Max length of 5 Required */ vendorCodeAliases: Array | null; /** * The vendor code Required Must be between 0 and 16 characters */ vendorCode: string | null; /** * The vendor info Required Must be between 0 and 50 characters */ vendorInfo: string | null; /** * The vendor's website Must be between 0 and 255 characters Required (defined) */ website: string | null | undefined; /** * The vendor's email address Must be between 0 and 128 characters Required (defined) */ email: string | null | undefined; /** * The vendor's phone number Must be between 0 and 50 characters Required (defined) */ phoneNumber: string | null | undefined; address: AddressChild | null | undefined; /** * A description of the vendor Must be between 0 and 4000 characters Required (defined) */ vendorDescription: string | null | undefined; /** * File name referencing a PDF document that contains the customer's consent to be represented to the vendor. The document must have already been uploaded to temporary filestore storage (see POST FileStore in API docs). Must be between 0 and 260 characters Required (defined) */ consentToRepresent: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorRequest { /** * The vendor code Required Must be between 0 and 16 characters */ vendorCode: string | null; /** * The vendor info Required Must be between 0 and 50 characters */ vendorInfo: string | null; /** * The vendor's website Must be between 0 and 255 characters */ website: string | null | undefined; /** * The vendor's email address Must be between 0 and 128 characters */ email: string | null | undefined; /** * The vendor's phone number Must be between 0 and 50 characters */ phoneNumber: string | null | undefined; address: AddressChild | null | undefined; /** * A description of the vendor Must be between 0 and 4000 characters */ vendorDescription: string | null | undefined; /** * File name referencing a PDF document that contains the customer's consent to be represented to the vendor. The document must have already been uploaded to temporary filestore storage (see POST FileStore in API docs). Must be between 0 and 260 characters */ consentToRepresent: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorResponse { /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * An array of vendor code aliases */ vendorCodeAliases: Array | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; address: AddressChild | null | undefined; /** * The vendor's edi code */ ediCode: string | null | undefined; /** * The pay days */ payDays: number | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the vendor was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date and time of the most recent modification */ modifiedDate: Date | null | undefined; /** * The vendor's website */ website: string | null | undefined; /** * The vendor's email address */ email: string | null | undefined; /** * The vendor's phone number */ phoneNumber: string | null | undefined; /** * The vendor's rates */ rates: Array | null | undefined; /** * A description of the vendor */ vendorDescription: string | null | undefined; /** * If there are settings configured to split account charges for this vendor This will only be true when the setting applies to all accounts for this vendor */ splitAccountChargesConfigured: boolean | null | undefined; /** * A link to the document containing the customer's consent for us to represent them to the vendor */ consentToRepresent: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorUDFResponse { /** * The vendor identifier */ vendorId: number | null | undefined; /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; /** * An array of user-defined fields (UDFs) */ udfs: Array | null | undefined; } declare class VendorService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Add accounts to a vendor * * @param vendorId The identifier for the vendor to which accounts are being added * @param body List of accountIds to move a new vendor */ addAccounts(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Copies any template attached to the provided sourceVendorId to each of the recipientVendorIds specified in the body. If the recipient vendor has a template defined, it will be replaced with the lines on the source vendor's template. If the recipient vendor does not have a template defined, a new template will be created with the lines on the source vendor's template. * * @param sourceVendorId Identifier for the \"Source\" vendor, which serves as the source for the template to be copied * @param body List of identifiers for the \"Recipient\" vendors, who will each receive a copy of the template attached to the Source vendor */ copyVendorTemplate(sourceVendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a vendor * * @param body Data representing the vendor being created */ createVendor(body?: VendorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a vendor * * @param vendorId The identifier for the vendor being deleted */ deleteVendor(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a vendor custom field * * @param vendorId * @param udfId */ downloadVendorCustomFieldFile(vendorId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a vendor * * @param vendorId The identifier for the vendor being edited * @param body Data representing the vendor being edited */ editVendor(vendorId: number, body?: VendorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular vendor * * @param vendorId The identifier for the vendor * @param body Data representing the vendor user defined fields / custom fields being edited */ editVendorUDFs(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one vendor * * @param vendorId The identifier for the vendor being retrieved */ getVendor(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Contracts for a particular vendor. Contracts are not supported in EnergyCAP Version 7, this API is for reading existing contracts only and may be removed in the future. * * @param vendorId The vendor identifier for which Contracts are being retrieved */ getVendorContracts(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the most recent template from the specified vendor * * @param vendorId The vendor identifier to search by */ getVendorTemplate(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all user defined fields / custom fields for a particular vendor * * @param vendorId The vendor identifier for which user defined field / custom field values are being retrieved */ getVendorUdfs(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates the template for the specified vendor * * @param vendorId The vendor to apply the template to * @param body Definition of the lines to apply to the template. If vendorLines is empty, any existing template will be deleted */ putVendorTemplate(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Enable or disable all accounts assigned to a vendor from audits * * @param vendorId The identifier for the vendor to act upon * @param body */ setVendorAccountsAuditExclusion(vendorId: number, body?: VendorAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Add accounts to a vendor * * @param vendorId The identifier for the vendor to which accounts are being added * @param body List of accountIds to move a new vendor */ addAccountsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Copies any template attached to the provided sourceVendorId to each of the recipientVendorIds specified in the body. If the recipient vendor has a template defined, it will be replaced with the lines on the source vendor's template. If the recipient vendor does not have a template defined, a new template will be created with the lines on the source vendor's template. * * @param sourceVendorId Identifier for the \"Source\" vendor, which serves as the source for the template to be copied * @param body List of identifiers for the \"Recipient\" vendors, who will each receive a copy of the template attached to the Source vendor */ copyVendorTemplateWithHttpInfo(sourceVendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a vendor * * @param body Data representing the vendor being created */ createVendorWithHttpInfo(body?: VendorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a vendor * * @param vendorId The identifier for the vendor being deleted */ deleteVendorWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a vendor custom field * * @param vendorId * @param udfId */ downloadVendorCustomFieldFileWithHttpInfo(vendorId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a vendor * * @param vendorId The identifier for the vendor being edited * @param body Data representing the vendor being edited */ editVendorWithHttpInfo(vendorId: number, body?: VendorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular vendor * * @param vendorId The identifier for the vendor * @param body Data representing the vendor user defined fields / custom fields being edited */ editVendorUDFsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one vendor * * @param vendorId The identifier for the vendor being retrieved */ getVendorWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Contracts for a particular vendor. Contracts are not supported in EnergyCAP Version 7, this API is for reading existing contracts only and may be removed in the future. * * @param vendorId The vendor identifier for which Contracts are being retrieved */ getVendorContractsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the most recent template from the specified vendor * * @param vendorId The vendor identifier to search by */ getVendorTemplateWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular vendor * * @param vendorId The vendor identifier for which user defined field / custom field values are being retrieved */ getVendorUdfsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates the template for the specified vendor * * @param vendorId The vendor to apply the template to * @param body Definition of the lines to apply to the template. If vendorLines is empty, any existing template will be deleted */ putVendorTemplateWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Enable or disable all accounts assigned to a vendor from audits * * @param vendorId The identifier for the vendor to act upon * @param body */ setVendorAccountsAuditExclusionWithHttpInfo(vendorId: number, body?: VendorAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorDigestActualYearlyResponseCommodityResults { /** * year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Common Use */ commonUse: number | null | undefined; /** * Common Use Unit Cost */ commonUseUnitCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorDigestActualYearlyResponseCommodityData { /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; commonUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorDigestActualYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Global Use */ globalUse: number | null | undefined; /** * Global Use Unit Cost */ globalUseUnitCost: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class VendorDigestActualYearlyResponse { /** * The vendor code */ vendorCode: string | null | undefined; /** * The vendor info */ vendorInfo: string | null | undefined; /** * The vendor identifier */ vendorId: number | null | undefined; globalUseUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; /** * An array of yearly data per commodity */ commodities: Array | null | undefined; } declare class VendorDigestService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves rolled up actual billing data by vendor for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param vendorId The vendor to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getVendorActualYearly(vendorId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by vendor for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param vendorId The vendor to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getVendorActualYearlyWithHttpInfo(vendorId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherStationSummary { /** * Begin date for this weather station May differ from the begin date provided by the user if the most recent weather reading for this station was earlier. */ beginDate: Date | null | undefined; /** * Earliest reading date imported for this weather station May differ from the begin date provided by the user if the most recent weather reading available for this station was later. */ earliestReadingDate: Date | null | undefined; /** * Weather station ID */ weatherStationId: number | null | undefined; /** * Weather station code */ weatherStationCode: string | null | undefined; /** * Weather station name */ weatherStationName: string | null | undefined; /** * Source weather station code (if any) */ baseWeatherStationCode: string | null | undefined; /** * Number of readings imported */ numberOfReadingsImported: number | null | undefined; /** * Number of readings failed to import */ numberOfFailedReadings: number | null | undefined; /** * Channel ID */ channelId: number | null | undefined; /** * Channel code */ channelCode: string | null | undefined; /** * Channel interval in seconds */ channelIntervalInSeconds: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherImportResult { /** * The begin date of the weather data that was imported */ beginDate: Date | null | undefined; /** * The end date of the weather data that was imported */ endDate: Date | null | undefined; /** * List of weather stations and the number of readings that were imported for each */ weatherStationSummaries: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherImportSettings { /** * List of weather station codes for which to import data If omitted or empty, weather data will be imported for all weather stations which are assigned to buildings */ weatherStationCodes: Array | null | undefined; /** * The begin date for the weather data Readings will be imported from this date through the current date If omitted or empty, weather data will be imported for the past 31 days */ beginDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WeatherStationResponse { /** * ID of the weather station */ stationId: number | null | undefined; /** * Weather station code */ stationCode: string | null | undefined; /** * Weather station info */ stationInfo: string | null | undefined; /** * Code of the base weather station Will be null if not linked */ baseStationCode: string | null | undefined; channel: ChannelChild | null | undefined; } declare class WeatherStationService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get weather stations. Includes custom-created weather stations * */ getWeatherStations(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Import mean daily temperature readings for weather stations which are connected to EnergyCAP weather services * ### Other Remarks By default, this endpoint may be called without parameters to import weather for all \"used\" weather stations (at least one building is assigned to it) beginning from the current date minus 31 days. By providing a begin date, API users may go further back in history to backfill missing weather data. If a weather station has no readings at all, then the begin date will be set to 1899-12-31 so we can import history However the begin date is ascertained, readings will be imported from that date through today's date, overwriting any existing readings or filling in any missing readings. The API user may also provide a list of weather station codes. Even if the provided stations are not yet used, weather readings will be imported for them. * @param body */ importWeatherData(body?: WeatherImportSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get weather stations. Includes custom-created weather stations * */ getWeatherStationsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Import mean daily temperature readings for weather stations which are connected to EnergyCAP weather services * ### Other Remarks By default, this endpoint may be called without parameters to import weather for all \"used\" weather stations (at least one building is assigned to it) beginning from the current date minus 31 days. By providing a begin date, API users may go further back in history to backfill missing weather data. If a weather station has no readings at all, then the begin date will be set to 1899-12-31 so we can import history However the begin date is ascertained, readings will be imported from that date through today's date, overwriting any existing readings or filling in any missing readings. The API user may also provide a list of weather station codes. Even if the provided stations are not yet used, weather readings will be imported for them. * @param body */ importWeatherDataWithHttpInfo(body?: WeatherImportSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ArcadiaAccountCustomData { /** * */ processBillsAfter: string | null | undefined; /** * */ billCAPtureClientCode: string | null | undefined; /** * */ billCAPtureNotes: string | null | undefined; /** * */ billCaptureEnabled: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ArcadiaProvider { /** * */ country: string | null | undefined; /** * Required */ id: string | null; /** * */ intervalServiceTypes: Array | null | undefined; /** * */ isIntervalDataSupported: boolean | null | undefined; /** * */ isIntervalFileUploadSupported: boolean | null | undefined; /** * */ isRealTimeCredentialValidationSupported: boolean | null | undefined; /** * */ name: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ArcadiaAccount { /** * Required */ accountNumber: string | null; /** * */ billingCycle: string | null | undefined; /** * */ correlationIds: Array | null | undefined; /** * */ createdAt: Date | null | undefined; /** * */ createdBy: string | null | undefined; customData: ArcadiaAccountCustomData | null; /** * */ firstExtractedAt: Date | null | undefined; /** * Required */ id: string | null; /** * */ isAccessible: boolean | null | undefined; /** * */ isCustomerActionRequired: boolean | null | undefined; /** * */ isHistoryFulfilled: boolean | null | undefined; /** * */ isIntervalsThirdPartyPortalAccount: boolean | null | undefined; /** * */ isStatementsProductActive: boolean | null | undefined; /** * */ lastModifiedAt: Date | null | undefined; /** * */ lastModifiedBy: string | null | undefined; /** * */ lastSuccessfulStatementExtractionAt: Date | null | undefined; /** * */ latestNewStatementAt: Date | null | undefined; /** * */ latestStatementDate: string | null | undefined; /** * */ nextExpectedPostDate: string | null | undefined; /** * */ normalizedAccountNumber: string | null | undefined; /** * */ prepaid: boolean | null | undefined; provider: ArcadiaProvider | null; /** * */ providerClassification: string | null | undefined; /** * */ siteNames: Array | null | undefined; /** * */ status: string | null | undefined; /** * */ statusDetail: string | null | undefined; /** * */ summaryAccountId: string | null | undefined; /** * */ summaryAccountNumber: string | null | undefined; /** * */ type: string | null | undefined; /** * */ voidedAt: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BulkImportArcadiaCredentialRequest { /** * */ correlationId: string | null | undefined; /** * */ createdAt: Date | null | undefined; /** * */ createdBy: string | null | undefined; /** * */ customerGivenWebsite: string | null | undefined; /** * Required */ id: string | null; /** * */ isAccessible: boolean | null | undefined; /** * */ isActive: boolean | null | undefined; /** * */ isCustomerActionRequired: boolean | null | undefined; /** * */ isThirdPartyPortal: boolean | null | undefined; /** * */ lastModifiedAt: Date | null | undefined; /** * */ lastModifiedBy: string | null | undefined; /** * */ lastSuccessfulMultiFactorAuthenticationOptOutAt: Date | null | undefined; /** * */ multiFactorAuthenticationOptOutStatus: string | null | undefined; /** * */ nextScheduledAccountRunAt: Date | null | undefined; provider: ArcadiaProvider | null; /** * */ status: string | null | undefined; /** * */ statusDetail: string | null | undefined; /** * */ totalAccounts: number | null | undefined; /** * */ username: string | null | undefined; /** * */ username2: string | null | undefined; /** * */ username3: string | null | undefined; /** * */ username4: string | null | undefined; /** * */ website: string | null | undefined; /** * Required */ accounts: Array | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BulkImportArcadiaCredentialsResponse { /** * */ credentialsCreated: number | null | undefined; /** * */ credentialsUpdated: number | null | undefined; /** * */ credentialsDeleted: number | null | undefined; /** * */ accountsCreated: number | null | undefined; /** * */ accountsUpdated: number | null | undefined; /** * */ accountsDeleted: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebCaptureAccountResponse { /** * */ webCaptureAccountId: number | null | undefined; /** * */ billCaptureClientCode: string | null | undefined; /** * */ accountNumber: string | null | undefined; /** * */ status: string | null | undefined; /** * */ statusDetail: string | null | undefined; /** * */ providerName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebCapturePartnerResponse { /** * */ webCapturePartnerId: number | null | undefined; /** * */ webCapturePartnerInfo: string | null | undefined; /** * */ webCapturePartnerCode: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebCaptureCredentialDetailsResponse { /** * */ webCaptureAccounts: Array | null | undefined; /** * */ webCaptureCredentialId: number | null | undefined; webCapturePartner: WebCapturePartnerResponse | null | undefined; /** * */ billCaptureClientCode: string | null | undefined; /** * */ status: string | null | undefined; /** * */ statusDetail: string | null | undefined; /** * */ website: string | null | undefined; /** * */ username: string | null | undefined; /** * */ isActive: boolean | null | undefined; /** * */ totalAccounts: number | null | undefined; /** * */ providerName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebCaptureCredentialResponse { /** * */ webCaptureCredentialId: number | null | undefined; webCapturePartner: WebCapturePartnerResponse | null | undefined; /** * */ billCaptureClientCode: string | null | undefined; /** * */ status: string | null | undefined; /** * */ statusDetail: string | null | undefined; /** * */ website: string | null | undefined; /** * */ username: string | null | undefined; /** * */ isActive: boolean | null | undefined; /** * */ totalAccounts: number | null | undefined; /** * */ providerName: string | null | undefined; } declare class WebCaptureCredentialService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Bulk import Arcadia credentials and their associated accounts * * @param body The list of Arcadia credentials to import */ bulkImportArcadiaCredentials(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a WebCAPture Credential by ID * * @param webCaptureCredentialId The WEBCapture Credential identifier */ getWebCaptureCredential(webCaptureCredentialId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentials(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Bulk import Arcadia credentials and their associated accounts * * @param body The list of Arcadia credentials to import */ bulkImportArcadiaCredentialsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a WebCAPture Credential by ID * * @param webCaptureCredentialId The WEBCapture Credential identifier */ getWebCaptureCredentialWithHttpInfo(webCaptureCredentialId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentialsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookCreateRequest { /** * The name of the webhook Required Must be between 0 and 64 characters */ webhookName: string | null; /** * The description for the webhook */ webhookDescription: string | null | undefined; /** * The type of event that will trigger the webhook Required */ webhookEventTypeId: number | null; /** * List of email addresses. Each recipient in this list will receive an email when a webhook fails or gets disabled Required Cannot be Empty */ mailingList: Array | null; /** * The URL to be invoked by the webhook Required */ url: string | null; /** * The encryption secret. Required */ secret: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookEditRequest { /** * The webhook activation status (true=Active, false=Inactive) Required */ active: boolean | null; /** * The name of the webhook Required Must be between 0 and 64 characters */ webhookName: string | null; /** * The description for the webhook Required (defined) */ webhookDescription: string | null | undefined; /** * The type of event that will trigger the webhook Required */ webhookEventTypeId: number | null; /** * List of email addresses. Each recipient in this list will receive an email when a webhook fails or gets disabled Required Cannot be Empty */ mailingList: Array | null; /** * The URL to be invoked by the webhook Required */ url: string | null; /** * The encryption secret. Required */ secret: string | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookEventTypeChild { /** * The identifier for the webhook event type */ webhookEventTypeId: number | null | undefined; /** * The name of the webhook event type */ webhookEventTypeName: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookLogResponse { /** * The identifier of the webhook log */ webhookLogId: number | null | undefined; /** * The date and time that the webhook was fired */ requestTimestamp: Date | null | undefined; /** * The HTTP status code that was received from the configured url 0 indicates no response was received from the configured url */ result: string | null | undefined; user: UserChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WebhookResponse { /** * The identifier of the webhook */ webhookId: number | null | undefined; /** * The name of the webhook */ webhookName: string | null | undefined; /** * The description of the webhook */ webhookDescription: string | null | undefined; createdBy: UserChild | null | undefined; /** * The date and time the webhook was created */ createdDate: Date | null | undefined; /** * List of email addresses. Each recipient in this list will receive an email when a webhook fails or gets disabled */ mailingList: Array | null | undefined; /** * The percentage of success for the webhook */ successRate: number | null | undefined; /** * The activation status of the webhook */ webhookStatus: string | null | undefined; /** * Locked webhooks cannot be edited. Locked webhooks will also NOT be automatically disabled on 10 consecutive failures */ locked: boolean | null | undefined; /** * The URL to be invoked by the webhook */ url: string | null | undefined; /** * The encryption secret */ secret: string | null | undefined; eventType: WebhookEventTypeChild | null | undefined; } declare class WebhookService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new webhook * * @param body */ createWebhook(body?: WebhookCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a webhook * * @param webhookId */ deleteWebhook(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete webhook logs older than the number of days provided only if the number of logs per webhook is in excess of 100. 100 latest logs per webhook will always be maintained * * @param olderThanDays Defaults to 3 */ deleteWebhookLogsOlderThan(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing webhook * * @param webhookId * @param body */ editWebhook(webhookId: number, body?: WebhookEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a single webhook * * @param webhookId */ getWebhook(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get webhook event types * */ getWebhookEventTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get details for a webhook log * * @param webhookId * @param webhookLogId */ getWebhookLogDetails(webhookId: number, webhookLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogs(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all webhooks * * @param filter */ getWebhooks(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new webhook * * @param body */ createWebhookWithHttpInfo(body?: WebhookCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a webhook * * @param webhookId */ deleteWebhookWithHttpInfo(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete webhook logs older than the number of days provided only if the number of logs per webhook is in excess of 100. 100 latest logs per webhook will always be maintained * * @param olderThanDays Defaults to 3 */ deleteWebhookLogsOlderThanWithHttpInfo(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing webhook * * @param webhookId * @param body */ editWebhookWithHttpInfo(webhookId: number, body?: WebhookEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single webhook * * @param webhookId */ getWebhookWithHttpInfo(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get webhook event types * */ getWebhookEventTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get details for a webhook log * * @param webhookId * @param webhookLogId */ getWebhookLogDetailsWithHttpInfo(webhookId: number, webhookLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogsWithHttpInfo(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all webhooks * * @param filter */ getWebhooksWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ActionableBillCounts { /** * Count of bills Held from Export */ exportHoldCount: number | null | undefined; /** * Count of bills Waiting for Export to AP */ apExportCount: number | null | undefined; /** * Count of bills Waiting for Export to GL */ glExportCount: number | null | undefined; /** * Count of bills which are Not Approved */ approvalCount: number | null | undefined; /** * Count of bills with unresolved flags */ auditProblemCount: number | null | undefined; /** * Count of bills created in the last seven days */ createdLastSevenDaysCount: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MonthlyTimeSeriesValue { /** * */ id: number | null | undefined; /** * */ formattedValue: string | null | undefined; /** * */ month: number | null | undefined; /** * */ value: number | null | undefined; /** * */ unit: string | null | undefined; /** * */ rawValue: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeSeriesEntity { /** * */ type: string | null | undefined; /** * */ id: number | null | undefined; /** * */ display: string | null | undefined; /** * */ secondaryDisplay: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ActualVsBudgetResponse { budgetPeriodRange: PeriodRange | null | undefined; /** * */ totals: Array | null | undefined; /** * */ entities: Array | null | undefined; /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGPerformanceComparison { /** * The record type */ type: string | null | undefined; /** * The performance comparison identifier */ id: number | null | undefined; /** * The label */ label: string | null | undefined; /** * The current use */ currentUse: number | null | undefined; /** * The current cost */ currentCost: number | null | undefined; /** * The current emissions */ currentEmissions: number | null | undefined; /** * The previous use */ previousUse: number | null | undefined; /** * The previous cost */ previousCost: number | null | undefined; /** * The previous emissions */ previousEmissions: number | null | undefined; /** * The use KPI variance */ usePercentDiff: number | null | undefined; /** * The cost KPI variance */ costPercentDiff: number | null | undefined; /** * The emission KPI variance */ emissionsPercentDiff: number | null | undefined; useUnit: UnitChild | null | undefined; emissionsUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose period range comparison DTO */ declare class PeriodRangeComparison { currentPeriodRange: PeriodRange | null | undefined; previousPeriodRange: PeriodRange | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AggregatedComparisonResponseGHGPerformanceComparison { periodRange: PeriodRangeComparison | null | undefined; total: GHGPerformanceComparison | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ItemRankResponse { /** * The item type */ type: string | null | undefined; /** * The item identifier */ id: number | null | undefined; /** * The item display name */ display: string | null | undefined; /** * The item formated value */ secondaryDisplay: string | null | undefined; /** * The item value */ value: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AggregatedItemRankResponse { period: PeriodRange | null | undefined; /** * The display unit of the values */ displayUnit: string | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MonthlyCAPTrend { /** * The actual cost */ actualCost: number | null | undefined; /** * The cap cost */ capCost: number | null | undefined; /** * The avoided cost */ avoidedCost: number | null | undefined; /** * The percent cost */ percentCost: number | null | undefined; /** * The billing period */ billingPeriod: number | null | undefined; /** * The fiscal period */ fiscalPeriod: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AggregatedMonthlyCAPTrendResponse { fiscalPeriodRange: PeriodRange | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceInfo { /** * The place identifier */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGBuildingRank { placeInfo: PlaceInfo | null | undefined; /** * The place size */ placeSize: number | null | undefined; placeSizeUnit: UnitChild | null | undefined; /** * The overall Greenhouse Gas emissions */ emissions: number | null | undefined; /** * The Greenhouse Gas emissions from Scope 1 */ scope1Emissions: number | null | undefined; /** * The Greenhouse Gas emissions from Scope 2 */ scope2Emissions: number | null | undefined; /** * The Greenhouse Gas emissions from Scope 3 */ scope3Emissions: number | null | undefined; emissionsUnit: UnitChild | null | undefined; /** * The Greenhouse Gas intensity. Emissions/Place Size */ intensity: number | null | undefined; /** * The item type */ type: string | null | undefined; /** * The item identifier */ id: number | null | undefined; /** * The item display name */ display: string | null | undefined; /** * The item formated value */ secondaryDisplay: string | null | undefined; /** * The item value */ value: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AggregatedResponseGHGBuildingRank { period: PeriodRange | null | undefined; total: GHGBuildingRank | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ItemRankWithUnitResponse { valueUnit: UnitChild | null | undefined; /** * The item type */ type: string | null | undefined; /** * The item identifier */ id: number | null | undefined; /** * The item display name */ display: string | null | undefined; /** * The item formated value */ secondaryDisplay: string | null | undefined; /** * The item value */ value: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AggregatedResponseItemRankWithUnitResponse { period: PeriodRange | null | undefined; total: ItemRankWithUnitResponse | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillsOverdueFromVendorResponse { account: AccountChild | null | undefined; costCenter: CostCenterChild | null | undefined; /** * */ endDate: Date | null | undefined; /** * */ directCost: number | null | undefined; /** * */ days: number | null | undefined; /** * */ gapDays: number | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose date range DTO */ declare class DateRange { /** * The start date for the range */ startDate: Date | null | undefined; /** * The end date for the range */ endDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class HighPrecisionTimeSeriesValue { /** * */ date: Date | null | undefined; /** * Value, as a decimal. Note that this could be very large, and/or to a high degree of precision. In particular, in Javascript, it might not be able to be precisely represented in a 64-bit float. See: `formattedValue`. */ value: number | null | undefined; /** * Value, serialized as a String. This is the value that should be displayed to the User. If Value is very large or to a high degree of precision its Number value in Javascript cannot be relied upon. Other client languages might have similar limitations. In order to guarantee that Value is displayed to the User to the same degree of precision as is stored in the readings database, this `formattedValue` property must be used. */ formattedValue: string | null | undefined; /** * The Unit that `Value` is expressed in. E.g. \"kWh\". */ unit: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Time series value DTO. Includes a `formattedValue` to overcome client Number-parsing limitations. */ declare class HighPrecisionValue { /** * Value, as a decimal. Note that this could be very large, and/or to a high degree of precision. In particular, in Javascript, it might not be able to be precisely represented in a 64-bit float. See: `formattedValue`. */ value: number | null | undefined; /** * Value, serialized as a String. This is the value that should be displayed to the User. If Value is very large or to a high degree of precision its Number value in Javascript cannot be relied upon. Other client languages might have similar limitations. In order to guarantee that Value is displayed to the User to the same degree of precision as is stored in the readings database, this `formattedValue` property must be used. */ formattedValue: string | null | undefined; /** * The Unit that `Value` is expressed in. E.g. \"kWh\". */ unit: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * A collection of four summarized Values identified as \"min\", \"max\", \"sum\", \"average\". */ declare class TimeSeriesSummary { min: HighPrecisionTimeSeriesValue | null | undefined; max: HighPrecisionTimeSeriesValue | null | undefined; sum: HighPrecisionValue | null | undefined; average: HighPrecisionValue | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class AreaNormalizedResponse { /** * */ values: Array | null | undefined; summary: TimeSeriesSummary | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EntityScheduleSummary { /** * */ entityId: number | null | undefined; inSchedule: HighPrecisionValue | null | undefined; outSchedule: HighPrecisionValue | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Represents a Schedule in the context of an interval data response. An interval data response contain results for zero, one, or more \"Entities\" (for example, Data Points, Places, or Commodities). For each Entity, this DTO includes a summary containing its associated \"in-schedule\" and \"out-schedule\" use (or demand). */ declare class ScheduleWithEntitySummaries { /** * */ entityScheduleSummaries: Array | null | undefined; /** * A longer description of this schedule. For example, \"9-5, Mon-Fri\". */ scheduleDescription: string | null | undefined; /** * A list of 7 ScheduleDay records, each of which defines the open hours for a single day of the week. They are returned in order, beginning with Sunday and ending with Saturday. */ scheduleDays: Array | null | undefined; createdBy: UserChild | null | undefined; /** * The date when the schedule was created */ createdDate: Date | null | undefined; modifiedBy: UserChild | null | undefined; /** * The date when the version was schedule */ modifiedDate: Date | null | undefined; /** * The ID of this Schedule record. */ scheduleId: number | null | undefined; /** * Information about this schedule. This can be thought of as a name. For example, \"24/7\". */ scheduleInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TemperatureResponse { /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaIntervalDataOverlay { areaNormalized: AreaNormalizedResponse | null | undefined; schedule: ScheduleWithEntitySummaries | null | undefined; coolingDegreeDays: TemperatureResponse | null | undefined; heatingDegreeDays: TemperatureResponse | null | undefined; dailyMeanTemperatures: TemperatureResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * A collection of \"min\", \"max\", \"sum\", \"average\" Values, associated with an Entity. */ declare class TimeSeriesEntitySummary { /** * */ entityId: number | null | undefined; min: HighPrecisionTimeSeriesValue | null | undefined; max: HighPrecisionTimeSeriesValue | null | undefined; sum: HighPrecisionValue | null | undefined; average: HighPrecisionValue | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeSeriesValue { /** * */ id: number | null | undefined; /** * */ date: Date | null | undefined; /** * Value, as a decimal. Note that this could be very large, and/or to a high degree of precision. In particular, in Javascript, it might not be able to be precisely represented in a 64-bit float. See: `formattedValue`. */ value: number | null | undefined; /** * Value, serialized as a String. This is the value that should be displayed to the User. If Value is very large or to a high degree of precision its Number value in Javascript cannot be relied upon. Other client languages might have similar limitations. In order to guarantee that Value is displayed to the User to the same degree of precision as is stored in the readings database, this `formattedValue` property must be used. */ formattedValue: string | null | undefined; /** * The Unit that `Value` is expressed in. E.g. \"kWh\". */ unit: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This DTO is used for the EsaIntervalData Widget */ declare class EsaIntervalDataResponse { dateRange: DateRange | null | undefined; /** * Data grouping interval in minutes */ groupIntervalMinutes: number | null | undefined; overlays: EsaIntervalDataOverlay | null | undefined; /** * A collection of summaries (min, max, sum, average) for each Entity in the time series response. */ entitySummaries: Array | null | undefined; /** * */ entities: Array | null | undefined; /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaSentinelPrediction { /** * */ esaChannelId: number | null | undefined; /** * */ localDateTime: Date | null | undefined; /** * */ value: number | null | undefined; /** * */ estimatedUpperBound: number | null | undefined; /** * */ estimatedLowerBound: number | null | undefined; /** * */ isOutOfBounds: boolean | null | undefined; /** * */ outOfBoundsAmount: number | null | undefined; /** * */ outOfBoundsPercent: number | null | undefined; /** * */ unit: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaSentinelPredictionsResponse { dateRange: DateRange | null | undefined; esaChannel: EsaChannelResponse | null | undefined; /** * */ values: Array | null | undefined; schedule: ScheduleResponse | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGYearlyEmissions { /** * The year this data belongs to. */ year: string | null | undefined; /** * The total emissions for this year, in CO2 Equivalent */ totalYearlyEmissions: number | null | undefined; /** * A percentage value that represents how close to the target year this year's data is. A positive value means the current year is over the target, a negative value means the current year is under the target. Field is null if target data is not available. */ targetPerformancePercentage: number | null | undefined; /** * The total emissions for this year, grouped by gas type. */ yearlyEmissionsByGasType: Array | null | undefined; /** * The total emissions for this year, grouped by Scope, Commodity, or Scope Category. */ yearlyEmissionsByGroup: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGTargetEmissions { baseTargetYear: GHGYearlyEmissions | null | undefined; adjustedTargetYear: GHGYearlyEmissions | null | undefined; adjustedYTDTargetYear: GHGYearlyEmissions | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class GHGCarbonFootprintResponse { periodRange: PeriodRange | null | undefined; targetData: GHGTargetEmissions | null | undefined; /** * GHG Emissions data, split by year, then by group and gas type. */ yearlyData: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MapPlaceChild { /** * The identifier for place */ placeId: number | null | undefined; /** * The place code */ placeCode: string | null | undefined; /** * The place information */ placeInfo: string | null | undefined; address: AddressChild | null | undefined; /** * The floor area of the place, reported in the global area unit */ floorArea: number | null | undefined; primaryUse: PrimaryUseChild | null | undefined; /** * Energy Use Intensity (EUI) for the past period */ energyUseIntensity: number | null | undefined; /** * Energy Cost Intensity (ECI) for the past period */ energyCostIntensity: number | null | undefined; /** * Green House Gas (GHG) Intensity for the past period */ ghgIntensity: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MapWidgetResponse { /** * The start period for intensity data on places */ startPeriod: number | null | undefined; /** * The end period for intensity data on places */ endPeriod: number | null | undefined; energyUseIntensityUnit: UnitChild | null | undefined; energyCostIntensityUnit: UnitChild | null | undefined; ghgIntensityUnit: UnitChild | null | undefined; floorAreaUnit: UnitChild | null | undefined; /** * Place data to draw on the map */ places: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterCost { meter: MeterChild | null | undefined; place: PlaceChild | null | undefined; /** * Total cost */ totalCost: number | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MissingBillWidget { /** * The begin date of the gap in billing data */ gapBeginDate: Date | null | undefined; /** * The end date of the gap in billing data */ gapEndDate: Date | null | undefined; /** * The number of days in the gap in billing data */ gapDays: number | null | undefined; /** * The account that is missing billing data */ accountId: number | null | undefined; /** * The account that is missing billing data */ accountInfo: string | null | undefined; /** * The meter that is missing billing data */ meterInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose period comparison DTO */ declare class PeriodComparison { /** * The date for the current period of data */ currentPeriod: number | null | undefined; /** * The date for the previous period of data */ previousPeriod: number | null | undefined; currentValue: ValueWithUnit | null | undefined; previousValue: ValueWithUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PeriodRangeComparisonDetailed { /** * The data details */ dataDetails: Array | null | undefined; currentPeriodRange: PeriodRange | null | undefined; previousPeriodRange: PeriodRange | null | undefined; currentValue: ValueWithUnit | null | undefined; previousValue: ValueWithUnit | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceCost { place: PlaceChild | null | undefined; /** * Total cost */ totalCost: number | null | undefined; /** * Current Area */ currentArea: number | null | undefined; /** * Current Area Units */ currentAreaUnit: string | null | undefined; /** * Area Units */ areaUnit: string | null | undefined; /** * Cost per area */ costPerArea: number | null | undefined; costUnit: UnitChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestGHGYearlyResponseResults { /** * year */ year: string | null | undefined; /** * Equivalent CO2 emissions */ equivalentCO2Emissions: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestGHGYearlyResponseTargetComparison { /** * Target year */ targetYear: number | null | undefined; /** * Target label */ targetLabel: string | null | undefined; /** * Equivalent CO2 emissions for the target year */ equivalentCO2Emissions: number | null | undefined; /** * Equivalent CO2 emissions for the target year up to the target period that corresponds to the current period */ equivalentCO2EmissionsYtd: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestGHGYearlyResponseGHGType { /** * GHG type identifier */ ghgTypeId: number | null | undefined; /** * GHG type code */ ghgTypeCode: string | null | undefined; /** * GHG type info */ ghgTypeInfo: string | null | undefined; targetComparison: PlaceDigestGHGYearlyResponseTargetComparison | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestGHGYearlyResponseGHGScope { /** * GHG scope identifier */ ghgScopeId: number | null | undefined; /** * GHG scope code */ ghgScopeCode: string | null | undefined; /** * GHG scope info */ ghgScopeInfo: string | null | undefined; /** * GHG scope type code */ ghgScopeTypeCode: string | null | undefined; /** * GHG scope type code */ ghgScopeTypeInfo: string | null | undefined; /** * An array of ghg type yearly data */ ghgTypes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceDigestGHGYearlyResponse { /** * The place code */ placeCode: string | null | undefined; /** * The place info */ placeInfo: string | null | undefined; /** * The place identifier */ placeId: number | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; equivalentCO2EmissionsUnit: UnitChild | null | undefined; /** * List of greenhouse gas types with use by year */ ghgTypes: Array | null | undefined; /** * List of greenhouse gas scopes by type with use by year */ ghgScopes: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RollingComparisonPeriodValue { /** * The grouped values within the period */ groupByValues: Array | null | undefined; /** * The period */ period: number | null | undefined; /** * The value within the period */ value: number | null | undefined; /** * The formatted value within the period */ formattedValue: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * General purpose year range DTO */ declare class YearRange { /** * The start year for the range */ startYear: number | null | undefined; /** * The end year for the range */ endYear: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RollingComparisonDetail { yearRange: YearRange | null | undefined; /** * The monthly values within the year range */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class RollingComparisonResponse { /** * Indicates the type of the data displayed. Eg: Actual, Calendarized or Normalized. */ dataDisplayed: string | null | undefined; /** * The values unit */ unit: string | null | undefined; periodRange: PeriodRange | null | undefined; /** * The entities for the groups */ groupByEntities: Array | null | undefined; /** * The data details */ dataDetails: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class TimeSeriesDataResponse { /** * */ entities: Array | null | undefined; /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Target data for use / cost / target emissions data */ declare class TrendTarget { /** * Target year */ targetYear: number | null | undefined; /** * Target label */ targetLabel: string | null | undefined; /** * Target YTD label */ targetYTDLabel: string | null | undefined; /** * Total value (use or cost) for the target year in the unit of the value being reported on */ targetValue: number | null | undefined; /** * Year to date value (use or cost) for the target year in the unit of the value being reported on */ targetYTDValue: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * This DTO is used for the Trend Widget */ declare class TrendDataResponse { target: TrendTarget | null | undefined; periodRange: PeriodRange | null | undefined; /** * The latest calendar or fiscal year, denotes the YTD year */ currentYear: number | null | undefined; /** * The type of calendar periods being returned, either \"Calendar\" or \"Fiscal\". This applies to CurrentYear, PeriodRange, and dates in the Values array */ calendarType: string | null | undefined; /** * */ entities: Array | null | undefined; /** * */ values: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetResponse { /** * Widget identifier */ widgetId: number | null | undefined; /** * Widget info */ widgetInfo: string | null | undefined; /** * Widget description */ description: string | null | undefined; /** * Widget tags */ tags: Array | null | undefined; /** * Widget filters */ filters: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityCategoryChild { /** * The commodity category id */ commodityCategoryId: number | null | undefined; /** * The commodity category info */ commodityCategoryInfo: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CommodityChildWithCategory { commodityCategory: CommodityCategoryChild | null | undefined; /** * The commodity identifier */ commodityId: number | null | undefined; /** * The commodity code */ commodityCode: string | null | undefined; /** * The commodity info */ commodityInfo: string | null | undefined; commodityIcon: Icon | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetSavingsYearlyResponseResults { /** * Year */ year: string | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Total Cost */ batccTotalCost: number | null | undefined; /** * Total Cost */ totalCost: number | null | undefined; /** * Savings Total Cost = BATCCTotalCost - TotalCost */ savingsTotalCost: number | null | undefined; /** * BATCC (Baseline Adjusted to Current Conditions) Use */ batccUse: number | null | undefined; /** * Use */ use: number | null | undefined; /** * Savings Use = BATCCUse - Use */ savingsUse: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetSavingsYearlyResponseCommodityData { commodity: CommodityChildWithCategory | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Use */ allTimeBATCCUse: number | null | undefined; /** * Program to Date Native Use */ allTimeUse: number | null | undefined; /** * Program to Date Savings Use = allTimeBATCCUse - allTimeUse */ allTimeSavingsUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Total Cost */ allTimeBATCCTotalCost: number | null | undefined; /** * Program to Date Total Cost */ allTimeTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost = allTimeBATCCTotalCost - allTimeTotalCost */ allTimeSavingsTotalCost: number | null | undefined; /** * An array of yearly data */ results: Array | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WidgetSavingsYearlyResponse { billingPeriodRange: PeriodRange | null | undefined; fiscalPeriodRange: PeriodRange | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Use */ allTimeBATCCUse: number | null | undefined; /** * Program to Date Use */ allTimeUse: number | null | undefined; /** * Program to Date Savings Use = allTimeBATCCUse - allTimeUse */ allTimeSavingsUse: number | null | undefined; /** * Program to Date BATCC (Baseline Adjusted to Current Conditions) Total Cost */ allTimeBATCCTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost */ allTimeTotalCost: number | null | undefined; /** * Program to Date Savings Total Cost = allTimeBATCCTotalCost - allTimeTotalCost */ allTimeSavingsTotalCost: number | null | undefined; /** * An array of savings yearly data */ results: Array | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; useUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * An array of savings yearly data per commodity */ commodities: Array | null | undefined; } declare class WidgetService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves data for cost avoidance by commodity dashboard widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ costAvoidanceByCommodity(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param specificWidgetId * @param filter */ executeSprocWidget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns counts of bills Held from Export, bills Waiting for Export to AP, bills Waiting for Export to GL, bills which are Not Approved, bills with unresolved flags, and bills created in the past seven days. * * @param specificWidgetId Identifier for a specific Bill Status widget on a dashboard * @param filter Filter string which may add to or override saved filter values during this request */ getActionableBillCounts(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets the actual vs budget widget. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getActualVsBudget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves data about bills that have not yet been received from vendors. NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsOverdueFromVendor(specificWidgetId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the carbon footprint data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCarbonFootprint(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves yearly Carbon Emissions data that is split by year, then by Gas Type and one of the following group types: ( Scope, Scope Category, Commodity ). Also includes target data, if target comparisons are enabled and set. * * @param specificWidgetId Specific Widget identifier to get the data for * @param filter */ getCarbonFootprintData(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves data for commodity cost dashboard widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCommodityCost(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns Cost Avoidance Savings Program-to-date. The user can set the topmost place and/or commodity filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCostAvoidanceProgramSavings(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of buildings for the Multiple ENERGY STAR Buildings widget. The widget is expecting zero, one, or many buildings, and alters its layout based on how many results it receives. Validation: - The provided specific widget must exist - The provided specific widget must be an Multiple ENERGY STAR Buildings widget * * @param specificWidgetId Identifier for a specific ENERGY STAR widget on a dashboard * @param numberOfYears Only used when a single building is returned. The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. * @param filter Filter string which may add to or override saved filter values during this request * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarMultipleBuildings(specificWidgetId: number, numberOfYears?: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves ENERGY STAR place score history for a building Validation: - The provided specific widget must exist - The provided specific widget must be an ENERGY STAR Single Building widget * * @param specificWidgetId Identifier for a specific Single ENERGY STAR Building widget on a dashboard * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarSingleBuilding(specificWidgetId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns data for the ESA demand interval data widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaDemandIntervalDataWidget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns data for the ESA heatmap widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaHeatmapWidget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns data for the esa interval data widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaIntervalDataWidget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve Trend Insights (previously \"ESA Sentinel\") readings and predictions for a Channel. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getEsaSentinelWidget(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves energy use intensity data for a specific widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter API filters */ getEuiChartWidgetData(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get building rank by GHG emissions or intensity. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGBuildingRank(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets the greenhouse gas performance by commodity, scope or scope category. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGPerformance(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get ranking by GHG emissions. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGRanking(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves interval data for a specific widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for */ getIntervalData(specificWidgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the bar rank and tree map widgets. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getItemRank(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves map data for a specific map widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. */ getMapWidget(specificWidgetId: number, chartMonthsToExclude?: number, numMonths?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns gaps in billing data for a date range specified by the Bill Date Range filter. A gap is defined as at least one day that falls within the account's service dates and not included in any bill for that account meter. The Allowable Gap Days filter specifies the number of days that must be in the gap before it will be included in the results. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMissingBills(specificWidgetId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets data for the Monthly Cost Trend widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter Filters to apply to the widget */ getMonthlyCostTrend(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns data for the monthly trend widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getMonthlyTrend(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets data for the Monthly Use Trend widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter Filters to apply to the widget */ getMonthlyUseTrend(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the most expensive building data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getMostExpensiveBuildings(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the most expensive meters data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getMostExpensiveMeters(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves data for the Rolling Monthly Comparison Widget. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getRollingComparison(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an array of widgets. * */ getWidgets(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns data for the monthly savings trend widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ monthlyCAPTrend(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves data for cost avoidance by commodity dashboard widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ costAvoidanceByCommodityWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param specificWidgetId * @param filter */ executeSprocWidgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns counts of bills Held from Export, bills Waiting for Export to AP, bills Waiting for Export to GL, bills which are Not Approved, bills with unresolved flags, and bills created in the past seven days. * * @param specificWidgetId Identifier for a specific Bill Status widget on a dashboard * @param filter Filter string which may add to or override saved filter values during this request */ getActionableBillCountsWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the actual vs budget widget. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getActualVsBudgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves data about bills that have not yet been received from vendors. NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsOverdueFromVendorWithHttpInfo(specificWidgetId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the carbon footprint data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCarbonFootprintWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves yearly Carbon Emissions data that is split by year, then by Gas Type and one of the following group types: ( Scope, Scope Category, Commodity ). Also includes target data, if target comparisons are enabled and set. * * @param specificWidgetId Specific Widget identifier to get the data for * @param filter */ getCarbonFootprintDataWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves data for commodity cost dashboard widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCommodityCostWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns Cost Avoidance Savings Program-to-date. The user can set the topmost place and/or commodity filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getCostAvoidanceProgramSavingsWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of buildings for the Multiple ENERGY STAR Buildings widget. The widget is expecting zero, one, or many buildings, and alters its layout based on how many results it receives. Validation: - The provided specific widget must exist - The provided specific widget must be an Multiple ENERGY STAR Buildings widget * * @param specificWidgetId Identifier for a specific ENERGY STAR widget on a dashboard * @param numberOfYears Only used when a single building is returned. The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. * @param filter Filter string which may add to or override saved filter values during this request * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarMultipleBuildingsWithHttpInfo(specificWidgetId: number, numberOfYears?: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves ENERGY STAR place score history for a building Validation: - The provided specific widget must exist - The provided specific widget must be an ENERGY STAR Single Building widget * * @param specificWidgetId Identifier for a specific Single ENERGY STAR Building widget on a dashboard * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarSingleBuildingWithHttpInfo(specificWidgetId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns data for the ESA demand interval data widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaDemandIntervalDataWidgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns data for the ESA heatmap widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaHeatmapWidgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns data for the esa interval data widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getEsaIntervalDataWidgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve Trend Insights (previously \"ESA Sentinel\") readings and predictions for a Channel. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getEsaSentinelWidgetWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves energy use intensity data for a specific widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter API filters */ getEuiChartWidgetDataWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get building rank by GHG emissions or intensity. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGBuildingRankWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the greenhouse gas performance by commodity, scope or scope category. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGPerformanceWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get ranking by GHG emissions. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getGHGRankingWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves interval data for a specific widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for */ getIntervalDataWithHttpInfo(specificWidgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets the bar rank and tree map widgets. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getItemRankWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves map data for a specific map widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. */ getMapWidgetWithHttpInfo(specificWidgetId: number, chartMonthsToExclude?: number, numMonths?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns gaps in billing data for a date range specified by the Bill Date Range filter. A gap is defined as at least one day that falls within the account's service dates and not included in any bill for that account meter. The Allowable Gap Days filter specifies the number of days that must be in the gap before it will be included in the results. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMissingBillsWithHttpInfo(specificWidgetId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets data for the Monthly Cost Trend widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter Filters to apply to the widget */ getMonthlyCostTrendWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns data for the monthly trend widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ getMonthlyTrendWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets data for the Monthly Use Trend widget. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter Filters to apply to the widget */ getMonthlyUseTrendWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the most expensive building data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getMostExpensiveBuildingsWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the most expensive meters data for a specific widget * * @param specificWidgetId Specific widget identifier to get the data for * @param filter */ getMostExpensiveMetersWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves data for the Rolling Monthly Comparison Widget. * * @param specificWidgetId The specific widget id * @param filter The widget filters */ getRollingComparisonWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of widgets. * */ getWidgetsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns data for the monthly savings trend widget * * @param specificWidgetId Specific widget identifier * @param filter Optional filters */ monthlyCAPTrendWithHttpInfo(specificWidgetId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ApprovalWorkflowSettings { /** * */ approvalModeEnabled: boolean | null | undefined; /** * */ confirmEditDelete: boolean | null | undefined; /** * */ maximumApprovalAmount: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BillHeaderWorkflowChild { /** * */ useField: boolean | null | undefined; /** * */ required: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class BatchWorkflowSettings { /** * */ batchModeEnabled: boolean | null | undefined; dueDate: BillHeaderWorkflowChild | null | undefined; statementDate: BillHeaderWorkflowChild | null | undefined; invoiceNumber: BillHeaderWorkflowChild | null | undefined; controlCode: BillHeaderWorkflowChild | null | undefined; nextReading: BillHeaderWorkflowChild | null | undefined; accountPeriodName: BillHeaderWorkflowChild | null | undefined; accountPeriodYear: BillHeaderWorkflowChild | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Represents workflow settings for bill imports */ declare class BillImportWorkflowSettings { /** * Determines how bill import errors are handled. If your organization utilizes BillCAPture, this is forced to MarkBatchPending. One of 'MarkBatchPending', 'ProcessValidBills' */ errorHandling: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Represents workflow settings for chargebacks */ declare class ChargebackWorkflowSettings { /** * Allow or prevent the \"advanced\" dialog to be displayed when running the chargeback processor Required */ allowAdvancedChargebackSettings: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ExportWorkflowSettings { /** * */ exportModeEnabled: boolean | null | undefined; /** * */ canExport: string | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Bill approval settings */ declare class ApprovalWorkflowRequestChild { /** * Whether or not edit / delete should be confirmed Required */ confirmEditDelete: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Batch workflow settings */ declare class BatchWorkflowChild { dueDate: BillHeaderWorkflowChild | null; statementDate: BillHeaderWorkflowChild | null; invoiceNumber: BillHeaderWorkflowChild | null; controlCode: BillHeaderWorkflowChild | null; nextReading: BillHeaderWorkflowChild | null; accountPeriodName: BillHeaderWorkflowChild | null; accountPeriodYear: BillHeaderWorkflowChild | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Represents workflow settings for bill export */ declare class ExportWorkflowChild { /** * Whether or not payment details should be included in export Required */ includePaymentDetails: boolean | null; /** * Whether or not Export Mode is enabled Required */ exportModeEnabled: boolean | null; /** * The point at which a bill is eligible for export Required One of 'never', 'after entry', 'after batch', 'after approval', 'after batch approval' */ canExport: string | null; /** * Whether or not custom fields should be included in export Required */ includeUdfs: boolean | null; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WorkflowSettingsRequest { apExport: ExportWorkflowChild | null | undefined; glExport: ExportWorkflowChild | null | undefined; paymentExport: ExportWorkflowChild | null | undefined; batch: BatchWorkflowChild | null; approval: ApprovalWorkflowRequestChild | null; chargeback: ChargebackWorkflowSettings | null | undefined; billImport: BillImportWorkflowSettings | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Bill approval settings */ declare class ApprovalWorkflowChild { /** * Whether or not Approval Mode is enabled */ approvalModeEnabled: boolean | null | undefined; /** * Whether or not edit / delete should be confirmed */ confirmEditDelete: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ /** * Workflow settings response */ declare class WorkflowSettingsResponse { batch: BatchWorkflowSettings | null | undefined; approval: ApprovalWorkflowChild | null | undefined; apExport: ExportWorkflowChild | null | undefined; glExport: ExportWorkflowChild | null | undefined; paymentExport: ExportWorkflowChild | null | undefined; chargeback: ChargebackWorkflowSettings | null | undefined; billImport: BillImportWorkflowSettings | null | undefined; } declare class WorkflowService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Update bill workflow settings * * @param body All workflow settings */ editWorkflow(body?: WorkflowSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get approval workflow settings * */ getApprovalWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get batch workflow settings * */ getBatchWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get bill import workflow settings * */ getBillImportWorkflowSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get chargeback workflow settings * */ getChargebackWorkflowSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get export workflow settings * * @param exportMode The export mode to get settings for, can be 'AP', 'GL' or 'Payment' */ getExportWorkflow(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get bill workflow settings * */ getWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update bill workflow settings * * @param body All workflow settings */ editWorkflowWithHttpInfo(body?: WorkflowSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get approval workflow settings * */ getApprovalWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get batch workflow settings * */ getBatchWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill import workflow settings * */ getBillImportWorkflowSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get chargeback workflow settings * */ getChargebackWorkflowSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get export workflow settings * * @param exportMode The export mode to get settings for, can be 'AP', 'GL' or 'Payment' */ getExportWorkflowWithHttpInfo(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill workflow settings * */ getWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPaginatedPaginatedspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountList(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccount(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeter(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordList(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordList(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccounts(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylines(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatches(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettings(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActual(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatistics(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBills(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves data about bills that have not yet been received from vendors. NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsOverdueFromVendor(specificWidgetId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all chargeback tasks with details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getChargebackTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollections(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearly(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPoints(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the definition and data for a list type * * @param listTypeId The list type for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body DTO containing the list of initial filters to apply and a flag indicating whether to reset the current columns. Only one list of the specified list type exists, so columns and filters are shared for every dynamic list of the list type. Filters provided will be saved to the database. */ getDynamicListWithData(listTypeId: number, pageSize?: number, pageNumber?: number, body?: DynamicListRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecords(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSources(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of buildings for the Multiple ENERGY STAR Buildings widget. The widget is expecting zero, one, or many buildings, and alters its layout based on how many results it receives. Validation: - The provided specific widget must exist - The provided specific widget must be an Multiple ENERGY STAR Buildings widget * * @param specificWidgetId Identifier for a specific ENERGY STAR widget on a dashboard * @param numberOfYears Only used when a single building is returned. The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. * @param filter Filter string which may add to or override saved filter values during this request * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarMultipleBuildings(specificWidgetId: number, numberOfYears?: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannels(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all raw and processed ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaReadings(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all summarized ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaSummarizedReadings(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves list of values for data filter * * @param dataFieldId * @param search * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getFilterData(dataFieldId: number, search?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the ghg factors * * @param filter The api filters> * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGHGFactors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgers(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the definition and data for a list. For a list to be returned you must have created the list or have access to it. * * @param listId The list for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getListWithData(listId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns gaps in billing data for a date range specified by the Bill Date Range filter. A gap is defined as at least one day that falls within the account's service dates and not included in any bill for that account meter. The Allowable Gap Days filter specifies the number of days that must be in the gap before it will be included in the results. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMissingBills(specificWidgetId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all notifications for the current user * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getNotifications(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRates(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of tasks * * @param taskTypeCode Task type code. Acceptable values are: AuditGroup, CostAvoidance, Report, Chargeback, SetupSheet, UnitsOfMeasure, Accrual, BillImport, EnergyStar, BillExport, ReadingImport, SummarizeReading, BillUnexport, V7CostAvoidance, V7Accrual, Budget CostUnitUpdate, RecordImportPfl, EsaReadingImpPfl, RecordImport *This combines record import setup sheet tasks and record import with a profile tasks, EsaReadingImport *This combines Esa readings import setup sheet tasks and Esa Reading import with a profile tasks * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTasks(taskTypeCode?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTemplates(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of user groups * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUserGroups(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a paginated list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUsersPaginated(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentials(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogs(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillList(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMeters(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddresses(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountListWithHttpInfo(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccountWithHttpInfo(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeterWithHttpInfo(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordListWithHttpInfo(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordListWithHttpInfo(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylinesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatchesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettingsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActualWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatisticsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves data about bills that have not yet been received from vendors. NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsOverdueFromVendorWithHttpInfo(specificWidgetId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all chargeback tasks with details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getChargebackTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollectionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyWithHttpInfo(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCentersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPointsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the definition and data for a list type * * @param listTypeId The list type for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body DTO containing the list of initial filters to apply and a flag indicating whether to reset the current columns. Only one list of the specified list type exists, so columns and filters are shared for every dynamic list of the list type. Filters provided will be saved to the database. */ getDynamicListWithDataWithHttpInfo(listTypeId: number, pageSize?: number, pageNumber?: number, body?: DynamicListRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecordsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of buildings for the Multiple ENERGY STAR Buildings widget. The widget is expecting zero, one, or many buildings, and alters its layout based on how many results it receives. Validation: - The provided specific widget must exist - The provided specific widget must be an Multiple ENERGY STAR Buildings widget * * @param specificWidgetId Identifier for a specific ENERGY STAR widget on a dashboard * @param numberOfYears Only used when a single building is returned. The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. * @param filter Filter string which may add to or override saved filter values during this request * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarMultipleBuildingsWithHttpInfo(specificWidgetId: number, numberOfYears?: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannelsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all raw and processed ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaReadingsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all summarized ESA readings * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaSummarizedReadingsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves list of values for data filter * * @param dataFieldId * @param search * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getFilterDataWithHttpInfo(dataFieldId: number, search?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the ghg factors * * @param filter The api filters> * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGHGFactorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the definition and data for a list. For a list to be returned you must have created the list or have access to it. * * @param listId The list for which the definition and data are to be retrieved * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getListWithDataWithHttpInfo(listId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns gaps in billing data for a date range specified by the Bill Date Range filter. A gap is defined as at least one day that falls within the account's service dates and not included in any bill for that account meter. The Allowable Gap Days filter specifies the number of days that must be in the gap before it will be included in the results. * * @param specificWidgetId Specific widget identifier to get the data for * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMissingBillsWithHttpInfo(specificWidgetId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all notifications for the current user * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getNotificationsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRatesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of tasks * * @param taskTypeCode Task type code. Acceptable values are: AuditGroup, CostAvoidance, Report, Chargeback, SetupSheet, UnitsOfMeasure, Accrual, BillImport, EnergyStar, BillExport, ReadingImport, SummarizeReading, BillUnexport, V7CostAvoidance, V7Accrual, Budget CostUnitUpdate, RecordImportPfl, EsaReadingImpPfl, RecordImport *This combines record import setup sheet tasks and record import with a profile tasks, EsaReadingImport *This combines Esa readings import setup sheet tasks and Esa Reading import with a profile tasks * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTasksWithHttpInfo(taskTypeCode?: string, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getTemplatesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of user groups * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUserGroupsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a paginated list of users. Requires View permission for Users & Roles. If this permission is not available, restricted set of properties are returned. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUsersPaginatedWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentialsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogsWithHttpInfo(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillListWithHttpInfo(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMetersWithHttpInfo(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddressesWithHttpInfo(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccountingSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit accounting settings * * @param body */ editAccountingSettings(body?: AccountingSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit General Ledger Subcode definitions - update name, type and if \"list\" type edit (add/delete/edit) pick list values. One or more subcodes can be edited. * * @param body Provide the subcode definition */ editGLSubCodes(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit accounting settings * * @param body */ editAccountingSettingsWithHttpInfo(body?: AccountingSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit General Ledger Subcode definitions - update name, type and if \"list\" type edit (add/delete/edit) pick list values. One or more subcodes can be edited. * * @param body Provide the subcode definition */ editGLSubCodesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccountsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an account * * @param body Data representing the account being created */ createAccount(body?: AccountCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a General Ledger * * @param body Data representing the general ledger being created */ createGeneralLedger(body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an account * * @param body Data representing the account being created */ createAccountWithHttpInfo(body?: AccountCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a General Ledger * * @param body Data representing the general ledger being created */ createGeneralLedgerWithHttpInfo(body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccountsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes an account. Currently NO confirmation is required * * @param accountId The identifier for the account being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteAccount(accountId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an account. Currently NO confirmation is required * * @param accountId The identifier for the account being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteAccountWithHttpInfo(accountId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccountsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Bulk import Arcadia credentials and their associated accounts * * @param body The list of Arcadia credentials to import */ bulkImportArcadiaCredentials(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an account alert * * @param accountId The identifier for the account to create alert is on * @param body Data representing the account alert being created */ createAccountAlert(accountId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Links an account and meter together Meters must be linked to an active account to be usable in EnergyCAP Once an account and meter are created individually, they must be linked with this API * * @param body Data representing the account and meter being linked */ createAccountMeter(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an AccountRate Relationship. Linking AccountMeter and Rate * * @param accountMeterId * @param body */ createAccountRate(accountMeterId: number, body?: AccountRateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new Template from an existing Bill's cost-only line items belonging to the provided Account (lines which came from a vendor template will be dropped). * * @param billId Id of Bill from which to create the Template * @param accountId Id of Account whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createAccountTemplateFromBill(billId: number, accountId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Assigns a new template to an account meter. The new template's begin date must be after the begin date of all existing template assignments * * @param accountMeterId * @param body */ createFormTemplate(accountMeterId: number, body?: FormTemplateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new Template from an existing Bill's line items belonging to the provided Meter * * @param billId Id of Bill from which to create the Template * @param meterId Id of Meter whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createTemplateFromBill(billId: number, meterId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an account alert. * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to delete */ deleteAccountAlert(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an account meter * * @param accountMeterId * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter WARNING: Bills for this account include other meters. The ENTIRE bill is deleted. This flag can only be true when: There is a single relationship between the specified account and meter */ deleteAccountMeter(accountMeterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an template assignment from an account meter If we are deleting a template assignment in the middle of two other template assignments, then we will move back the next template's start date If we are deleting the last template(current template), the extend second last template's end date to match the account meter's end date If we are deleting the first template pull the second template's begin date to match account meter's begin date * * @param accountMeterId * @param formTemplateId */ deleteTemplateAssignment(accountMeterId: number, formTemplateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an account * * @param accountId The identifier for the account being edited * @param body Data representing the account being edited */ editAccount(accountId: number, body?: AccountEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param accountId * @param body */ editAccountCodeVersion(accountId: number, body?: AccountCodeHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an account meter relationship * * @param accountMeterId The id of the account meter record to edit * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter and a bill start date greater than or equal to the new account and meter relationship end date. WARNING: Bills for this account may include other meters. The ENTIRE bill is deleted. This flag can only be true when: Editing the most recent relationship between this account and meter The end date has been changed but not the begin date * @param body Data used to update the account and meter */ editAccountMeter(accountMeterId: number, deleteBills?: boolean, body?: AccountMeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit all AccountRate relationships * * @param accountMeterId * @param body */ editAccountRateList(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular account * * @param accountId The identifier for the account * @param body Data representing the account user defined fields / custom fields being edited */ editAccountUDFs(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all FormTemplate relationships * * @param accountMeterId * @param body */ editFormTemplateList(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a General Ledger * * @param generalLedgerId General Ledger ID to update * @param body Data representing the general ledger to update */ editGeneralLedger(generalLedgerId: number, body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Link sub accounts to a summary account This only adds sub accounts to a summary account. It will not remove any links. Use the Delete to remove accounts. Because the number of linked sub accounts can be large we just return the total number of accounts linked To get the list of all sub accounts linked to a summary account call the Get All Accounts API with the summaryAccountID filter. * * @param summaryAccountId * @param body */ linkSubAccounts(summaryAccountId: number, body?: LinkSubAccountsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of accounts to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of accountIds to move under the parentCostCenterId */ moveAccount(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom account action. Custom account actions are setup as webhooks * * @param body */ processAccountCustomAction(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink a sub account from a summary account * * @param summaryAccountId * @param subAccountId */ unlinkSubAccount(summaryAccountId: number, subAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink all sub accounts from a summary account * * @param summaryAccountId */ unlinkSubAccounts(summaryAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates an account alert * * @param accountId The identifier for the account the alert to update is on * @param alertId The identifier for the account alert to update * @param body Data representing the account alert being created */ updateAccountAlert(accountId: number, alertId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update current template for all passed in accountMeterIds If the accountMeter is an account only record the template must be for the 'Money' commodity or an error will be thrown If the accountMeter has no template assigned one will be created If the accountMeter's latest template assignment is end dated, a new assignment will be created starting from the latest end date All must be successfully updated otherwise none are updated and an error is returned * * @param templateId The template to apply to the provided accountMeterIds * @param body List of accountMeterIds whose template will be updated */ updateAccountMetersLatestTemplate(templateId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Bulk import Arcadia credentials and their associated accounts * * @param body The list of Arcadia credentials to import */ bulkImportArcadiaCredentialsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an account alert * * @param accountId The identifier for the account to create alert is on * @param body Data representing the account alert being created */ createAccountAlertWithHttpInfo(accountId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Links an account and meter together Meters must be linked to an active account to be usable in EnergyCAP Once an account and meter are created individually, they must be linked with this API * * @param body Data representing the account and meter being linked */ createAccountMeterWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Creates an AccountRate Relationship. Linking AccountMeter and Rate * * @param accountMeterId * @param body */ createAccountRateWithHttpInfo(accountMeterId: number, body?: AccountRateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new Template from an existing Bill's cost-only line items belonging to the provided Account (lines which came from a vendor template will be dropped). * * @param billId Id of Bill from which to create the Template * @param accountId Id of Account whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createAccountTemplateFromBillWithHttpInfo(billId: number, accountId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Assigns a new template to an account meter. The new template's begin date must be after the begin date of all existing template assignments * * @param accountMeterId * @param body */ createFormTemplateWithHttpInfo(accountMeterId: number, body?: FormTemplateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new Template from an existing Bill's line items belonging to the provided Meter * * @param billId Id of Bill from which to create the Template * @param meterId Id of Meter whose bodylines from source bill will be used to create the Template * @param body Additional information about new Template */ createTemplateFromBillWithHttpInfo(billId: number, meterId: number, body?: CreateTemplateFromBill, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an account alert. * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to delete */ deleteAccountAlertWithHttpInfo(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an account meter * * @param accountMeterId * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter WARNING: Bills for this account include other meters. The ENTIRE bill is deleted. This flag can only be true when: There is a single relationship between the specified account and meter */ deleteAccountMeterWithHttpInfo(accountMeterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an template assignment from an account meter If we are deleting a template assignment in the middle of two other template assignments, then we will move back the next template's start date If we are deleting the last template(current template), the extend second last template's end date to match the account meter's end date If we are deleting the first template pull the second template's begin date to match account meter's begin date * * @param accountMeterId * @param formTemplateId */ deleteTemplateAssignmentWithHttpInfo(accountMeterId: number, formTemplateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an account * * @param accountId The identifier for the account being edited * @param body Data representing the account being edited */ editAccountWithHttpInfo(accountId: number, body?: AccountEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param accountId * @param body */ editAccountCodeVersionWithHttpInfo(accountId: number, body?: AccountCodeHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an account meter relationship * * @param accountMeterId The id of the account meter record to edit * @param deleteBills A true value means delete all bills that have at least 1 line for this account and meter and a bill start date greater than or equal to the new account and meter relationship end date. WARNING: Bills for this account may include other meters. The ENTIRE bill is deleted. This flag can only be true when: Editing the most recent relationship between this account and meter The end date has been changed but not the begin date * @param body Data used to update the account and meter */ editAccountMeterWithHttpInfo(accountMeterId: number, deleteBills?: boolean, body?: AccountMeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all AccountRate relationships * * @param accountMeterId * @param body */ editAccountRateListWithHttpInfo(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits user defined field / custom field values for a particular account * * @param accountId The identifier for the account * @param body Data representing the account user defined fields / custom fields being edited */ editAccountUDFsWithHttpInfo(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit all FormTemplate relationships * * @param accountMeterId * @param body */ editFormTemplateListWithHttpInfo(accountMeterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates a General Ledger * * @param generalLedgerId General Ledger ID to update * @param body Data representing the general ledger to update */ editGeneralLedgerWithHttpInfo(generalLedgerId: number, body?: GeneralLedgerRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Link sub accounts to a summary account This only adds sub accounts to a summary account. It will not remove any links. Use the Delete to remove accounts. Because the number of linked sub accounts can be large we just return the total number of accounts linked To get the list of all sub accounts linked to a summary account call the Get All Accounts API with the summaryAccountID filter. * * @param summaryAccountId * @param body */ linkSubAccountsWithHttpInfo(summaryAccountId: number, body?: LinkSubAccountsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of accounts to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of accountIds to move under the parentCostCenterId */ moveAccountWithHttpInfo(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom account action. Custom account actions are setup as webhooks * * @param body */ processAccountCustomActionWithHttpInfo(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink a sub account from a summary account * * @param summaryAccountId * @param subAccountId */ unlinkSubAccountWithHttpInfo(summaryAccountId: number, subAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink all sub accounts from a summary account * * @param summaryAccountId */ unlinkSubAccountsWithHttpInfo(summaryAccountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates an account alert * * @param accountId The identifier for the account the alert to update is on * @param alertId The identifier for the account alert to update * @param body Data representing the account alert being created */ updateAccountAlertWithHttpInfo(accountId: number, alertId: number, body?: AccountAlertRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update current template for all passed in accountMeterIds If the accountMeter is an account only record the template must be for the 'Money' commodity or an error will be thrown If the accountMeter has no template assigned one will be created If the accountMeter's latest template assignment is end dated, a new assignment will be created starting from the latest end date All must be successfully updated otherwise none are updated and an error is returned * * @param templateId The template to apply to the provided accountMeterIds * @param body List of accountMeterIds whose template will be updated */ updateAccountMetersLatestTemplateWithHttpInfo(templateId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccountsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Download file for an account custom field * * @param accountId * @param udfId */ downloadAccountCustomFieldFile(accountId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one account * * @param accountId The account identifier for the account being retrieved */ getAccount(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getAccountActualMonthly(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getAccountActualYearly(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an alert for an account * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to return */ getAccountAlert(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all alerts for an account * * @param accountId The identifier for the account */ getAccountAlerts(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill split parent information for an account * * @param accountId ID of the account */ getAccountBillSplitParentDetails(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all rates for a particular account * * @param accountId The account identifier for which rate values are being retrieved */ getAccountRates(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates for a particular account * * @param accountId The account identifier for which template values are being retrieved */ getAccountTemplates(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular account * * @param accountId The account identifier for which user defined field / custom field values are being retrieved */ getAccountUdfs(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccounts(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get details for a bill split distribution * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitDetails(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of bill split versions on this account and meter relationship * * @param accountId ID of the account to get all assigned bill split versions * @param meterId ID of the meter to get all assigned bill split versions */ getBillSplitVersionHistory(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions on an account * * @param accountId ID of the account to get all assigned bill split versions */ getBillSplits(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves specific General Ledger Subcode definition * * @param subCodeIndex The index of the subCode being retrieved */ getGLSubCode(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves unique General Ledger Subcode values * * @param subCodeIndex The index of the subCode whose values are being retrieved */ getGLSubCodeValues(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all General Ledger SubCode definitions * */ getGLSubCodes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific General Ledger * * @param generalLedgerId General Ledger ID to return */ getGeneralLedger(generalLedgerId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgers(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a WebCAPture Credential by ID * * @param webCaptureCredentialId The WEBCapture Credential identifier */ getWebCaptureCredential(webCaptureCredentialId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentials(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search for accounts Search for accounts whose account code, address, old account code, meter serial number, or meter address contains \"query\" * * @param query The string to search for * @param includeInactiveAccounts Flag to determine if inactive accounts should be included in the search results */ searchAccounts(query?: string, includeInactiveAccounts?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for an account custom field * * @param accountId * @param udfId */ downloadAccountCustomFieldFileWithHttpInfo(accountId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one account * * @param accountId The account identifier for the account being retrieved */ getAccountWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getAccountActualMonthlyWithHttpInfo(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param accountId The account to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getAccountActualYearlyWithHttpInfo(accountId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by account for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an alert for an account * * @param accountId The identifier for the account the alert is on * @param alertId The identifier for the alert to return */ getAccountAlertWithHttpInfo(accountId: number, alertId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all alerts for an account * * @param accountId The identifier for the account */ getAccountAlertsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get bill split parent information for an account * * @param accountId ID of the account */ getAccountBillSplitParentDetailsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all rates for a particular account * * @param accountId The account identifier for which rate values are being retrieved */ getAccountRatesWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates for a particular account * * @param accountId The account identifier for which template values are being retrieved */ getAccountTemplatesWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular account * * @param accountId The account identifier for which user defined field / custom field values are being retrieved */ getAccountUdfsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all accounts * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAccountsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get details for a bill split distribution * * @param accountId ID of the account * @param meterId ID of the meter * @param versionId ID of the distribution version */ getBillSplitDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions on this account and meter relationship * * @param accountId ID of the account to get all assigned bill split versions * @param meterId ID of the meter to get all assigned bill split versions */ getBillSplitVersionHistoryWithHttpInfo(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of bill split versions on an account * * @param accountId ID of the account to get all assigned bill split versions */ getBillSplitsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves specific General Ledger Subcode definition * * @param subCodeIndex The index of the subCode being retrieved */ getGLSubCodeWithHttpInfo(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves unique General Ledger Subcode values * * @param subCodeIndex The index of the subCode whose values are being retrieved */ getGLSubCodeValuesWithHttpInfo(subCodeIndex: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all General Ledger SubCode definitions * */ getGLSubCodesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a specific General Ledger * * @param generalLedgerId General Ledger ID to return */ getGeneralLedgerWithHttpInfo(generalLedgerId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all General Ledgers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getGeneralLedgersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a WebCAPture Credential by ID * * @param webCaptureCredentialId The WEBCapture Credential identifier */ getWebCaptureCredentialWithHttpInfo(webCaptureCredentialId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all WebCAPture Credentials * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebCaptureCredentialsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Search for accounts Search for accounts whose account code, address, old account code, meter serial number, or meter address contains \"query\" * * @param query The string to search for * @param includeInactiveAccounts Flag to determine if inactive accounts should be included in the search results */ searchAccountsWithHttpInfo(query?: string, includeInactiveAccounts?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccrualSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Excludes or undoes exclusion of bills from accruals * * @param accountId The account whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setAccountBillListAccrualExclusion(accountId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param body */ setBillAccrualExclusion(body?: BillAccrualExclusionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param listId The list whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the provided list should be excluded from accruals or should have exclusion undone */ setBillListAccrualExclusion(listId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param meterId The meter whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setMeterBillListAccrualExclusion(meterId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Excludes or undoes exclusion of bills from accruals * * @param accountId The account whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setAccountBillListAccrualExclusionWithHttpInfo(accountId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param body */ setBillAccrualExclusionWithHttpInfo(body?: BillAccrualExclusionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param listId The list whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the provided list should be excluded from accruals or should have exclusion undone */ setBillListAccrualExclusionWithHttpInfo(listId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Excludes or undoes exclusion of bills from accruals * * @param meterId The meter whose bills will be excluded or have exclusion undone * @param body Indicates whether or not the bills should be excluded from accruals or should have exclusion undone */ setMeterBillListAccrualExclusionWithHttpInfo(meterId: number, body?: ListActionAccrualExclusion, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccrualSettingsRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete all bills created by the Accrual task If any bills have already been exported they will still be deleted * * @param taskId Identifier for the accrual task */ deleteAccrualTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run the accrual processor engine using the supplied settings to generate accrual bills * * @param filter Accrual data selection filters * @param body Accrual processor settings */ processAccruals(filter?: string, body?: AccrualProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void all bills created by the Accrual task If any bills have already been exported they will still be voided * * @param taskId Identifier for the accrual task */ voidAccrualTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by the Accrual task If any bills have already been exported they will still be deleted * * @param taskId Identifier for the accrual task */ deleteAccrualTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run the accrual processor engine using the supplied settings to generate accrual bills * * @param filter Accrual data selection filters * @param body Accrual processor settings */ processAccrualsWithHttpInfo(filter?: string, body?: AccrualProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by the Accrual task If any bills have already been exported they will still be voided * * @param taskId Identifier for the accrual task */ voidAccrualTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsAccrualSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get Accrual settings * */ getAccrualSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get Accrual settings * */ getAccrualSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsApplicationSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a user defined field / custom field * * @param body Data representing the user defined field / custom field being created */ createUDF(body?: UDFCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new webhook * * @param body */ createWebhook(body?: WebhookCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an API key * * @param apiKeyId */ deleteApiKey(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete the settings for the place benchmark defined by the benchmarkIndicator. Deletes all corresponding place benchmark values that were defined for that indicator. Updates user-defined autogroup membership for groups that contained filters for that indicator. * * @param benchmarkIndicator Indicator for the benchmark */ deletePlaceBenchmarkSetting(benchmarkIndicator: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a user defined field / custom field. Currently NO confirmation is required * * @param udfId The identifier for the user defined field / custom field being deleted */ deleteUDF(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a webhook * * @param webhookId */ deleteWebhook(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete webhook logs older than the number of days provided only if the number of logs per webhook is in excess of 100. 100 latest logs per webhook will always be maintained * * @param olderThanDays Defaults to 3 */ deleteWebhookLogsOlderThan(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the name and description of an api key * * @param apiKeyId * @param body */ editApiKey(apiKeyId: number, body?: ApiKeyEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a cost category * * @param costCategoryId The identifier of the cost category to edit * @param body Object containing settings to change */ editCostCategory(costCategoryId: number, body?: CostCategoryEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a list of user defined fields / custom fields * * @param udfType Valid udfTypes include \"Account\", \"Vendor\", \"Place\", \"Meter, \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\" * @param body */ editCustomFields(udfType: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * The user can edit the category and name for each benchmark If a benchmark has not been configured, it is configured User cannot delete a benchmark from this endpoint If the benchmark dto is null or not passed the API will ignore it If the benchmark dto is not null, the category and name are required * * @param body Dto containing what to edit on benchmark */ editPlaceBenchmarkSettings(body?: BenchmarkSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit system settings * * @param body */ editSystemSettings(body?: SystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a user defined field / custom field * * @param udfId * @param body Data representing the UDF being edited */ editUDF(udfId: number, body?: UDFEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing webhook * * @param webhookId * @param body */ editWebhook(webhookId: number, body?: WebhookEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fire a custom application action webhook * * @param webhookId The identifier for the webhook being fired */ processCustomAppAction(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Set the system reporting settings * * @param body */ setReportingSettings(body?: ReportingSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update common and global use units * * @param body */ updateUseRollupUnits(body?: RollupUnitUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a user defined field / custom field * * @param body Data representing the user defined field / custom field being created */ createUDFWithHttpInfo(body?: UDFCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new webhook * * @param body */ createWebhookWithHttpInfo(body?: WebhookCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an API key * * @param apiKeyId */ deleteApiKeyWithHttpInfo(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete the settings for the place benchmark defined by the benchmarkIndicator. Deletes all corresponding place benchmark values that were defined for that indicator. Updates user-defined autogroup membership for groups that contained filters for that indicator. * * @param benchmarkIndicator Indicator for the benchmark */ deletePlaceBenchmarkSettingWithHttpInfo(benchmarkIndicator: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a user defined field / custom field. Currently NO confirmation is required * * @param udfId The identifier for the user defined field / custom field being deleted */ deleteUDFWithHttpInfo(udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a webhook * * @param webhookId */ deleteWebhookWithHttpInfo(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete webhook logs older than the number of days provided only if the number of logs per webhook is in excess of 100. 100 latest logs per webhook will always be maintained * * @param olderThanDays Defaults to 3 */ deleteWebhookLogsOlderThanWithHttpInfo(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the name and description of an api key * * @param apiKeyId * @param body */ editApiKeyWithHttpInfo(apiKeyId: number, body?: ApiKeyEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a cost category * * @param costCategoryId The identifier of the cost category to edit * @param body Object containing settings to change */ editCostCategoryWithHttpInfo(costCategoryId: number, body?: CostCategoryEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a list of user defined fields / custom fields * * @param udfType Valid udfTypes include \"Account\", \"Vendor\", \"Place\", \"Meter, \"ChannelVersion\", \"Rate\", \"Bill\", \"EnergyProject\", \"Collection\", and \"EmissionSource\" * @param body */ editCustomFieldsWithHttpInfo(udfType: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * The user can edit the category and name for each benchmark If a benchmark has not been configured, it is configured User cannot delete a benchmark from this endpoint If the benchmark dto is null or not passed the API will ignore it If the benchmark dto is not null, the category and name are required * * @param body Dto containing what to edit on benchmark */ editPlaceBenchmarkSettingsWithHttpInfo(body?: BenchmarkSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit system settings * * @param body */ editSystemSettingsWithHttpInfo(body?: SystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a user defined field / custom field * * @param udfId * @param body Data representing the UDF being edited */ editUDFWithHttpInfo(udfId: number, body?: UDFEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing webhook * * @param webhookId * @param body */ editWebhookWithHttpInfo(webhookId: number, body?: WebhookEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fire a custom application action webhook * * @param webhookId The identifier for the webhook being fired */ processCustomAppActionWithHttpInfo(webhookId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Set the system reporting settings * * @param body */ setReportingSettingsWithHttpInfo(body?: ReportingSettingRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update common and global use units * * @param body */ updateUseRollupUnitsWithHttpInfo(body?: RollupUnitUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsApplicationSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new API key * * @param body */ createApiKey(body?: ApiKeyCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the license details. * * @param body */ editLicenseDetails(body?: LicenseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get an API key * * @param apiKeyId */ getApiKey(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all available API keys * * @param filter */ getApiKeys(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get license details. * */ getLicenseDetails(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get webhook event types * */ getWebhookEventTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get details for a webhook log * * @param webhookId * @param webhookLogId */ getWebhookLogDetails(webhookId: number, webhookLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogs(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new API key * * @param body */ createApiKeyWithHttpInfo(body?: ApiKeyCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the license details. * * @param body */ editLicenseDetailsWithHttpInfo(body?: LicenseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an API key * * @param apiKeyId */ getApiKeyWithHttpInfo(apiKeyId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available API keys * * @param filter */ getApiKeysWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get license details. * */ getLicenseDetailsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get webhook event types * */ getWebhookEventTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get details for a webhook log * * @param webhookId * @param webhookLogId */ getWebhookLogDetailsWithHttpInfo(webhookId: number, webhookLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of webhook event logs * * @param webhookId * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getWebhookLogsWithHttpInfo(webhookId: number, filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsApproveBillsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Approve/unapprove account bills * * @param accountId The account to approve/unapprove all bills * @param body Boolean representing approve flag */ accountBillListApprove(accountId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove bill list * * @param listId The list identifier * @param body Boolean representing approve flag */ approveBillList(listId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update approved flag for the given billIDs * * @param body approve action */ billActionApprove(body?: BillActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove meter bills * * @param meterId The meter to approve/unapprove all bills * @param body Boolean representing approve flag */ meterBillListApprove(meterId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Approve/unapprove account bills * * @param accountId The account to approve/unapprove all bills * @param body Boolean representing approve flag */ accountBillListApproveWithHttpInfo(accountId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Approve/unapprove bill list * * @param listId The list identifier * @param body Boolean representing approve flag */ approveBillListWithHttpInfo(listId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update approved flag for the given billIDs * * @param body approve action */ billActionApproveWithHttpInfo(body?: BillActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Approve/unapprove meter bills * * @param meterId The meter to approve/unapprove all bills * @param body Boolean representing approve flag */ meterBillListApproveWithHttpInfo(meterId: number, body?: ListActionApprove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBaselineEngineRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings * * @param body Settings and filter conditions for baseline processing */ bulkGenerateBaseline(body?: BulkBaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Regenerate cost avoidance baseline for the meters that match the filter conditions and then reprocess their savings * * @param body Settings and filter conditions for baseline processing */ bulkGenerateBaselineWithHttpInfo(body?: BulkBaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillCAPtureViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves a list of bill line type mappings * */ getBillLineTypeMappings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of bill line type mappings * */ getBillLineTypeMappingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a specific account's setting to split account charges on bill import * * @param accountId Account identifier */ deleteAccountBillAccountChargeSplitSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a specific vendor's setting to split account charges on bill import * * @param vendorId Vendor identifier */ deleteVendorBillAccountChargeSplitSettings(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a specific account's setting to split account charges on bill import If a rule does not currently exist for this account it is created otherwise it is updated * * @param accountId Account identifier * @param body */ editAccountBillAccountChargeSplitSettings(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the method used to split account charges on bill import * * @param body Method used to split account charges on bill import */ editBillAccountChargeSplitMethod(body?: BillAccountChargeSplitMethodRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a specific vendor's setting to split account charges on bill import If a rule does not currently exist for this vendor it is created otherwise it is updated * * @param vendorId Vendor identifier * @param body */ editVendorBillAccountChargeSplitSettings(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update bill workflow settings * * @param body All workflow settings */ editWorkflow(body?: WorkflowSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update audit settings * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param body The new state of the audit settings */ updateAuditSettings(body?: AuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a specific account's setting to split account charges on bill import * * @param accountId Account identifier */ deleteAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a specific vendor's setting to split account charges on bill import * * @param vendorId Vendor identifier */ deleteVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a specific account's setting to split account charges on bill import If a rule does not currently exist for this account it is created otherwise it is updated * * @param accountId Account identifier * @param body */ editAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the method used to split account charges on bill import * * @param body Method used to split account charges on bill import */ editBillAccountChargeSplitMethodWithHttpInfo(body?: BillAccountChargeSplitMethodRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a specific vendor's setting to split account charges on bill import If a rule does not currently exist for this vendor it is created otherwise it is updated * * @param vendorId Vendor identifier * @param body */ editVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update bill workflow settings * * @param body All workflow settings */ editWorkflowWithHttpInfo(body?: WorkflowSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update audit settings * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param body The new state of the audit settings */ updateAuditSettingsWithHttpInfo(body?: AuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves a specific account's settings to split account charges on bill import * * @param accountId Account identifier */ getAccountBillAccountChargeSplitSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the method used to split account charges on bill import * */ getBillAccountChargeSplitMethod(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettings(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a specific vendor's settings to split account charges on bill import * * @param vendorId Vendor identifier */ getVendorBillAccountChargeSplitSettings(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get bill workflow settings * */ getWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a specific account's settings to split account charges on bill import * * @param accountId Account identifier */ getAccountBillAccountChargeSplitSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the method used to split account charges on bill import * */ getBillAccountChargeSplitMethodWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all settings used to split account charges on bill import Note: When filtering by vendor, only settings that apply to all vendor accounts (account null) will be returned * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountChargeSplitSettingsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific vendor's settings to split account charges on bill import * * @param vendorId Vendor identifier */ getVendorBillAccountChargeSplitSettingsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill workflow settings * */ getWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * This endpoint allows the import of an EnergyCAP Advanced or a profile mapped file. The file can be comma separated file (CSV/DAT/TXT) or EXCEL (XLSX) or a collection of files (ZIP). The file should be base64 encoded with a UTF8 character set. * * @param body DTO containing the data to import, filename with extension, optional profileCode to map input file to advanced format, optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ billImport(body?: BillImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ closeBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new bill * Creates a bill. The created bill gets audited. If any audits fail, the bill will get flagged. If the audit setting for any of the failed audits is set to Fail and Hold, the bill will be set as \"Hold from Accounting Export\" If saveAsResolved property is set to true, the flagged bill will be automatically resolved and Released for Accounting Export * @param saveAsResolved Controls whether or not any failed audits automatically get marked as resolved * @param comment Optional comment to explain why the audit is being auto resolved * @param body */ createBill(saveAsResolved?: boolean, comment?: string, body?: BillCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a bill import profile * * @param profileId The identifier for the profile being deleted */ deleteBillImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId * @param body */ editBatch(batchId: number, body?: BatchEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a bill import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editBillImportProfile(profileId: number, body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all data necessary to load the bill entry screen * * @param accountId * @param beginDate * @param batchId */ getBillEntryData(accountId: number, beginDate?: Date, batchId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a bill import profile * * @param profileId The identifier for the profile to get */ getBillImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all bill import profiles * */ getBillImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the reimport of an EnergyCAP. All kickout files generated from the import will be zipped and reimported as a single task. * * @param taskGuid The taskGuid should be a bill import task with a status of completed with kickouts. * @param body DTO containing optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ importBillImportTaskKickouts(taskGuid: string, body?: BillKickoutImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Opens a new batch. If there are other open batches for this user, and CloseExistingBatch is true, closes those batches before creating the new batch. Returns the batch response DTO. * * @param body The batch to create */ openBatch(body?: BatchCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Upload a file representing a bill image. The bill image file extension must match the settings in system data 'webbillimageext'. * * @param billId The Bill ID associated with the file being uploaded. * @param fileName The name of the file containing the bill image * @param body Binary data containing the bill image */ uploadBillImage(billId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a bill import profile * * @param body The details about the profile being created */ writeBillImportProfile(body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the import of an EnergyCAP Advanced or a profile mapped file. The file can be comma separated file (CSV/DAT/TXT) or EXCEL (XLSX) or a collection of files (ZIP). The file should be base64 encoded with a UTF8 character set. * * @param body DTO containing the data to import, filename with extension, optional profileCode to map input file to advanced format, optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ billImportWithHttpInfo(body?: BillImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId */ closeBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new bill * Creates a bill. The created bill gets audited. If any audits fail, the bill will get flagged. If the audit setting for any of the failed audits is set to Fail and Hold, the bill will be set as \"Hold from Accounting Export\" If saveAsResolved property is set to true, the flagged bill will be automatically resolved and Released for Accounting Export * @param saveAsResolved Controls whether or not any failed audits automatically get marked as resolved * @param comment Optional comment to explain why the audit is being auto resolved * @param body */ createBillWithHttpInfo(saveAsResolved?: boolean, comment?: string, body?: BillCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a bill import profile * * @param profileId The identifier for the profile being deleted */ deleteBillImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId * @param body */ editBatchWithHttpInfo(batchId: number, body?: BatchEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a bill import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editBillImportProfileWithHttpInfo(profileId: number, body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data necessary to load the bill entry screen * * @param accountId * @param beginDate * @param batchId */ getBillEntryDataWithHttpInfo(accountId: number, beginDate?: Date, batchId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a bill import profile * * @param profileId The identifier for the profile to get */ getBillImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all bill import profiles * */ getBillImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * This endpoint allows the reimport of an EnergyCAP. All kickout files generated from the import will be zipped and reimported as a single task. * * @param taskGuid The taskGuid should be a bill import task with a status of completed with kickouts. * @param body DTO containing optional batch settings, optional import note/comment, and optional properties to automatically resolve audit failures and reason for resolution */ importBillImportTaskKickoutsWithHttpInfo(taskGuid: string, body?: BillKickoutImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Opens a new batch. If there are other open batches for this user, and CloseExistingBatch is true, closes those batches before creating the new batch. Returns the batch response DTO. * * @param body The batch to create */ openBatchWithHttpInfo(body?: BatchCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Upload a file representing a bill image. The bill image file extension must match the settings in system data 'webbillimageext'. * * @param billId The Bill ID associated with the file being uploaded. * @param fileName The name of the file containing the bill image * @param body Binary data containing the bill image */ uploadBillImageWithHttpInfo(billId: number, fileName?: string, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a bill import profile * * @param body The details about the profile being created */ writeBillImportProfileWithHttpInfo(body?: BillImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete all bills for account * * @param accountId The account to delete all bills from */ accountBillListDeleteBills(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete given billIDs * * @param body */ billActionDelete(body?: BillActionDelete, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ deleteBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills in a bill list * * @param listId The list identifier */ deleteBillsInBillList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills for meter * * @param meterId The meter to delete all bills from */ meterBillListDeleteBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills for account * * @param accountId The account to delete all bills from */ accountBillListDeleteBillsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete given billIDs * * @param body */ billActionDeleteWithHttpInfo(body?: BillActionDelete, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId */ deleteBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills in a bill list * * @param listId The list identifier */ deleteBillsInBillListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills for meter * * @param meterId The meter to delete all bills from */ meterBillListDeleteBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Fires a custom bill action on an account bill list. Custom bill actions are setup as webhooks. * * @param accountId The account against which all of its bills will have the custom action performed * @param body */ accountBillListCustomAction(accountId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid account bills * * @param accountId The account to void/unvoid all bills * @param body Boolean representing void flag */ accountBillListVoid(accountId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update all headers for a given list of bills If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bill audits won't be fired * * @param body Bill header update action */ billActionUpdateHeaders(body?: BillActionHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update void flag for the given billIDs * * @param body Void action */ billActionVoid(body?: BillActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action on a bill list * * @param listId The bill list against which all of its bills will have the custom action performed * @param body */ billListCustomAction(listId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each record in the request body, update the bill payment details. * * @param body List of Bill payment details */ billPaymentDetails(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the import file, update the bill payment details. * The import file needs to be a comma separated file. All lines are data lines (No header line allowed). The file structure is as follows- Bill Id (required), Check Number (required), Check Date YYYYMMDD format (required), Pay Status (upto 10 characters- do not use commas) (required), Cleared Date YYYYMMDD format (optional), Accounting Period YYYYMM (optional), comment (optional) - comment will be ignored. Example data:12345,7098,20210801,Procesed,20210806,202107,July bill paid via AP For this request, please use application/octet-stream as Content-Type and include your file as binary in the body of the request. /// * @param body Binary data containing the file contents */ billPaymentDetailsFile(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Cleans a single bill. The dirty flag of the bill is not taken into account. * * @param billId */ cleanABill(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Cleans all dirty bills, and any bills created outside of version 7. * */ cleanDirtyBills(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Persist an payment event for several bills * * @param body Payment event creation payload */ createBillPaymentEvent(body?: BillPaymentEventCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the request body which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param body Distribution information */ distributeAccountChargesToMeters(body?: DistributeAccountChargesToBillsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the provided batch which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param batchId ID for the batch containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInBatch(batchId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For each bill in the provided list which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param listId ID for the list containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInList(listId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing bill * If enabled, audits will be processed for the edited bill. If specified, any issues previously resolved will be reopened. Below are some clarifications regarding the rules for editing an existing bill: * Bills which are marked as \"void\" may not be edited * Users without UpdateApprovedBills.Edit permission may not edit bills marked as \"Approved\" * Users without ExportBills.Edit permission may not edit bills exported to AP or GL * Bills must have at least one line item * If configured, required bill headers will be enforced * @param billId * @param body */ editBill(billId: number, body?: BillEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a bill * * @param billId The id of the bill * @param body The list of udf values being edited */ editBillCustomFields(billId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action on a meter bill list. Custom bill actions are setup as webhooks * * @param meterId The meter against which all of its bills will have the custom action performed * @param body */ meterBillListCustomAction(meterId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid meter bills * * @param meterId The meter to void/unvoid all bills * @param body Boolean representing void flag */ meterBillListVoid(meterId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action. Custom bill actions are setup as webhooks * * @param body */ processBillCustomAction(body?: BillActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on an account bill list * * @param accountId The account that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseAccountBillList(accountId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on a bill list * * @param listId The bill list that all bills will be reversed on * @param body Batch settings for the reversed bill. If not provided, bills will be placed in the currently open batch. */ reverseBillList(listId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates reversal bills for the given bill ids considering multiple open batch options. * * @param body */ reverseBillsWithMultipleOpenBatchOptions(body?: BillReversalRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reverses all bills on a meter bill list * * @param meterId The meter that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseMeterBillList(meterId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates bill headers for the bills for an account's bill list Audits won't be fired * * @param accountId The account whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateAccountBillListHeaders(accountId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update all headers for a bill list If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bills audits won't be fired * * @param listId The list identifier * @param body Bill list header update action */ updateBillListHeaders(listId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates bill headers for all bills on a meter bill list Audits won't be fired * * @param meterId The meter whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateMeterBillListHeaders(meterId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void/unvoid bill list * * @param listId The list identifier * @param body Boolean representing void flag */ voidBillList(listId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom bill action on an account bill list. Custom bill actions are setup as webhooks. * * @param accountId The account against which all of its bills will have the custom action performed * @param body */ accountBillListCustomActionWithHttpInfo(accountId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid account bills * * @param accountId The account to void/unvoid all bills * @param body Boolean representing void flag */ accountBillListVoidWithHttpInfo(accountId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update all headers for a given list of bills If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bill audits won't be fired * * @param body Bill header update action */ billActionUpdateHeadersWithHttpInfo(body?: BillActionHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update void flag for the given billIDs * * @param body Void action */ billActionVoidWithHttpInfo(body?: BillActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action on a bill list * * @param listId The bill list against which all of its bills will have the custom action performed * @param body */ billListCustomActionWithHttpInfo(listId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each record in the request body, update the bill payment details. * * @param body List of Bill payment details */ billPaymentDetailsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the import file, update the bill payment details. * The import file needs to be a comma separated file. All lines are data lines (No header line allowed). The file structure is as follows- Bill Id (required), Check Number (required), Check Date YYYYMMDD format (required), Pay Status (upto 10 characters- do not use commas) (required), Cleared Date YYYYMMDD format (optional), Accounting Period YYYYMM (optional), comment (optional) - comment will be ignored. Example data:12345,7098,20210801,Procesed,20210806,202107,July bill paid via AP For this request, please use application/octet-stream as Content-Type and include your file as binary in the body of the request. /// * @param body Binary data containing the file contents */ billPaymentDetailsFileWithHttpInfo(body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Cleans a single bill. The dirty flag of the bill is not taken into account. * * @param billId */ cleanABillWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Cleans all dirty bills, and any bills created outside of version 7. * */ cleanDirtyBillsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Persist an payment event for several bills * * @param body Payment event creation payload */ createBillPaymentEventWithHttpInfo(body?: BillPaymentEventCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the request body which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param body Distribution information */ distributeAccountChargesToMetersWithHttpInfo(body?: DistributeAccountChargesToBillsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the provided batch which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param batchId ID for the batch containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInBatchWithHttpInfo(batchId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * For each bill in the provided list which has account-level charges, distribute these account charges amongst the meters on the bill. This is done proportionally by meter use or cost, depending on the split basis. Maximum of 10000 bills can be processed at one time. * * @param listId ID for the list containing bills for which account charges will be distributed to meters * @param body Distribution information */ distributeAccountChargesToMetersForBillsInListWithHttpInfo(listId: number, body?: DistributeAccountChargesBase, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing bill * If enabled, audits will be processed for the edited bill. If specified, any issues previously resolved will be reopened. Below are some clarifications regarding the rules for editing an existing bill: * Bills which are marked as \"void\" may not be edited * Users without UpdateApprovedBills.Edit permission may not edit bills marked as \"Approved\" * Users without ExportBills.Edit permission may not edit bills exported to AP or GL * Bills must have at least one line item * If configured, required bill headers will be enforced * @param billId * @param body */ editBillWithHttpInfo(billId: number, body?: BillEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a bill * * @param billId The id of the bill * @param body The list of udf values being edited */ editBillCustomFieldsWithHttpInfo(billId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Fires a custom bill action on a meter bill list. Custom bill actions are setup as webhooks * * @param meterId The meter against which all of its bills will have the custom action performed * @param body */ meterBillListCustomActionWithHttpInfo(meterId: number, body?: ListActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid meter bills * * @param meterId The meter to void/unvoid all bills * @param body Boolean representing void flag */ meterBillListVoidWithHttpInfo(meterId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom bill action. Custom bill actions are setup as webhooks * * @param body */ processBillCustomActionWithHttpInfo(body?: BillActionCustom, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on an account bill list * * @param accountId The account that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseAccountBillListWithHttpInfo(accountId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on a bill list * * @param listId The bill list that all bills will be reversed on * @param body Batch settings for the reversed bill. If not provided, bills will be placed in the currently open batch. */ reverseBillListWithHttpInfo(listId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates reversal bills for the given bill ids considering multiple open batch options. * * @param body */ reverseBillsWithMultipleOpenBatchOptionsWithHttpInfo(body?: BillReversalRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reverses all bills on a meter bill list * * @param meterId The meter that all bills will be reversed on * @param body Batch settings for the reversed bills. If not provided, bills will be placed in the currently open batch. */ reverseMeterBillListWithHttpInfo(meterId: number, body?: ListActionReverse, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates bill headers for the bills for an account's bill list Audits won't be fired * * @param accountId The account whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateAccountBillListHeadersWithHttpInfo(accountId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update all headers for a bill list If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated If the user does not have permission to edit exported or approved bills, those bills will not be updated Bills audits won't be fired * * @param listId The list identifier * @param body Bill list header update action */ updateBillListHeadersWithHttpInfo(listId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates bill headers for all bills on a meter bill list Audits won't be fired * * @param meterId The meter whose bills will have header updates applied * @param body Indicates which headers need to be updated */ updateMeterBillListHeadersWithHttpInfo(meterId: number, body?: BillHeaderUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void/unvoid bill list * * @param listId The list identifier * @param body Boolean representing void flag */ voidBillListWithHttpInfo(listId: number, body?: ListActionVoid, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Moves the set of bills to the specified batch The bills being moved could be in an open, pending or closed batch The specified batch should be an open or pending batch All the bills being moved should be in the same batch Moving from a pending to an open will cause the bills to get un-voided Moving from an open/closed to a pending will cause the bills to get voided If bills were in a closed batch, and downstream processes had already run, those processes will not get reversed * * @param batchId Batch to move to * @param body List of bills to be moved to the new batch */ moveBatch(batchId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the set of bills to the specified batch The bills being moved could be in an open, pending or closed batch The specified batch should be an open or pending batch All the bills being moved should be in the same batch Moving from a pending to an open will cause the bills to get un-voided Moving from an open/closed to a pending will cause the bills to get voided If bills were in a closed batch, and downstream processes had already run, those processes will not get reversed * * @param batchId Batch to move to * @param body List of bills to be moved to the new batch */ moveBatchWithHttpInfo(batchId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Export list data to excel spreadsheet format * * @param accountId The account to export bills */ accountBillListExcelExport(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generate a bill import file from all bills in an account bill list. * * @param accountId The account from which to get all bills */ accountExportHistoricalBillList(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountList(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a bill custom field * * @param billId The id of the bill * @param udfId The id of the custom field */ downloadBillCustomFieldFile(billId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a JSON array of bill details. * * @param body List of bill IDs */ exportBillsAsJson(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from bills in a list. * * @param listId The id of the list to get bills from */ exportHistoricalBillList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param exportFileName * @param body */ exportHistoricalBills(exportFileName?: string, body?: BillActionHistoricalExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill history for an account * * @param accountId accountId to get bill history for * @param billingPeriod required: billingPeriod in yyyymm format to return history from * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getAccountBillHistory(accountId: number, billingPeriod?: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylines(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get approval workflow settings * */ getApprovalWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets all audit settings * */ getAuditSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param batchId */ getBatch(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all move operation logs for a specific batch * * @param batchId Batch identifier */ getBatchLogs(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get batch workflow settings * */ getBatchWorkflow(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatches(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one bill * * @param billId The bill identifier */ getBill(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill account meter record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterActualByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter calendarized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterCalendarizedByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter normalized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterNormalizedByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter statistics record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterStatisticsByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActual(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalized(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatistics(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * List of a bill IDs that were created or modified since the given date. * * @param date Created or modified datetime; Defaults to yesterday at the current time */ getBillActivity(date?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one bill's bodylines * * @param billId The bill identifier */ getBillBodylines(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a bill * * @param billId The id of the bill */ getBillCustomFields(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data necessary to load the bill entry screen * * @param billId */ getBillEntryDataByBillId(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves bill history from starting at the billId billing period * * @param billId billId to get bill history for * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getBillHistory(billId: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the kickout details associated with a specified bill import task and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetails(taskGuid: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the kickout details associated with a specified bill import task, file and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsByFile(taskGuid: string, filename: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get bill import workflow settings * */ getBillImportWorkflowSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the payment events for a bill * * @param billId Identifier for the bill */ getBillPaymentEvents(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves properties for bill view * * @param billId The bill identifier */ getBillView(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBills(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get export workflow settings * * @param exportMode The export mode to get settings for, can be 'AP', 'GL' or 'Payment' */ getExportWorkflow(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all bills for a particular meter * * @param meterId The meter identifier for which bill values are being retrieved */ getMeterBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of kickout messages associated with a specified bill import task * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. */ getTaskKickoutSummary(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of kickout messages associated with a specified bill import task and file. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. */ getTaskKickoutSummaryByFile(taskGuid: string, filename: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillList(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param meterId The meter to export bills from */ meterBillListExcelExport(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generate a bill import file from all bills in a meter bill list. * * @param meterId The meter from which to get all bills */ meterExportHistoricalBillList(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param accountId The account to export bills */ accountBillListExcelExportWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from all bills in an account bill list. * * @param accountId The account from which to get all bills */ accountExportHistoricalBillListWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the account bills list * * @param accountId The account identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ accountListWithHttpInfo(accountId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a bill custom field * * @param billId The id of the bill * @param udfId The id of the custom field */ downloadBillCustomFieldFileWithHttpInfo(billId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a JSON array of bill details. * * @param body List of bill IDs */ exportBillsAsJsonWithHttpInfo(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Generate a bill import file from bills in a list. * * @param listId The id of the list to get bills from */ exportHistoricalBillListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param exportFileName * @param body */ exportHistoricalBillsWithHttpInfo(exportFileName?: string, body?: BillActionHistoricalExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill history for an account * * @param accountId accountId to get bill history for * @param billingPeriod required: billingPeriod in yyyymm format to return history from * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getAccountBillHistoryWithHttpInfo(accountId: number, billingPeriod?: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all bill's bodylines * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getAllBillsBodylinesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get approval workflow settings * */ getApprovalWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets all audit settings * */ getAuditSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param batchId */ getBatchWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all move operation logs for a specific batch * * @param batchId Batch identifier */ getBatchLogsWithHttpInfo(batchId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get batch workflow settings * */ getBatchWorkflowWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBatchesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one bill * * @param billId The bill identifier */ getBillWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill account meter record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterActualByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter calendarized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterCalendarizedByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter normalized record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterNormalizedByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter statistics record for a specific billId * * @param billId The bill identifier */ getBillAccountMeterStatisticsByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersActualWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter calendarized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersCalendarizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter normalized records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersNormalizedWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves bill account meter statistics records * * @param filter Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillAccountMetersStatisticsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * List of a bill IDs that were created or modified since the given date. * * @param date Created or modified datetime; Defaults to yesterday at the current time */ getBillActivityWithHttpInfo(date?: Date, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one bill's bodylines * * @param billId The bill identifier */ getBillBodylinesWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get custom field values for a bill * * @param billId The id of the bill */ getBillCustomFieldsWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all data necessary to load the bill entry screen * * @param billId */ getBillEntryDataByBillIdWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves bill history from starting at the billId billing period * * @param billId billId to get bill history for * @param numberOfYears optional: Number of years of history to return. Defaults to 5 * @param includeVoid optional: Should voided bills be included. Defaults to false * @param includeAccrual optional: Should accrual bills be included. Defaults to false */ getBillHistoryWithHttpInfo(billId: number, numberOfYears?: number, includeVoid?: boolean, includeAccrual?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the kickout details associated with a specified bill import task and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsWithHttpInfo(taskGuid: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the kickout details associated with a specified bill import task, file and an optional kickout message. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. * @param kickoutMessage The optional kickout message to search for. */ getBillImportKickoutDetailsByFileWithHttpInfo(taskGuid: string, filename: string, kickoutMessage?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill import workflow settings * */ getBillImportWorkflowSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the payment events for a bill * * @param billId Identifier for the bill */ getBillPaymentEventsWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves properties for bill view * * @param billId The bill identifier */ getBillViewWithHttpInfo(billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of bills. The array of bills can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get export workflow settings * * @param exportMode The export mode to get settings for, can be 'AP', 'GL' or 'Payment' */ getExportWorkflowWithHttpInfo(exportMode?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all bills for a particular meter * * @param meterId The meter identifier for which bill values are being retrieved */ getMeterBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of kickout messages associated with a specified bill import task * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. */ getTaskKickoutSummaryWithHttpInfo(taskGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of kickout messages associated with a specified bill import task and file. * * @param taskGuid The task GUID to search for. The task must be of type Bill Import. * @param filename The kickout file name to search for. */ getTaskKickoutSummaryByFileWithHttpInfo(taskGuid: string, filename: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the meter bills list * * @param meterId The meter identifier to retrieve bills list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ meterBillListWithHttpInfo(meterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param meterId The meter to export bills from */ meterBillListExcelExportWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generate a bill import file from all bills in a meter bill list. * * @param meterId The meter from which to get all bills */ meterExportHistoricalBillListWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a budget * * @param body Data representing the budget being created */ createBudget(body?: BudgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a budget version * * @param budgetId The identifier for the budget to create the version on * @param body Data representing the budgetVersion being created */ createBudgetVersion(budgetId: number, body?: BudgetVersionCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a budget * * @param body Data representing the budget being created */ createBudgetWithHttpInfo(body?: BudgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a budget version * * @param budgetId The identifier for the budget to create the version on * @param body Data representing the budgetVersion being created */ createBudgetVersionWithHttpInfo(budgetId: number, body?: BudgetVersionCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a budget * * @param budgetId The identifier for the budget being deleted */ deleteBudget(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being deleted */ deleteBudgetVersion(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a budget * * @param budgetId The identifier for the budget being deleted */ deleteBudgetWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being deleted */ deleteBudgetVersionWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits a budget * * @param budgetId The identifier for the budget being edited * @param body Data representing the budget being edited */ editBudget(budgetId: number, body?: BudgetEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param body Data representing the budgetVersion being edited */ editBudgetVersion(budgetId: number, versionId: number, body?: BudgetVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Import a budget setup sheet * * @param budgetId The budget identifier * @param versionId The budget version identifier * @param body The budget sheet file contents */ postBudgetSetupSheet(budgetId: number, versionId: number, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Sets a budget version as active, and all other versions as inactive. * * @param budgetId The identifier for the budget * @param versionId The identifier for the version to set as active */ setBudgetVersionActive(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a budget * * @param budgetId The identifier for the budget being edited * @param body Data representing the budget being edited */ editBudgetWithHttpInfo(budgetId: number, body?: BudgetEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a budget version * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param body Data representing the budgetVersion being edited */ editBudgetVersionWithHttpInfo(budgetId: number, versionId: number, body?: BudgetVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Import a budget setup sheet * * @param budgetId The budget identifier * @param versionId The budget version identifier * @param body The budget sheet file contents */ postBudgetSetupSheetWithHttpInfo(budgetId: number, versionId: number, body?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Sets a budget version as active, and all other versions as inactive. * * @param budgetId The identifier for the budget * @param versionId The identifier for the version to set as active */ setBudgetVersionActiveWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves the budget by ID * * @param budgetId The identifier for the budget being retrieved */ getBudget(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of available budget data types * */ getBudgetDataTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of budget period types * */ getBudgetPeriodTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of available budget usage methods * */ getBudgetUsageMethods(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a specific version for a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved */ getBudgetVersion(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the summary for a specific version on a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param commodityId The optional commodity filter */ getBudgetVersionSummary(budgetId: number, versionId: number, commodityId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the versions for a specified budget * * @param budgetId The identifier for the budget to retrieve all versions */ getBudgetVersions(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the budgets * */ getBudgets(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the budget by ID * * @param budgetId The identifier for the budget being retrieved */ getBudgetWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of available budget data types * */ getBudgetDataTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of budget period types * */ getBudgetPeriodTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of available budget usage methods * */ getBudgetUsageMethodsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a specific version for a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved */ getBudgetVersionWithHttpInfo(budgetId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the summary for a specific version on a budget * * @param budgetId The identifier for the budget * @param versionId The identifier for the version being retrieved * @param commodityId The optional commodity filter */ getBudgetVersionSummaryWithHttpInfo(budgetId: number, versionId: number, commodityId?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the versions for a specified budget * * @param budgetId The identifier for the budget to retrieve all versions */ getBudgetVersionsWithHttpInfo(budgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the budgets * */ getBudgetsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a meter group category * * @param body Data representing the meter group category being created */ createMeterCategory(body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a meter group * * @param body Data representing the meter group being created */ createMeterGroup(body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place group category * * @param body Data representing the place group category being created */ createPlaceCategory(body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a place group * * @param body Data representing the place group being created */ createPlaceGroup(body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a meter group * * @param meterGroupId Id of the group to edit * @param body Data representing the meter group being edited */ editMeterGroup(meterGroupId: number, body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a place group * * @param placeGroupId Id of the group to edit * @param body Data representing the place group being edited */ editPlaceGroup(placeGroupId: number, body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a meter group category * * @param body Data representing the meter group category being created */ createMeterCategoryWithHttpInfo(body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a meter group * * @param body Data representing the meter group being created */ createMeterGroupWithHttpInfo(body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a place group category * * @param body Data representing the place group category being created */ createPlaceCategoryWithHttpInfo(body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a place group * * @param body Data representing the place group being created */ createPlaceGroupWithHttpInfo(body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a meter group * * @param meterGroupId Id of the group to edit * @param body Data representing the meter group being edited */ editMeterGroupWithHttpInfo(meterGroupId: number, body?: MeterGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a place group * * @param placeGroupId Id of the group to edit * @param body Data representing the place group being edited */ editPlaceGroupWithHttpInfo(placeGroupId: number, body?: PlaceGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete a meter group category * * @param categoryId Id of the category to delete */ deleteMeterCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user-created meter group * * @param meterGroupId */ deleteMeterGroup(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a place group category * * @param categoryId Id of the category to delete */ deletePlaceCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user-created place group * * @param placeGroupId */ deletePlaceGroup(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a meter group category * * @param categoryId Id of the category to delete */ deleteMeterCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user-created meter group * * @param meterGroupId */ deleteMeterGroupWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a place group category * * @param categoryId Id of the category to delete */ deletePlaceCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user-created place group * * @param placeGroupId */ deletePlaceGroupWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Update a meter group category * * @param categoryId Id of the category to update * @param body Data to update the meter group category */ editMeterCategory(categoryId: number, body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a meter's group memberships. Note that all groups a meter should belong to must be passed in. Passing in one group means that the meter will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param meterId The meter identifier whose group memberships are being edited * @param body The groups the meter will belong to */ editMeterGroupMembership(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a place group category * * @param categoryId Id of the category to update * @param body Data to update the place group category */ editPlaceCategory(categoryId: number, body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a place's group memberships. Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param placeId The place identifier whose group memberships are being edited * @param body The groups the place will belong to */ editPlaceGroupMembership(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Include all group members in charts * * @param meterGroupId */ includeAllMeterGroupMemberInCharts(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Include all group members in charts * * @param placeGroupId */ includeAllPlaceGroupMemberInCharts(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserMeterAutoGroupsMembership(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserPlaceAutoGroupsMembership(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for a user defined auto group * * @param meterGroupId The meter group to refresh */ recalculateUserMeterAutoGroupMemebership(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Refreshes group membership for a user defined auto group * * @param placeGroupId The place group to refresh */ recalculateUserPlaceAutoGroupMemebership(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a group member's include in charts flag * * @param meterGroupId * @param meterId * @param body */ updateMeterGroupMember(meterGroupId: number, meterId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a group member's include in charts flag * * @param placeGroupId * @param placeId * @param body */ updatePlaceGroupMember(placeGroupId: number, placeId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a meter group category * * @param categoryId Id of the category to update * @param body Data to update the meter group category */ editMeterCategoryWithHttpInfo(categoryId: number, body?: MeterCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a meter's group memberships. Note that all groups a meter should belong to must be passed in. Passing in one group means that the meter will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param meterId The meter identifier whose group memberships are being edited * @param body The groups the meter will belong to */ editMeterGroupMembershipWithHttpInfo(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update a place group category * * @param categoryId Id of the category to update * @param body Data to update the place group category */ editPlaceCategoryWithHttpInfo(categoryId: number, body?: PlaceCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a place's group memberships. Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only, even if it previously belonged to several. Only manual groups assignments can be changed; auto groups are unaffected. * * @param placeId The place identifier whose group memberships are being edited * @param body The groups the place will belong to */ editPlaceGroupMembershipWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Include all group members in charts * * @param meterGroupId */ includeAllMeterGroupMemberInChartsWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Include all group members in charts * * @param placeGroupId */ includeAllPlaceGroupMemberInChartsWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserMeterAutoGroupsMembershipWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for all user defined auto groups * */ recalculateAllUserPlaceAutoGroupsMembershipWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for a user defined auto group * * @param meterGroupId The meter group to refresh */ recalculateUserMeterAutoGroupMemebershipWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Refreshes group membership for a user defined auto group * * @param placeGroupId The place group to refresh */ recalculateUserPlaceAutoGroupMemebershipWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a group member's include in charts flag * * @param meterGroupId * @param meterId * @param body */ updateMeterGroupMemberWithHttpInfo(meterGroupId: number, meterId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a group member's include in charts flag * * @param placeGroupId * @param placeId * @param body */ updatePlaceGroupMemberWithHttpInfo(placeGroupId: number, placeId: number, body?: GroupMemberRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an ESA place * * @param body Data representing the ESA place being created */ createEsaPlace(body?: EsaPlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place * * @param body Data representing the place being created */ createPlace(body?: PlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a Primary Use * * @param body Data representing the Primary Use being created */ createPrimaryUse(body?: PrimaryUseCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA place * * @param body Data representing the ESA place being created */ createEsaPlaceWithHttpInfo(body?: EsaPlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a place * * @param body Data representing the place being created */ createPlaceWithHttpInfo(body?: PlaceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a Primary Use * * @param body Data representing the Primary Use being created */ createPrimaryUseWithHttpInfo(body?: PrimaryUseCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes an ESA place * * @param placeId The identifier for the ESA place being deleted */ deleteEsaPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a place * * @param placeId The identifier for the place being deleted */ deletePlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a primary use * * @param primaryUseId The identifier for the primary use being deleted */ deletePrimaryUse(primaryUseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA place * * @param placeId The identifier for the ESA place being deleted */ deleteEsaPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a place * * @param placeId The identifier for the place being deleted */ deletePlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a primary use * * @param primaryUseId The identifier for the primary use being deleted */ deletePrimaryUseWithHttpInfo(primaryUseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Accept any pending property and meter share requests from ENERGY STAR Portfolio Manager * */ acceptPropertyAndMeterSharingRequests(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Set and Reset the data Rollup from esa place * * @param body The list of placeIds and If the Rollup is true or false */ bulkEditDataRollup(body?: EsaPlaceDataRollupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place benchmark value If a preceding benchmark value exists, the preceding record's end date will be changed to match the created records begin date If a succeeding benchmark value exists, the created record's end date will match the succeeding benchmarks begin date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param body The new begin date and value for the benchmark */ createPlaceBenchmarkValue(benchmarkIndicator: number, placeId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a place size version If a preceding place size version exists, the preceding record's end date will be changed to match the created record's begin date If a succeeding place size version exists the created records end date will match the succeeding version's begin date * * @param placeId The identifier of the place to add a place size to * @param body Data representing the place size being created */ createPlaceSize(placeId: number, body?: PlaceSizeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a place type * New place types will not be considered structures * @param body Definition of new place type */ createPlaceType(body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a schedule * * @param body Data representing the schedule being created */ createSchedule(body?: ScheduleCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a single benchmark value. If a preceding benchmark value exists, the preceding record’s end date will be changed to prevent any gaps in benchmark values * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Indicator for the place * @param placeBenchmarkId Indicator for the individual benchmark value */ deleteBenchmarkValue(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a place size version The preceding version's end date will be shifted to the deleted record's end date to prevent any gaps * * @param placeId The identifier of the place * @param placeSizeId The identifier of the place size */ deletePlaceSize(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes the place type * * @param placeTypeId Unique identifier for the place type */ deletePlaceType(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a schedule * * @param scheduleId The schedule identifier */ deleteSchedule(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the ENERGY STAR linking information for this place and its meters. Set PmPropertyId/PmMeterId to null to unlink a property/meter. Set PmMeterId to -1 to auto-create a new meter. * * @param placeId The place identifier * @param body Data representing the place link being edited */ editEnergyStarPlaceLink(placeId: number, body?: EnergyStarPlaceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA place * * @param placeId The identifier for the ESA place being edited * @param body Data representing the ESA place being edited */ editEsaPlace(placeId: number, body?: EsaPlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manages the schedules of a place * * @param placeId The place identifier * @param body A list of schedule identifiers to assign */ editEsaPlaceSchedules(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manages the version history for a single ESA place. This endpoint handles Creating, Editing, and Deleting place sizes for ESA places in bulk. * * @param placeId * @param body */ editEsaPlaceSizeHistory(placeId: number, body?: EditEsaPlaceSizesRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a place * * @param placeId The identifier for the place being edited * @param body Data representing the place being edited */ editPlace(placeId: number, body?: PlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit all values for a benchmark factor on a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId * @param body */ editPlaceBenchmarkValues(benchmarkIndicator: number, placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk * * @param placeId The identifier of the place * @param body Data representing the place size being created */ editPlaceSizeList(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a current place type * * @param placeTypeId Unique identifier for the place type * @param body Definition of new place type */ editPlaceType(placeTypeId: number, body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular place * * @param placeId The identifier for the place * @param body Data representing the place user defined fields / custom fields being edited */ editPlaceUDFs(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a schedule * * @param scheduleId The schedule identifier * @param body Data representing the schedule being edited */ editSchedule(scheduleId: number, body?: ScheduleEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit SmartAnalytics (Wattics) data on a place * * @param placeId The place identifier for the place to edit * @param body Identifier for the SmartAnalytics (Wattics) site to assign to the place */ editWatticsSiteLink(placeId: number, body?: WatticsSiteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of places to be under a parent place * * @param parentPlaceId The identifier for the new parent place * @param body List of place identifiers to move */ moveEsaPlace(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of places to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of placeIds to move under the parentPlaceId */ movePlace(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink a list of places and their child meters from ENERGY STAR * * @param body List of place identifiers to unlink from ENERGY STAR */ unlinkPlacesAndChildMetersFromEnergyStar(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a list of places to be submitted to ENERGY STAR manually or automatically * * @param body The list of places to update, as well as the submission type to set */ updateEnergyStarSubmissionType(body?: PlaceSubmissionTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates a place benchmark value If the begin date is being modified, the following will happen: * Records that now precede and previously preceded this benchmark will have their end dates modified to prevent gaps in benchmarks * If a succeeding benchmark value exists for the new begin date, the end date will be modified to match the succeeding benchmarks end date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param placeBenchmarkId The identifier for the benchmark being updated * @param body The new begin date and value for the benchmark */ updatePlaceBenchmarkValue(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Accept any pending property and meter share requests from ENERGY STAR Portfolio Manager * */ acceptPropertyAndMeterSharingRequestsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Set and Reset the data Rollup from esa place * * @param body The list of placeIds and If the Rollup is true or false */ bulkEditDataRollupWithHttpInfo(body?: EsaPlaceDataRollupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a place benchmark value If a preceding benchmark value exists, the preceding record's end date will be changed to match the created records begin date If a succeeding benchmark value exists, the created record's end date will match the succeeding benchmarks begin date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param body The new begin date and value for the benchmark */ createPlaceBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a place size version If a preceding place size version exists, the preceding record's end date will be changed to match the created record's begin date If a succeeding place size version exists the created records end date will match the succeeding version's begin date * * @param placeId The identifier of the place to add a place size to * @param body Data representing the place size being created */ createPlaceSizeWithHttpInfo(placeId: number, body?: PlaceSizeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a place type * New place types will not be considered structures * @param body Definition of new place type */ createPlaceTypeWithHttpInfo(body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a schedule * * @param body Data representing the schedule being created */ createScheduleWithHttpInfo(body?: ScheduleCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a single benchmark value. If a preceding benchmark value exists, the preceding record’s end date will be changed to prevent any gaps in benchmark values * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Indicator for the place * @param placeBenchmarkId Indicator for the individual benchmark value */ deleteBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a place size version The preceding version's end date will be shifted to the deleted record's end date to prevent any gaps * * @param placeId The identifier of the place * @param placeSizeId The identifier of the place size */ deletePlaceSizeWithHttpInfo(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes the place type * * @param placeTypeId Unique identifier for the place type */ deletePlaceTypeWithHttpInfo(placeTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a schedule * * @param scheduleId The schedule identifier */ deleteScheduleWithHttpInfo(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the ENERGY STAR linking information for this place and its meters. Set PmPropertyId/PmMeterId to null to unlink a property/meter. Set PmMeterId to -1 to auto-create a new meter. * * @param placeId The place identifier * @param body Data representing the place link being edited */ editEnergyStarPlaceLinkWithHttpInfo(placeId: number, body?: EnergyStarPlaceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA place * * @param placeId The identifier for the ESA place being edited * @param body Data representing the ESA place being edited */ editEsaPlaceWithHttpInfo(placeId: number, body?: EsaPlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manages the schedules of a place * * @param placeId The place identifier * @param body A list of schedule identifiers to assign */ editEsaPlaceSchedulesWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manages the version history for a single ESA place. This endpoint handles Creating, Editing, and Deleting place sizes for ESA places in bulk. * * @param placeId * @param body */ editEsaPlaceSizeHistoryWithHttpInfo(placeId: number, body?: EditEsaPlaceSizesRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits a place * * @param placeId The identifier for the place being edited * @param body Data representing the place being edited */ editPlaceWithHttpInfo(placeId: number, body?: PlaceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit all values for a benchmark factor on a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId * @param body */ editPlaceBenchmarkValuesWithHttpInfo(benchmarkIndicator: number, placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk * * @param placeId The identifier of the place * @param body Data representing the place size being created */ editPlaceSizeListWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit a current place type * * @param placeTypeId Unique identifier for the place type * @param body Definition of new place type */ editPlaceTypeWithHttpInfo(placeTypeId: number, body?: PlaceTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular place * * @param placeId The identifier for the place * @param body Data representing the place user defined fields / custom fields being edited */ editPlaceUDFsWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits a schedule * * @param scheduleId The schedule identifier * @param body Data representing the schedule being edited */ editScheduleWithHttpInfo(scheduleId: number, body?: ScheduleEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit SmartAnalytics (Wattics) data on a place * * @param placeId The place identifier for the place to edit * @param body Identifier for the SmartAnalytics (Wattics) site to assign to the place */ editWatticsSiteLinkWithHttpInfo(placeId: number, body?: WatticsSiteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of places to be under a parent place * * @param parentPlaceId The identifier for the new parent place * @param body List of place identifiers to move */ moveEsaPlaceWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of places to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of placeIds to move under the parentPlaceId */ movePlaceWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink a list of places and their child meters from ENERGY STAR * * @param body List of place identifiers to unlink from ENERGY STAR */ unlinkPlacesAndChildMetersFromEnergyStarWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a list of places to be submitted to ENERGY STAR manually or automatically * * @param body The list of places to update, as well as the submission type to set */ updateEnergyStarSubmissionTypeWithHttpInfo(body?: PlaceSubmissionTypeRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a place benchmark value If the begin date is being modified, the following will happen: * Records that now precede and previously preceded this benchmark will have their end dates modified to prevent gaps in benchmarks * If a succeeding benchmark value exists for the new begin date, the end date will be modified to match the succeeding benchmarks end date * * @param benchmarkIndicator Indicator for the benchmark, can be 1, 2, or 3 * @param placeId The place that the benchmark is on * @param placeBenchmarkId The identifier for the benchmark being updated * @param body The new begin date and value for the benchmark */ updatePlaceBenchmarkValueWithHttpInfo(benchmarkIndicator: number, placeId: number, placeBenchmarkId: number, body?: BenchmarkValueRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * For a list of topmost places, get associated topmost cost centers. * * @param body List of placeIds to get associated topmost cost centers. */ availableCostCentersForTopmostPlaces(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a energy project custom field * * @param energyProjectId The id of the energy project * @param udfId The id of the custom field */ downloadEnergyProjectCustomFields(energyProjectId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a place custom field * * @param placeId * @param udfId */ downloadPlaceCustomFieldFile(placeId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves benchmark values for a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Identifier for the place */ getBenchmarkValues(benchmarkIndicator: number, placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get an energy project * * @param projectId The identifier for the energy project to retrieve */ getEnergyProject(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for a energy project * * @param energyProjectId The id of the energy project */ getEnergyProjectCustomFields(energyProjectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the energy project managers * * @param query */ getEnergyProjectManager(query?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all the energy project types * */ getEnergyProjectTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children's energy projects * * @param placeId The place identifier for which energy projects are being retrieved */ getEnergyProjectsForPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all commodities and, if configured, their mappings in ENERGY STAR * */ getEnergyStarCommodityMappings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR info for a place. * * @param placeId The place identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getEnergyStarPlace(placeId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get this place's ENERGY STAR child places * * @param placeId The place identifier * @param filter */ getEnergyStarPlaceHierarchy(placeId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR linking information for this place and its meters. PmPropertyId and PmMeterId will be null if no link yet exists. * * @param placeId The place identifier */ getEnergyStarPlaceLink(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the ENERGY STAR metrics for a place. * * @param placeId The place identifier * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarPlaceMetrics(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get settings for ENERGY STAR submissions * */ getEnergyStarSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an ESA place by place ID * * @param placeId The identifier for the ESA place being retrieved */ getEsaPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the current sizes of all of an ESA place's children. If a place has no children, nothing is returned. * * @param placeId */ getEsaPlaceChildrenSizes(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the schedules of a place * * @param placeId The place identifier */ getEsaPlaceSchedules(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the entire size history of an ESA place by ID * * @param placeId */ getEsaPlaceSizeHistory(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves energy use intensity data for a place. If data is requested for an organization, then all the places under the organization will be rolled up. * * @param placeId The place to retrieve data for */ getEuiChartData(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one place * * @param placeId The identifier for the place being retrieved */ getPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceActualMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceActualYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total cost and cost for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedCostComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Return the total ghg and ghg for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedGhgComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceCalendarizedMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceCalendarizedYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Place Groups for a particular place by placeId * * @param placeId The place identifier for which group values are being retrieved */ getPlaceGroups(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) */ getPlaceNomalizedMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total use and use for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceNormalizedUseComparison(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceNormalizedYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceSavingsMonthly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param placeId * @param numberOfYears */ getPlaceSavingsYearly(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a place size record for a particular place * * @param placeId The identifier for the place being retrieved * @param placeSizeId The identifier for the place size being retrieved */ getPlaceSize(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all place size records for a particular place * * @param placeId The identifier for the place being retrieved */ getPlaceSizes(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular place * * @param placeId The place identifier for which user defined field / custom field values are being retrieved */ getPlaceUdfs(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaces(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get list of Portfolio Manager properties * * @param includeOnlyUnlinked Include only unlinked properties * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerProperties(includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Portfolio Manager property * * @param pmPropertyId Portfolio Manager property identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerProperty(pmPropertyId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get list of Portfolio Manager meters for a property * * @param pmPropertyId Portfolio Manager property identifier * @param includeOnlyUnlinked Include only unlinked meters * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmMeterId and PmMeterName from Portfolio Manager. PmCommodityCode and PmUnitCode will be null. */ getPortfolioManagerPropertyMeters(pmPropertyId: number, includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the specified schedule * * @param scheduleId The schedule identifier */ getSchedule(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all schedules * */ getSchedules(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the data point ancestry information, useful for populating a tree of spaces * * @param dataPointId Data point Id */ hierarchicalAncestryDataPoints(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns meter ancestry information, useful for populating a tree of places * * @param meterId Meter ID */ hierarchicalAncestryMeters(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns place ancestry information, useful for populating a tree of places * * @param placeId Place ID */ hierarchicalAncestryPlaces(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the space ancestry information, useful for populating a tree of spaces * * @param placeId Place Id */ hierarchicalAncestrySpaces(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns place descendant information, useful for expanding a place node * * @param placeId Place ID */ hierarchicalPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns the space descendant information, useful for expanding a space node * * @param placeId Place Id */ hierarchicalSpace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For a list of topmost places, get associated topmost cost centers. * * @param body List of placeIds to get associated topmost cost centers. */ availableCostCentersForTopmostPlacesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Download file for a energy project custom field * * @param energyProjectId The id of the energy project * @param udfId The id of the custom field */ downloadEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a place custom field * * @param placeId * @param udfId */ downloadPlaceCustomFieldFileWithHttpInfo(placeId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves benchmark values for a place * * @param benchmarkIndicator Indicator for the benchmark * @param placeId Identifier for the place */ getBenchmarkValuesWithHttpInfo(benchmarkIndicator: number, placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an energy project * * @param projectId The identifier for the energy project to retrieve */ getEnergyProjectWithHttpInfo(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a energy project * * @param energyProjectId The id of the energy project */ getEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the energy project managers * * @param query */ getEnergyProjectManagerWithHttpInfo(query?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all the energy project types * */ getEnergyProjectTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children's energy projects * * @param placeId The place identifier for which energy projects are being retrieved */ getEnergyProjectsForPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all commodities and, if configured, their mappings in ENERGY STAR * */ getEnergyStarCommodityMappingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ENERGY STAR info for a place. * * @param placeId The place identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getEnergyStarPlaceWithHttpInfo(placeId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get this place's ENERGY STAR child places * * @param placeId The place identifier * @param filter */ getEnergyStarPlaceHierarchyWithHttpInfo(placeId: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ENERGY STAR linking information for this place and its meters. PmPropertyId and PmMeterId will be null if no link yet exists. * * @param placeId The place identifier */ getEnergyStarPlaceLinkWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ENERGY STAR metrics for a place. * * @param placeId The place identifier * @param numberOfYears The number of years to go back from most recent score. Defaults to 2 years. If 0 is provided, will only include current score. */ getEnergyStarPlaceMetricsWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get settings for ENERGY STAR submissions * */ getEnergyStarSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA place by place ID * * @param placeId The identifier for the ESA place being retrieved */ getEsaPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the current sizes of all of an ESA place's children. If a place has no children, nothing is returned. * * @param placeId */ getEsaPlaceChildrenSizesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets the schedules of a place * * @param placeId The place identifier */ getEsaPlaceSchedulesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the entire size history of an ESA place by ID * * @param placeId */ getEsaPlaceSizeHistoryWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all ESA places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves energy use intensity data for a place. If data is requested for an organization, then all the places under the organization will be rolled up. * * @param placeId The place to retrieve data for */ getEuiChartDataWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one place * * @param placeId The identifier for the place being retrieved */ getPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceActualMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceActualYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Return the total cost and cost for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedCostComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return the total ghg and ghg for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceCalendarizedGhgComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceCalendarizedMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for calendarized and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceCalendarizedYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all Place Groups for a particular place by placeId * * @param placeId The place identifier for which group values are being retrieved */ getPlaceGroupsWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) */ getPlaceNomalizedMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes use on a monthly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for normalized and savings, and 24 or 26 (if 13 accounting periods) for normalized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNomalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Return the total use and use for each commodity under a place for comparison Example calculating the current and previous ranges: Today is 2022-10-06 chartMonthsToExclude = 2, numMonths = 6, comparisonYearsAgo = 3 CurrentPeriodRange is 202203 - 202208 and PreviousPeriodRange is 201903 - 201908 * * @param placeId Id of the place to lookup * @param chartMonthsToExclude Optional, the number of months to exclude from intensity data, 0 includes all months including the current one. Defaults to the system setting otherwise 0. * @param numMonths Optional, the number of months of intensity data to include, the end month is respective of chartMonthsToExclude. Defaults to 12. * @param comparisonYearsAgo The comparisonYearsAgo is the number of years to go back to do the comparison. Defaults to 1. */ getPlaceNormalizedUseComparisonWithHttpInfo(placeId: number, chartMonthsToExclude?: number, numMonths?: number, comparisonYearsAgo?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getPlaceNormalizedYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by building/organization for a given number of years- Result include use on an yearly basis. It also includes target comparison data and commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes target comparison data and commodity level break up. * * @param placeId The place to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getPlaceSavingsMonthlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings data by building/organization for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param placeId * @param numberOfYears */ getPlaceSavingsYearlyWithHttpInfo(placeId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by building/organization for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes a commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlaceSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a place size record for a particular place * * @param placeId The identifier for the place being retrieved * @param placeSizeId The identifier for the place size being retrieved */ getPlaceSizeWithHttpInfo(placeId: number, placeSizeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all place size records for a particular place * * @param placeId The identifier for the place being retrieved */ getPlaceSizesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular place * * @param placeId The place identifier for which user defined field / custom field values are being retrieved */ getPlaceUdfsWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all places * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getPlacesUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get list of Portfolio Manager properties * * @param includeOnlyUnlinked Include only unlinked properties * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerPropertiesWithHttpInfo(includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a Portfolio Manager property * * @param pmPropertyId Portfolio Manager property identifier * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmPropertyId and PmPropertyName from Portfolio Manager. PmPropertyUseType, PmFloorArea, PmFloorAreaUnits will be null. */ getPortfolioManagerPropertyWithHttpInfo(pmPropertyId: number, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get list of Portfolio Manager meters for a property * * @param pmPropertyId Portfolio Manager property identifier * @param includeOnlyUnlinked Include only unlinked meters * @param verbose true by default. When set to false the API will perform faster but will only retrieve PmMeterId and PmMeterName from Portfolio Manager. PmCommodityCode and PmUnitCode will be null. */ getPortfolioManagerPropertyMetersWithHttpInfo(pmPropertyId: number, includeOnlyUnlinked?: boolean, verbose?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the specified schedule * * @param scheduleId The schedule identifier */ getScheduleWithHttpInfo(scheduleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all schedules * */ getSchedulesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns the data point ancestry information, useful for populating a tree of spaces * * @param dataPointId Data point Id */ hierarchicalAncestryDataPointsWithHttpInfo(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns meter ancestry information, useful for populating a tree of places * * @param meterId Meter ID */ hierarchicalAncestryMetersWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns place ancestry information, useful for populating a tree of places * * @param placeId Place ID */ hierarchicalAncestryPlacesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the space ancestry information, useful for populating a tree of spaces * * @param placeId Place Id */ hierarchicalAncestrySpacesWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns place descendant information, useful for expanding a place node * * @param placeId Place ID */ hierarchicalPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns the space descendant information, useful for expanding a space node * * @param placeId Place Id */ hierarchicalSpaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsChargebackReversalsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param taskId Identifier for the chargeback task */ deleteChargebackTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by a chargeback workflow step If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ deleteChargebackWorkflowSteps(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param taskId Identifier for the chargeback task */ voidChargebackTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Void all bills created by a chargeback workflow step for a particular billing period If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ voidChargebackWorkflowSteps(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param taskId Identifier for the chargeback task */ deleteChargebackTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete all bills created by a chargeback workflow step If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be deleted * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ deleteChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by the chargeback task If this is a split task, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param taskId Identifier for the chargeback task */ voidChargebackTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Void all bills created by a chargeback workflow step for a particular billing period If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided If this is a split step, any source bills will be reset to has not been split If any bills have already been exported they will still be voided * * @param chargebackWorkflowStepId Chargeback Workflow Step ID * @param billingPeriod Billing period to undo */ voidChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsChargebacksManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Assign a list of bill split or calculate bill versions to a chargeback workflow step of the same type * * @param chargebackWorkflowStepId ID of the chargeback workflow step to which the versions will be assigned * @param billingPeriod The billing period to validate that the provided versions are effective * @param body The chargeback versions to assign to the provided chargeback workflow step */ assignVersionsToStep(chargebackWorkflowStepId: number, billingPeriod: number, body?: AssignVersionsToStep, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a chargeback workflow * * @param body Definition for chargeback workflow */ createChargebackWorkflow(body?: ChargebackWorkflowCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ deleteChargebackWorkflow(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id * @param body Definition for chargeback workflow */ editChargebackWorkflow(chargebackWorkflowId: number, body?: ChargebackWorkflowEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage calculated bill account line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the account line items. */ manageAccountLineItems(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage details for a bill split distribution * * @param accountId ID of the master account * @param meterId ID of the master meter * @param versionId ID of the version to update bill split details * @param body Definition of details for bill split */ manageBillSplitDetails(accountId: number, meterId: number, versionId: number, body?: BillSplitDetailsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage a bill split's version history All bill split versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a bill split version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account whose bill split versions will be updated * @param meterId ID of the meter whose bill split versions will be updated * @param body List of bill split distribution versions to add or edit */ manageBillSplitVersionHistory(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's cost If cost does not exist on the distribution it will be added If one exists it will be saved as the option sent in Since cost is required for the calculated bill distribution to work. One option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its cost */ manageCalculateBillCost(accountId: number, meterId: number, versionId: number, body?: CalculatedBillCostRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage calculated bill's demand If demand does not exist on the distribution it will be added If one exists it will be saved as the option sent in If the dto sends null for both (channel and fixed), then demand will get cleared * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its demand */ manageCalculateBillDemand(accountId: number, meterId: number, versionId: number, body?: CalculatedBillDemandRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage calculated bill's use * If use does not exist on the distribution it will be added * If use already exists it will be saved as the option sent in and any existing inputs will be deleted * Since use is required for the calculated bill distribution to work, one option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its use */ manageCalculateBillUse(accountId: number, meterId: number, versionId: number, body?: CalculatedBillUseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Manage a calculated bill's version history All calculated bill versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a calculated bill version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param body List of calculated bill distribution versions to add or edit */ manageCalculatedBillVersionHistory(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill meter line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the meter line items */ manageMeterLineItems(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Assign a list of bill split or calculate bill versions to a chargeback workflow step of the same type * * @param chargebackWorkflowStepId ID of the chargeback workflow step to which the versions will be assigned * @param billingPeriod The billing period to validate that the provided versions are effective * @param body The chargeback versions to assign to the provided chargeback workflow step */ assignVersionsToStepWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod: number, body?: AssignVersionsToStep, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a chargeback workflow * * @param body Definition for chargeback workflow */ createChargebackWorkflowWithHttpInfo(body?: ChargebackWorkflowCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ deleteChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id * @param body Definition for chargeback workflow */ editChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, body?: ChargebackWorkflowEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill account line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the account line items. */ manageAccountLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage details for a bill split distribution * * @param accountId ID of the master account * @param meterId ID of the master meter * @param versionId ID of the version to update bill split details * @param body Definition of details for bill split */ manageBillSplitDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: BillSplitDetailsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage a bill split's version history All bill split versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a bill split version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account whose bill split versions will be updated * @param meterId ID of the meter whose bill split versions will be updated * @param body List of bill split distribution versions to add or edit */ manageBillSplitVersionHistoryWithHttpInfo(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage calculated bill's cost If cost does not exist on the distribution it will be added If one exists it will be saved as the option sent in Since cost is required for the calculated bill distribution to work. One option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its cost */ manageCalculateBillCostWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillCostRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's demand If demand does not exist on the distribution it will be added If one exists it will be saved as the option sent in If the dto sends null for both (channel and fixed), then demand will get cleared * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its demand */ manageCalculateBillDemandWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillDemandRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage calculated bill's use * If use does not exist on the distribution it will be added * If use already exists it will be saved as the option sent in and any existing inputs will be deleted * Since use is required for the calculated bill distribution to work, one option is always required and cannot be deleted * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of how the meter will calculate its use */ manageCalculateBillUseWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: CalculatedBillUseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Manage a calculated bill's version history All calculated bill versions to save on this account and meter relationship should be passed If versionId is passed, this version will be updated to the request body values If copyVersionId is passed, a new version will be created and all instructions and inputs on the copyVersionId will be copied If versionId and copyVersionId are null a new version will be created Versions cannot overlap If a calculated bill version currently exists in the database, but is not passed in it will be deleted Only versions that are not currently associated with any bills can be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param body List of calculated bill distribution versions to add or edit */ manageCalculatedBillVersionHistoryWithHttpInfo(accountId: number, meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Manage calculated bill meter line items The order of items in the list defines the calculation order All line items to save should be passed If a line currently exists and is not passed in it will be deleted If any part of the create, update, or delete process fails, the entire process is rolled back * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version * @param body Definition of the meter line items */ manageMeterLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsChargebacksModuleViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersions(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ getChargebackWorkflow(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a digest of all bills by meter for all meters involved in a chargeback workflow step for a given billing period. * * @param chargebackWorkflowStepId The id of the chargeback workflow step. * @param billingPeriod The billing period of the digest. */ getChargebackWorkflowDigest(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get chargeback workflow settings * */ getChargebackWorkflowSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a single chargeback workflow step * * @param chargebackWorkflowStepId Workflow step ID */ getChargebackWorkflowStep(chargebackWorkflowStepId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of chargeback workflow steps * * @param chargebackWorkflowType Pass either \"split\" or \"calculation\" to filter workflow steps */ getChargebackWorkflowSteps(chargebackWorkflowType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of chargeback workflows * */ getChargebackWorkflows(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of customers. * * @param filter */ getCustomers(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of bill split versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getBillSplitVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions which match the provided filter conditions * * @param filter API filter string containing conditions * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCalculatedBillVersionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a chargeback workflow * * @param chargebackWorkflowId Chargeback workflow id */ getChargebackWorkflowWithHttpInfo(chargebackWorkflowId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a digest of all bills by meter for all meters involved in a chargeback workflow step for a given billing period. * * @param chargebackWorkflowStepId The id of the chargeback workflow step. * @param billingPeriod The billing period of the digest. */ getChargebackWorkflowDigestWithHttpInfo(chargebackWorkflowStepId: number, billingPeriod?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get chargeback workflow settings * */ getChargebackWorkflowSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single chargeback workflow step * * @param chargebackWorkflowStepId Workflow step ID */ getChargebackWorkflowStepWithHttpInfo(chargebackWorkflowStepId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of chargeback workflow steps * * @param chargebackWorkflowType Pass either \"split\" or \"calculation\" to filter workflow steps */ getChargebackWorkflowStepsWithHttpInfo(chargebackWorkflowType?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of chargeback workflows * */ getChargebackWorkflowsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of customers. * * @param filter */ getCustomersWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsChargebacksRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Run the bill split processor on the given list of bills. Optional note can be provided. Optional batch settings can be provided that will allow custom batchcode and bill headers for the destination bills * * @param body */ billActionSplit(body?: BillActionSplit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process one or more Bill Split distributions for a specific billing period * * @param body */ executeBillSplitProcessor(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process one or more Calculated Bill distributions for a specific billing period * * @param body */ executeCalculateBillProcessor(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process one or more Calculated Bill aggregations within a billing period range ending with the specified billing period. If billing period is not supplied, the current period will be assumed. * * @param body */ executeProcessorAggregations(body?: ChargebackProcessorSettingsForAggregations, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Process distributions assigned to a chargeback workflow for a specific billing period. If settings are not provided, the last month will be processed. * * @param chargebackWorkflowId The chargeback workflow id * @param body The processor settings */ executeProcessorByWorkflow(chargebackWorkflowId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process distributions assigned to a chargeback workflow step for a specific billing period * * @param chargebackWorkflowStepId The chargeback workflow step id. * @param body The other processor settings. */ executeProcessorByWorkflowStep(chargebackWorkflowStepId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Split all bills eligible to be split in a bill list * * @param listId The list identifier * @param body Optional note and batch settings can be provided. Batch Settings will allow custom batchcode and bill headers for the destination bills */ splitBillList(listId: number, body?: ChargebackProcessorSettingsForSplits, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a chargeback task's comment * * @param taskId Identifier for the chargeback task to update * @param body Data representing the comment */ updateChargebackTask(taskId: number, body?: ChargebackTaskRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run the bill split processor on the given list of bills. Optional note can be provided. Optional batch settings can be provided that will allow custom batchcode and bill headers for the destination bills * * @param body */ billActionSplitWithHttpInfo(body?: BillActionSplit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process one or more Bill Split distributions for a specific billing period * * @param body */ executeBillSplitProcessorWithHttpInfo(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process one or more Calculated Bill distributions for a specific billing period * * @param body */ executeCalculateBillProcessorWithHttpInfo(body?: ChargebackProcessorSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process one or more Calculated Bill aggregations within a billing period range ending with the specified billing period. If billing period is not supplied, the current period will be assumed. * * @param body */ executeProcessorAggregationsWithHttpInfo(body?: ChargebackProcessorSettingsForAggregations, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Process distributions assigned to a chargeback workflow for a specific billing period. If settings are not provided, the last month will be processed. * * @param chargebackWorkflowId The chargeback workflow id * @param body The processor settings */ executeProcessorByWorkflowWithHttpInfo(chargebackWorkflowId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Process distributions assigned to a chargeback workflow step for a specific billing period * * @param chargebackWorkflowStepId The chargeback workflow step id. * @param body The other processor settings. */ executeProcessorByWorkflowStepWithHttpInfo(chargebackWorkflowStepId: number, body?: ChargebackProcessorSettingsWithoutFilters, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Split all bills eligible to be split in a bill list * * @param listId The list identifier * @param body Optional note and batch settings can be provided. Batch Settings will allow custom batchcode and bill headers for the destination bills */ splitBillListWithHttpInfo(listId: number, body?: ChargebackProcessorSettingsForSplits, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a chargeback task's comment * * @param taskId Identifier for the chargeback task to update * @param body Data representing the comment */ updateChargebackTaskWithHttpInfo(taskId: number, body?: ChargebackTaskRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCollectionsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a collection * * @param body Data representing the collection being created */ createCollection(body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a collection * * @param body Data representing the collection being created */ createCollectionWithHttpInfo(body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCollectionsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a collection * * @param collectionId The identifier for the collection being deleted */ deleteCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a collection * * @param collectionId The identifier for the collection being deleted */ deleteCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCollectionsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits a collection * * @param collectionId The identifier for the collection being edited * @param body Data representing the collection being edited */ editCollection(collectionId: number, body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a collection * * @param collectionId The id of the collection * @param body The list of udf values being edited */ editCollectionCustomFields(collectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param parentCollectionId * @param body */ moveCollections(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a collection * * @param collectionId The identifier for the collection being edited * @param body Data representing the collection being edited */ editCollectionWithHttpInfo(collectionId: number, body?: CollectionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a collection * * @param collectionId The id of the collection * @param body The list of udf values being edited */ editCollectionCustomFieldsWithHttpInfo(collectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * * * @param parentCollectionId * @param body */ moveCollectionsWithHttpInfo(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCollectionsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Download file for a collection custom field * * @param collectionId The id of the collection * @param udfId The id of the custom field */ downloadCollectionCustomFields(collectionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the collection by ID * * @param collectionId The identifier for the collection being retrieved */ getCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for a collection * * @param collectionId The id of the collection */ getCollectionCustomFields(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollections(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns collection ancestry information, useful for populating a tree of collections * * @param collectionId Collection ID */ hierarchicalAncestryCollections(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns emission source ancestry information, useful for populating a tree of collections * * @param emissionSourceId Emission Source ID */ hierarchicalAncestryEmissionSources(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns collection descendant information, useful for expanding a collection node * * @param collectionId Collection ID */ hierarchicalCollection(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a collection custom field * * @param collectionId The id of the collection * @param udfId The id of the custom field */ downloadCollectionCustomFieldsWithHttpInfo(collectionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the collection by ID * * @param collectionId The identifier for the collection being retrieved */ getCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for a collection * * @param collectionId The id of the collection */ getCollectionCustomFieldsWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the collections * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCollectionsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns collection ancestry information, useful for populating a tree of collections * * @param collectionId Collection ID */ hierarchicalAncestryCollectionsWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns emission source ancestry information, useful for populating a tree of collections * * @param emissionSourceId Emission Source ID */ hierarchicalAncestryEmissionSourcesWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns collection descendant information, useful for expanding a collection node * * @param collectionId Collection ID */ hierarchicalCollectionWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCostCentersCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a Cost Center * * @param body Data representing the cost center being created */ createCostCenter(body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a Cost Center * * @param body Data representing the cost center being created */ createCostCenterWithHttpInfo(body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCostCentersDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a cost center * * @param costCenterId The identifier for the cost center being deleted */ deleteCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a cost center * * @param costCenterId The identifier for the cost center being deleted */ deleteCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCostCentersEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits a cost center * * @param costCenterId The identifier for the cost center being edited * @param body Data representing the cost center being edited */ editCostCenter(costCenterId: number, body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of costCenters to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of costCenterIds to move under the parentCostCenterId */ moveCostCenter(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a cost center * * @param costCenterId The identifier for the cost center being edited * @param body Data representing the cost center being edited */ editCostCenterWithHttpInfo(costCenterId: number, body?: CostCenterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of costCenters to be under parentCostCenterId * * @param parentCostCenterId The identifier for the new parent costCenter * @param body List of costCenterIds to move under the parentCostCenterId */ moveCostCenterWithHttpInfo(parentCostCenterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsCostCentersViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * For a list of topmost cost centers, get associated topmost places. * * @param body List of costCenterIds to get associated topmost places. */ availablePlacesForTopmostCostCenters(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the cost center by ID * * @param costCenterId The identifier for the cost center being retrieved */ getCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getCostCenterActualMonthly(costCenterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearly(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns account ancestry information, useful for populating a tree of costCenters * * @param accountId Account ID */ hierarchicalAncestryAccounts(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns cost center ancestry information, useful for populating a tree of cost centers * * @param costCenterId CostCenter ID */ hierarchicalAncestryCostCenters(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns costCenter descendant information, useful for expanding a costCenter node * * @param costCenterId CostCenter ID */ hierarchicalCostCenter(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * For a list of topmost cost centers, get associated topmost places. * * @param body List of costCenterIds to get associated topmost places. */ availablePlacesForTopmostCostCentersWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the cost center by ID * * @param costCenterId The identifier for the cost center being retrieved */ getCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months */ getCostCenterActualMonthlyWithHttpInfo(costCenterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on a monthly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param costCenterId The costCenter to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyWithHttpInfo(costCenterId: number, numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by costCenter for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCenterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all the cost centers * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getCostCentersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Returns account ancestry information, useful for populating a tree of costCenters * * @param accountId Account ID */ hierarchicalAncestryAccountsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns cost center ancestry information, useful for populating a tree of cost centers * * @param costCenterId CostCenter ID */ hierarchicalAncestryCostCentersWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns costCenter descendant information, useful for expanding a costCenter node * * @param costCenterId CostCenter ID */ hierarchicalCostCenterWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsDashboardAndMapsModuleViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Add a widget to a dashboard To add widgets to a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ addWidget(dashboardId: number, body?: WidgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Copy a dashboard To copy a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Request object */ copyDashboard(dashboardId: number, body?: DashboardCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a dashboard * * @param body */ createDashboard(body?: DashboardCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the visibility of a dashboard for the current user This must be a dashboard you can see Which means you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Set Visibility */ dashboardActionVisible(dashboardId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a dashboard To delete a dashboard you must have created it or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Specific dashboard */ deleteDashboard(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a dashboard To edit a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId * @param body */ editDashboard(dashboardId: number, body?: DashboardEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Reorder, edit, and delete specific widgets on a dashboard. To edit dashboard widgets you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ editDashboardWidgets(dashboardId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Applies display settings and filters to a map dashboard. These settings are specific to map dashboards, and cannot be applied to standard dashboards. To apply these settings, You must also have either: Created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier of the dashboard to apply these settings to * @param body Object containing the settings to be applied. */ editMapDashboardSettings(dashboardId: number, body?: MapDashboardSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets the current display settings and filters for a specific map dashboard. Cannot be used to retreive settings for a standard dashboard. * * @param dashboardId The identifier of the dashboard to get the settings of */ getMapDashboardSettings(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Add a widget to a dashboard To add widgets to a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ addWidgetWithHttpInfo(dashboardId: number, body?: WidgetCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Copy a dashboard To copy a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Request object */ copyDashboardWithHttpInfo(dashboardId: number, body?: DashboardCopy, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a dashboard * * @param body */ createDashboardWithHttpInfo(body?: DashboardCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the visibility of a dashboard for the current user This must be a dashboard you can see Which means you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps View permission and the dashboard is shared with you * * @param dashboardId Specific dashboard * @param body Set Visibility */ dashboardActionVisibleWithHttpInfo(dashboardId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a dashboard To delete a dashboard you must have created it or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public * * @param dashboardId Specific dashboard */ deleteDashboardWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a dashboard To edit a dashboard you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId * @param body */ editDashboardWithHttpInfo(dashboardId: number, body?: DashboardEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Reorder, edit, and delete specific widgets on a dashboard. To edit dashboard widgets you must have created the dashboard or have DashboardAdministrator Manage permission and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId dashboard * @param body Request object */ editDashboardWidgetsWithHttpInfo(dashboardId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Applies display settings and filters to a map dashboard. These settings are specific to map dashboards, and cannot be applied to standard dashboards. To apply these settings, You must also have either: Created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier of the dashboard to apply these settings to * @param body Object containing the settings to be applied. */ editMapDashboardSettingsWithHttpInfo(dashboardId: number, body?: MapDashboardSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets the current display settings and filters for a specific map dashboard. Cannot be used to retreive settings for a standard dashboard. * * @param dashboardId The identifier of the dashboard to get the settings of */ getMapDashboardSettingsWithHttpInfo(dashboardId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsDistributedReportsSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a Report Distribution * * @param body Data representing the report distribution being created */ createReportDistribution(body?: ReportDistributionCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a Report Distribution * * @param reportDistributionId Id of the report distribution to delete */ deleteReportDistribution(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete report distribution logs older than the number of days provided only if the number of logs per distribution is in excess of 100. 100 latest logs per distribution will always be maintained * * @param olderThanDays Defaults to 3 */ deleteReportDistributionLogsOlderThan(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a Report Distribution * * @param reportDistributionId Id of the report distribution to edit * @param body Data representing the report distribution being edited */ editReportDistribution(reportDistributionId: number, body?: ReportDistributionEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run a report distribution and send the report out immediately This does not affect the current distribution schedule * * @param reportDistributionId Id of the report distribution to run * @param overrideUserIds List of systemuserIds to send the distribution to. If not provided the currently configured recipients will receive the report. If this is provided it is used in place of the currently configured recipients */ executeReportDistribution(reportDistributionId: number, overrideUserIds?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a Report Distribution * * @param reportDistributionId Id of the report distribution to get */ getReportDistribution(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a Report Distribution Filters * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionFilters(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the details for a report distribution log * * @param reportDistributionLogId Id of the report distribution log to get the details for */ getReportDistributionLogDetails(reportDistributionLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of report distribution logs * * @param includeInProgress Option to include in progress distributions. False by default */ getReportDistributionLogs(includeInProgress?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all Report Distributions * * @param filter */ getReportDistributions(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a Report Distribution * * @param body Data representing the report distribution being created */ createReportDistributionWithHttpInfo(body?: ReportDistributionCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a Report Distribution * * @param reportDistributionId Id of the report distribution to delete */ deleteReportDistributionWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete report distribution logs older than the number of days provided only if the number of logs per distribution is in excess of 100. 100 latest logs per distribution will always be maintained * * @param olderThanDays Defaults to 3 */ deleteReportDistributionLogsOlderThanWithHttpInfo(olderThanDays?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a Report Distribution * * @param reportDistributionId Id of the report distribution to edit * @param body Data representing the report distribution being edited */ editReportDistributionWithHttpInfo(reportDistributionId: number, body?: ReportDistributionEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run a report distribution and send the report out immediately This does not affect the current distribution schedule * * @param reportDistributionId Id of the report distribution to run * @param overrideUserIds List of systemuserIds to send the distribution to. If not provided the currently configured recipients will receive the report. If this is provided it is used in place of the currently configured recipients */ executeReportDistributionWithHttpInfo(reportDistributionId: number, overrideUserIds?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Report Distribution * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a Report Distribution Filters * * @param reportDistributionId Id of the report distribution to get */ getReportDistributionFiltersWithHttpInfo(reportDistributionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the details for a report distribution log * * @param reportDistributionLogId Id of the report distribution log to get the details for */ getReportDistributionLogDetailsWithHttpInfo(reportDistributionLogId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of report distribution logs * * @param includeInProgress Option to include in progress distributions. False by default */ getReportDistributionLogsWithHttpInfo(includeInProgress?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all Report Distributions * * @param filter */ getReportDistributionsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit settings for ENERGY STAR submissions * * @param body ENERGY STAR settings */ editEnergyStarSettings(body?: EnergyStarSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the connection status for a Portfolio Manager account and database * * @param pmUserName User name used to log in to Portfolio Manager */ getPMConnectionStatus(pmUserName?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unlink owner from portfolio manager account * * @param deleteData If true, delete EnergyStar metrics and score. False by default */ unlinkOwnerFromPortfolioManager(deleteData?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit settings for ENERGY STAR submissions * * @param body ENERGY STAR settings */ editEnergyStarSettingsWithHttpInfo(body?: EnergyStarSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the connection status for a Portfolio Manager account and database * * @param pmUserName User name used to log in to Portfolio Manager */ getPMConnectionStatusWithHttpInfo(pmUserName?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unlink owner from portfolio manager account * * @param deleteData If true, delete EnergyStar metrics and score. False by default */ unlinkOwnerFromPortfolioManagerWithHttpInfo(deleteData?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Automatically submit billing data to ENERGY STAR By default calendarized bill data for a 13-month period (excludes current and last month) in the \"Ready\" state for all buildings setup to automatically submit to ENERGY STAR will be submitted If 13 months is not preferred, set up the owner's systemdata key called \"EnergyStarAutoSubmitNumOfMonths\" with an integer value representing the preferred number of months For example - Today is 25th Nov 2021 - all calendarized data for Sep 2020 through Sep 2021 will be submitted The buildings submitted will be within the user's topmost place No data prior to the earliest period to submit set up in ENERGY STAR settings will ever be submitted * */ autoSubmitToEnergyStar(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Initiate (create) a submission of place data to ENERGY STAR * * @param body */ createEnergyStarSubmission(body?: EnergyStarSubmissionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the submission status for places by submission period. Places that do not match the filter criteria will not be returned. NOTE: Deleting/voiding bills that have already been submitted will not cause submission status to change from \"submitted\". * Returned submission status: Submitted - submission has been made for this place and submission period and no bills have been created or modified since the last submission No Data - no submission has been made for this place and submission period and current submission period has no billing data Incomplete - no submission has been made for this place and submission period and current billing data is incomplete (some meters may not have data or some days in submission period may not have data) Ready - no submission has been made for this place and submission period and current billing data is complete (every meter has data for every day of this period), or submission has been made but billing data has been added or modified since the last submission * @param submissionBeginPeriod The beginning submission period to select * @param submissionEndPeriod The ending submission period to select; set equal to beginning submission period get one period * @param filter API filter string containing conditions */ getEnergyStarSubmissionStatusList(submissionBeginPeriod: number, submissionEndPeriod: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an ENERGY STAR task with its details * * @param energyStarTaskId */ getEnergyStarTask(energyStarTaskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update ENERGY STAR metrics for the places matching the request criteria. * * @param body Periods and list of place identifiers for which to update metrics */ updateEnergyStarMetrics(body?: EnergyStarPlaceMetricsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Automatically submit billing data to ENERGY STAR By default calendarized bill data for a 13-month period (excludes current and last month) in the \"Ready\" state for all buildings setup to automatically submit to ENERGY STAR will be submitted If 13 months is not preferred, set up the owner's systemdata key called \"EnergyStarAutoSubmitNumOfMonths\" with an integer value representing the preferred number of months For example - Today is 25th Nov 2021 - all calendarized data for Sep 2020 through Sep 2021 will be submitted The buildings submitted will be within the user's topmost place No data prior to the earliest period to submit set up in ENERGY STAR settings will ever be submitted * */ autoSubmitToEnergyStarWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Initiate (create) a submission of place data to ENERGY STAR * * @param body */ createEnergyStarSubmissionWithHttpInfo(body?: EnergyStarSubmissionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the submission status for places by submission period. Places that do not match the filter criteria will not be returned. NOTE: Deleting/voiding bills that have already been submitted will not cause submission status to change from \"submitted\". * Returned submission status: Submitted - submission has been made for this place and submission period and no bills have been created or modified since the last submission No Data - no submission has been made for this place and submission period and current submission period has no billing data Incomplete - no submission has been made for this place and submission period and current billing data is incomplete (some meters may not have data or some days in submission period may not have data) Ready - no submission has been made for this place and submission period and current billing data is complete (every meter has data for every day of this period), or submission has been made but billing data has been added or modified since the last submission * @param submissionBeginPeriod The beginning submission period to select * @param submissionEndPeriod The ending submission period to select; set equal to beginning submission period get one period * @param filter API filter string containing conditions */ getEnergyStarSubmissionStatusListWithHttpInfo(submissionBeginPeriod: number, submissionEndPeriod: number, filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get an ENERGY STAR task with its details * * @param energyStarTaskId */ getEnergyStarTaskWithHttpInfo(energyStarTaskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of ENERGY STAR tasks with their details * * @param filter Filters to apply * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEnergyStarTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Update ENERGY STAR metrics for the places matching the request criteria. * * @param body Periods and list of place identifiers for which to update metrics */ updateEnergyStarMetricsWithHttpInfo(body?: EnergyStarPlaceMetricsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an emissions source * * @param body Data representing the emission source being created */ createEmissionSource(body?: EmissionSourceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create emission sources for existing meters. * * @param body The ids of the meters for which to create emission sources */ createEmissionSourceForMeter(body?: MeterActionCreateEmissionSource, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emission source * * @param body Data representing the emission source being created */ createEmissionSourceWithMultiFactors(body?: EmissionSourceMultiFactorCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emissions source * * @param body Data representing the emission source being created */ createEmissionSourceWithHttpInfo(body?: EmissionSourceCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create emission sources for existing meters. * * @param body The ids of the meters for which to create emission sources */ createEmissionSourceForMeterWithHttpInfo(body?: MeterActionCreateEmissionSource, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an emission source * * @param body Data representing the emission source being created */ createEmissionSourceWithMultiFactorsWithHttpInfo(body?: EmissionSourceMultiFactorCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes an emissions source * * @param emissionSourceId The identifier for the emission source being deleted * @param deleteRecords Should this cascade to delete any records associated with this emissions source */ deleteEmissionSource(emissionSourceId: number, deleteRecords?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an emissions source * * @param emissionSourceId The identifier for the emission source being deleted * @param deleteRecords Should this cascade to delete any records associated with this emissions source */ deleteEmissionSourceWithHttpInfo(emissionSourceId: number, deleteRecords?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits an emissions source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSource(emissionSourceId: number, body?: EmissionSourceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a emissions source * * @param emissionSourceId The id of the emissions source * @param body The list of udf values being edited */ editEmissionSourceCustomFields(emissionSourceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Assigns the specified scope category and factor pairings to the specified emission sources. If one or more of the factors provided cannot be applied to the emission source, that emission source will be skipped. * * @param body */ editEmissionSourceFactorCategoriesBulk(body?: EmissionSourceFactorCategoryBulkUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emission source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithMultiFactors(emissionSourceId: number, body?: EmissionSourceMultiFactorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit meter data in an Emission Source * * @param emissionSourceId The Emission Source identifier * @param body Meter data to assign to the Emission Source */ editMeterLink(emissionSourceId: number, body?: MeterLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param parentCollectionId * @param body */ moveEmissionSources(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Resets the scope category and factor pairings of the specified emission sources to their commodity default. If no default exists for an emission source's commodity, that emission source will be skipped. * * @param body */ resetEmissionSourceFactorCategoriesBulk(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emissions source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithHttpInfo(emissionSourceId: number, body?: EmissionSourceEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a emissions source * * @param emissionSourceId The id of the emissions source * @param body The list of udf values being edited */ editEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Assigns the specified scope category and factor pairings to the specified emission sources. If one or more of the factors provided cannot be applied to the emission source, that emission source will be skipped. * * @param body */ editEmissionSourceFactorCategoriesBulkWithHttpInfo(body?: EmissionSourceFactorCategoryBulkUpdate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an emission source * * @param emissionSourceId The identifier for the emission source being edited * @param body Data representing the emission source being edited */ editEmissionSourceWithMultiFactorsWithHttpInfo(emissionSourceId: number, body?: EmissionSourceMultiFactorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit meter data in an Emission Source * * @param emissionSourceId The Emission Source identifier * @param body Meter data to assign to the Emission Source */ editMeterLinkWithHttpInfo(emissionSourceId: number, body?: MeterLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param parentCollectionId * @param body */ moveEmissionSourcesWithHttpInfo(parentCollectionId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Resets the scope category and factor pairings of the specified emission sources to their commodity default. If no default exists for an emission source's commodity, that emission source will be skipped. * * @param body */ resetEmissionSourceFactorCategoriesBulkWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Download file for a emissions source custom field * * @param emissionSourceId The id of the emissions source * @param udfId The id of the custom field */ downloadEmissionSourceCustomFields(emissionSourceId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves the emissions source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSource(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get custom field values for an emissions source * * @param emissionSourceId The id of the emissions source */ getEmissionSourceCustomFields(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an emission source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithMultiFactors(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSources(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a emissions source custom field * * @param emissionSourceId The id of the emissions source * @param udfId The id of the custom field */ downloadEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the emissions source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get custom field values for an emissions source * * @param emissionSourceId The id of the emissions source */ getEmissionSourceCustomFieldsWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an emission source by ID * * @param emissionSourceId The identifier for the emission source being retrieved */ getEmissionSourceWithMultiFactorsWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all the emissions sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all emission sources * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionSourcesWithMultiFactorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsEnergyManagerModuleViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a VEM chat for the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param body */ createChat(body?: VemChatCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new message in the specified chat and streams the response to the client. Since chat history is persisted, it manages response ID internally. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * This method processes the user's message asynchronously and streams the response directly to the client. The response is sent as plain text with no caching, and the connection is kept alive during the streaming process. * @param chatId The identifier of the chat where the message will be created. * @param body An object containing the details of the message to be created, including its content. */ createMessage(chatId: number, body?: VemChatMessageCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a VEM chat for the user making the request. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * * @param body */ createChatWithHttpInfo(body?: VemChatCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new message in the specified chat and streams the response to the client. Since chat history is persisted, it manages response ID internally. It requires the 'VirtualEnergyManager' feature flag to be enabled for the user. * This method processes the user's message asynchronously and streams the response directly to the client. The response is sent as plain text with no caching, and the connection is kept alive during the streaming process. * @param chatId The identifier of the chat where the message will be created. * @param body An object containing the details of the message to be created, including its content. */ createMessageWithHttpInfo(chatId: number, body?: VemChatMessageCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsExportBillsRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Export all account bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param accountId The account to export all bills * @param body Bill Export Options */ accountBillListExport(accountId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport account bills * * @param accountId The account for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ accountBillListUnexport(accountId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all bills in a list to ap or gl Maximum of 10000 bills can be processed at one time. * * @param listId The list identifier * @param body Bill Export Options */ exportBillList(listId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves text of a standard EnergyCAP bill export file for AP, GL and payment purposes. Maximum of 10000 bills can be processed at one time. Only bills with the following conditions are included in the export file: 1) approved bills (if the approval system is enabled in workflow settings) 2) bill is in a closed batch (if after batch or after batch approval is set in the workflow settings) 3) bill is not held for export 4) bill is not void 5) bill is within the user's topmost setting. 6) bill in not already exported * * @param body */ exportBills(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all meter bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param meterId The meter to export all bills * @param body Bill Export Options */ meterBillListExport(meterId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport meter bills * * @param meterId The meter for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ meterBillListUnexport(meterId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Unexport bill list * * @param listId The list identifier * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ unexportBillList(listId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Marks one or more bills as unexported. * * @param body An array of bill ids to be marked as unexported and export mode */ unexportBills(body?: BillUnexport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Marks one or more bills as unexported. The bills to be unexported are selected based on the guid passed in. The guid is generated when bills are exported via the bill export end point, and the guid is returned in the header of the response in a field named Ec-Guid. * * @param billExportGuid The identifier for the bills to be unexported */ unexportBillsByGuid(billExportGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export all account bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param accountId The account to export all bills * @param body Bill Export Options */ accountBillListExportWithHttpInfo(accountId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport account bills * * @param accountId The account for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ accountBillListUnexportWithHttpInfo(accountId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export all bills in a list to ap or gl Maximum of 10000 bills can be processed at one time. * * @param listId The list identifier * @param body Bill Export Options */ exportBillListWithHttpInfo(listId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves text of a standard EnergyCAP bill export file for AP, GL and payment purposes. Maximum of 10000 bills can be processed at one time. Only bills with the following conditions are included in the export file: 1) approved bills (if the approval system is enabled in workflow settings) 2) bill is in a closed batch (if after batch or after batch approval is set in the workflow settings) 3) bill is not held for export 4) bill is not void 5) bill is within the user's topmost setting. 6) bill in not already exported * * @param body */ exportBillsWithHttpInfo(body?: BillExport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export all meter bills to ap or gl Maximum of 10000 bills can be processed at one time. * * @param meterId The meter to export all bills * @param body Bill Export Options */ meterBillListExportWithHttpInfo(meterId: number, body?: BillExportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport meter bills * * @param meterId The meter for which to unexport all bills * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ meterBillListUnexportWithHttpInfo(meterId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Unexport bill list * * @param listId The list identifier * @param body Value of \"ap\" for A/P unexport, or \"gl\" for GL unexport */ unexportBillListWithHttpInfo(listId: number, body?: BillUnexportOptions, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Marks one or more bills as unexported. * * @param body An array of bill ids to be marked as unexported and export mode */ unexportBillsWithHttpInfo(body?: BillUnexport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Marks one or more bills as unexported. The bills to be unexported are selected based on the guid passed in. The guid is generated when bills are exported via the bill export end point, and the guid is returned in the header of the response in a field named Ec-Guid. * * @param billExportGuid The identifier for the bills to be unexported */ unexportBillsByGuidWithHttpInfo(billExportGuid: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsExportHoldManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Hold/release account bills for export * * @param accountId The account to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ accountBillListExportHold(accountId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update export hold flag for the given billIDs * * @param body export hold action */ billActionExportHold(body?: BillActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release bill list for export * * @param listId The list identifier * @param body Boolean representing exportHold flag */ exportHoldBillList(listId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release meter bills for export * * @param meterId The meter to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ meterBillListExportHold(meterId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Hold/release account bills for export * * @param accountId The account to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ accountBillListExportHoldWithHttpInfo(accountId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update export hold flag for the given billIDs * * @param body export hold action */ billActionExportHoldWithHttpInfo(body?: BillActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Hold/release bill list for export * * @param listId The list identifier * @param body Boolean representing exportHold flag */ exportHoldBillListWithHttpInfo(listId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Hold/release meter bills for export * * @param meterId The meter to set the export hold flag on all bills * @param body Boolean representing exportHold flag */ meterBillListExportHoldWithHttpInfo(meterId: number, body?: ListActionExportHold, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsFacilityProjectsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an Energy Project * * @param body Data representing the Energy project being created */ createEnergyProject(body?: EnergyProjectCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a energy project type * * @param body */ createEnergyProjectType(body?: EnergyProjectTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an Energy Project * * @param body Data representing the Energy project being created */ createEnergyProjectWithHttpInfo(body?: EnergyProjectCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a energy project type * * @param body */ createEnergyProjectTypeWithHttpInfo(body?: EnergyProjectTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsFacilityProjectsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes an Energy Project * * @param projectId The identifier for the energy project being deleted */ deleteEnergyProject(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an Energy Project * * @param projectId The identifier for the energy project being deleted */ deleteEnergyProjectWithHttpInfo(projectId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsFacilityProjectsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits an Energy Project * * @param projectId The identifier for the energy project being edited * @param body */ editEnergyProject(projectId: number, body?: EnergyProjectEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the custom field values on a energy project * * @param energyProjectId The id of the energy project * @param body The list of udf values being edited */ editEnergyProjectCustomFields(energyProjectId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an Energy Project * * @param projectId The identifier for the energy project being edited * @param body */ editEnergyProjectWithHttpInfo(projectId: number, body?: EnergyProjectEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the custom field values on a energy project * * @param energyProjectId The id of the energy project * @param body The list of udf values being edited */ editEnergyProjectCustomFieldsWithHttpInfo(energyProjectId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsFlaggedItemsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit flag data for a specified entity * This API supports a wide variety of Flag-related actions. Below are summaries of expected outcomes for possible combinations of property values. Create Flag(the entity is not yet flagged, therefore there is no \"modified\" info) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | null | null | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | null | **not null** | **not null** | **not null** | **not null** | false | false | Exception, must have a type | | **not null** | null | null | null | null | false | false | Flagged, unresolved, specified type | | **not null** | **not null** | null | null | null | false | false | Flagged, unresolved(ignoring specified status), specified type | | **not null** | null | **not null** | null | null | false | false | Flagged, unresolved, specified type, cost recovery | | **not null** | null | null | **not null**<sup>1</sup> | null | false | false | Flagged, unresolved, specified type <sup>1</sup>If assignees not empty, assigned | | **not null** | null | null | null | **not null** | false | false | Flagged, unresolved, specified type, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment, held from export <sup>2</sup>If assignees not empty, assigned, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>3</sup> | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment <sup>2</sup>If assignees not empty, assigned, comment <sup>3</sup>No action; will not release a newly flagged bill for export | Edit Unresolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Flag type updated | | null | **resolved** | null | null | null | false | false | Resolved | | null | **resolved** | null | null | null | false | **true** | Resolved, released for export | | null | null | **not null** | null | null | false | false | Updated, cost recovery | | null | null | null | **not null** | null | false | false | Assigned | | null | null | null | null | **not null** | false | false | Updated, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Updated, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | Edit Resolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | -------------------------- | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Updated, specified type | | null | **non-null** | null | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | **not null** | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | **not null** | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | null | **not null** | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, released from export <sup>2</sup>Assigned, comment | * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param body The flag edit request */ editFlag(entityType: string, entityId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param flagResolveComment Optional comment that will be recorded in the flag event when resolving the issue * @param body The flag issue edit request */ editFlagIssues(entityType: string, entityId: number, flagResolveComment?: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates flags for a given list of entities. If the entity does not currently have a flag, one will be created. * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param body The changes to be made to the flags */ flagAction(entityType: string, body?: FlagListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create and/or update flags for all bills in a list * * @param listId Bill list containing a list of bills that will have flags created or updated * @param body DTO containing the new state of the flags on each bill in the list */ flagBillListAction(listId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates flag issues for a given list of flag issue ids * * @param body The changes to be made to the flag issues */ flagIssueAction(body?: FlagIssueListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update flag issuess for all issues in a list * * @param listId Flag Issue list containing a list of flag issues to be updated * @param body DTO containing the new state of the flag Issue on each flag issue in the list */ flagIssueBillListAction(listId: number, body?: FlagIssueEditAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param rerunResolvedIssues When true, resolved issues can be re-flagged. When false, resolved issues are not re-flagged. Defaults to true. * @param body The list of bills to audit */ rerunAudits(rerunResolvedIssues?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param body The list of bills to audit */ rerunAudits_1(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Enable or disable Accounts from audits * * @param body */ setAccountAuditExclusion(body?: AccountAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Enable or disable all accounts assigned to a vendor from audits * * @param vendorId The identifier for the vendor to act upon * @param body */ setVendorAccountsAuditExclusion(vendorId: number, body?: VendorAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update audit settings for an account. Every audit must be included but supplying null for its settings will remove them. * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param accountId The account identifier * @param body The new state of the audit settings */ updateAccountAuditSettings(accountId: number, body?: AccountAuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit flag data for a specified entity * This API supports a wide variety of Flag-related actions. Below are summaries of expected outcomes for possible combinations of property values. Create Flag(the entity is not yet flagged, therefore there is no \"modified\" info) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | null | null | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | null | **not null** | **not null** | **not null** | **not null** | false | false | Exception, must have a type | | **not null** | null | null | null | null | false | false | Flagged, unresolved, specified type | | **not null** | **not null** | null | null | null | false | false | Flagged, unresolved(ignoring specified status), specified type | | **not null** | null | **not null** | null | null | false | false | Flagged, unresolved, specified type, cost recovery | | **not null** | null | null | **not null**<sup>1</sup> | null | false | false | Flagged, unresolved, specified type <sup>1</sup>If assignees not empty, assigned | | **not null** | null | null | null | **not null** | false | false | Flagged, unresolved, specified type, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment, held from export <sup>2</sup>If assignees not empty, assigned, comment | | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>3</sup> | <sup>1</sup>Flagged, unresolved (ignoring specified status), specified type, cost recovery, comment <sup>2</sup>If assignees not empty, assigned, comment <sup>3</sup>No action; will not release a newly flagged bill for export | Edit Unresolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Flag type updated | | null | **resolved** | null | null | null | false | false | Resolved | | null | **resolved** | null | null | null | false | **true** | Resolved, released for export | | null | null | **not null** | null | null | false | false | Updated, cost recovery | | null | null | null | **not null** | null | false | false | Assigned | | null | null | null | null | **not null** | false | false | Updated, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Updated, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | Edit Resolved Flag (the entity is already flagged) | FlagTypeId | FlagStatusId | CostRecovery | Assignees | Comment | HoldFromExport | ReleaseExportHold | Action | | ------------------------ | -------------------------- | ------------------------ | ------------------------ | ------------------------ | -------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | null | null | null | null | **non-null** | **true** | **true** | Exception, cannot set both HoldFromExport and ReleaseExportHold at once | | null | null | null | null | null | **non-null** | **non-null** | Exception, must have at least one set | | null | null | null | null | null | false | false | Exception, must provided a non-null value for HoldFromExport or ReleaseExportHold | | **system or user type** | null | null | null | null | false | false | Updated, specified type | | null | **non-null** | null | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | **not null** | null | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | **not null** | null | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | null | null | null | null | **not null** | false | false | Exception; must provide flag type (cannot change flag status of a resolved flag; instead must \"re-flag\" it) | | **not null**<sup>1</sup> | **not null**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | false | <sup>1</sup>Updated, specified type, cost recovery, comment <sup>2</sup>Assigned, comment <sup>3</sup>Resolved, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, no export hold action <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **unresolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | **true**<sup>1</sup> | false | <sup>1</sup>Flagged, specified type, cost recovery, comment, held from export <sup>2</sup>Assigned, comment | | **not null**<sup>1</sup> | **resolved**<sup>3</sup> | **not null**<sup>1</sup> | **not null**<sup>2</sup> | **not null**<sup>1</sup> | false | **true**<sup>1</sup> | <sup>1</sup>Resolved, specified type, cost recovery, comment, released from export <sup>2</sup>Assigned, comment | * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param body The flag edit request */ editFlagWithHttpInfo(entityType: string, entityId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity * @param flagResolveComment Optional comment that will be recorded in the flag event when resolving the issue * @param body The flag issue edit request */ editFlagIssuesWithHttpInfo(entityType: string, entityId: number, flagResolveComment?: string, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates flags for a given list of entities. If the entity does not currently have a flag, one will be created. * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param body The changes to be made to the flags */ flagActionWithHttpInfo(entityType: string, body?: FlagListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create and/or update flags for all bills in a list * * @param listId Bill list containing a list of bills that will have flags created or updated * @param body DTO containing the new state of the flags on each bill in the list */ flagBillListActionWithHttpInfo(listId: number, body?: FlagEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates flag issues for a given list of flag issue ids * * @param body The changes to be made to the flag issues */ flagIssueActionWithHttpInfo(body?: FlagIssueListAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update flag issuess for all issues in a list * * @param listId Flag Issue list containing a list of flag issues to be updated * @param body DTO containing the new state of the flag Issue on each flag issue in the list */ flagIssueBillListActionWithHttpInfo(listId: number, body?: FlagIssueEditAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param rerunResolvedIssues When true, resolved issues can be re-flagged. When false, resolved issues are not re-flagged. Defaults to true. * @param body The list of bills to audit */ rerunAuditsWithHttpInfo(rerunResolvedIssues?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Re-run audits on a set of bills Only a subset of audits are run. The audits that run are the ones that are affected by bill history Also the owner audit setting and any account level audit setting overrides will be applied Resolved flag issues and flags could get re-flagged because of this action If the audit setting is set to Flag and Hold, the bill will get Held from export * * @param body The list of bills to audit */ rerunAudits_1WithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Enable or disable Accounts from audits * * @param body */ setAccountAuditExclusionWithHttpInfo(body?: AccountAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Enable or disable all accounts assigned to a vendor from audits * * @param vendorId The identifier for the vendor to act upon * @param body */ setVendorAccountsAuditExclusionWithHttpInfo(vendorId: number, body?: VendorAuditEnable, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update audit settings for an account. Every audit must be included but supplying null for its settings will remove them. * __Setting Status Descriptions:__ | Setting Status | Description | | -------------- | ----------- | | Check | If this audit fails affected bills are flagged | | Hold | If this audit fails affected bills are flagged and held from export | | Skip | This audit is skipped | * @param accountId The account identifier * @param body The new state of the audit settings */ updateAccountAuditSettingsWithHttpInfo(accountId: number, body?: AccountAuditSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsFlaggedItemsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccount(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeter(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a flag type * * @param body Contains the name of the flag type being created */ createFlagType(body?: FlagTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a flag type. System flag types cannot be deleted. * * @param flagTypeId The identifier for the flag type being deleted */ deleteFlagType(flagTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given account and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param accountId */ flagInAccountHierarchy(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given cost center and it's child cost centers, accounts, and bills for the existence of a flag For bill flags, void bills are excluded * * @param costCenterId */ flagInCostCenterHierarchy(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given meter and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param meterId */ flagInMeterHierarchy(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Checks a given place and it's child places, meters, and bills for the existence of a flag For bill flags, void bills are excluded * * @param placeId */ flagInPlaceHierarchy(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets all account audit setting overrides * * @param accountId */ getAccountAuditSettings(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get flag data for a specified entity * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlag(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get flag issues for a specified entity * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagIssues(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available flag types * */ getFlagTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Account for all the accounts under the given cost center * * @param costCenterId Parent cost center identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByAccountWithHttpInfo(costCenterId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns a tabular flag summary by Meter for all the meters under the given place * * @param placeId Parent place identifier * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ billFlagSummaryByMeterWithHttpInfo(placeId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a flag type * * @param body Contains the name of the flag type being created */ createFlagTypeWithHttpInfo(body?: FlagTypeCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a flag type. System flag types cannot be deleted. * * @param flagTypeId The identifier for the flag type being deleted */ deleteFlagTypeWithHttpInfo(flagTypeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given account and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param accountId */ flagInAccountHierarchyWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given cost center and it's child cost centers, accounts, and bills for the existence of a flag For bill flags, void bills are excluded * * @param costCenterId */ flagInCostCenterHierarchyWithHttpInfo(costCenterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given meter and it's bills for the existence of a flag For bill flags, void bills are excluded * * @param meterId */ flagInMeterHierarchyWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Checks a given place and it's child places, meters, and bills for the existence of a flag For bill flags, void bills are excluded * * @param placeId */ flagInPlaceHierarchyWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets all account audit setting overrides * * @param accountId */ getAccountAuditSettingsWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get flag data for a specified entity * * @param entityType The type of entity the flag is being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagWithHttpInfo(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get flag issues for a specified entity * * @param entityType The type of entity the flag issues are being request for. Supported values are: \"Bill\" * @param entityId The identifier of the entity */ getFlagIssuesWithHttpInfo(entityType: string, entityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all available flag types * */ getFlagTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit the average unit cost \"acceptable range\" values for cost avoidance for one or more commodities Cost Avoidance Savings will be re-calculated for all bills for meters having the affected commodities * * @param body Data representing one or more average unit cost ranges to edit */ editAucRanges(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the average unit cost \"acceptable range\" values for cost avoidance for one or more commodities Cost Avoidance Savings will be re-calculated for all bills for meters having the affected commodities * * @param body Data representing one or more average unit cost ranges to edit */ editAucRangesWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get the average unit cost \"acceptable range\" values for cost avoidance for each commodity * */ getAucRanges(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Count the number of meters that match the filter conditions for cost avoidance bulk actions * * @param onlyMetersInCAP Whether or not to only include meters in the count which are already participating in cost avoidance * @param body The filters used when counting the meters */ getCostAvoidanceMeterCount(onlyMetersInCAP?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the average unit cost \"acceptable range\" values for cost avoidance for each commodity * */ getAucRangesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Count the number of meters that match the filter conditions for cost avoidance bulk actions * * @param onlyMetersInCAP Whether or not to only include meters in the count which are already participating in cost avoidance * @param body The filters used when counting the meters */ getCostAvoidanceMeterCountWithHttpInfo(onlyMetersInCAP?: boolean, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsGroupsAndBenchmarksModuleViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Gets a list of meter groups * * @param filter */ getAllMeterGroups(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place groups * * @param filter */ getAllPlaceGroups(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter categories * */ getMeterCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a meter group category * * @param categoryId The identifier for the meter group category being retrieved */ getMeterCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a meter group * * @param meterGroupId */ getMeterGroup(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of meter group members * * @param groupId * @param alwaysLimitByTopmost */ getMeterGroupMembers(groupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves cost, use, unit cost or demand per day ranking data by meter group. * Specify values for any query parameters whose database values are to be overridden. **PLEASE NOTE: As shown in the table below, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | -------- | ---------------------------------------- | | cost | MeterGroupDigestRankingResponseDTO | | use | MeterGroupDigestRankingResponseDTO | | unitCost | MeterGroupDigestRankingResponseDTO | | demand | MeterGroupDigestDemandRankingResponseDTO | * @param groupId The meter group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - cost, use, unitcost, demand * @param billingPeriodOption The billing period option - last12periods, lastyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getMeterGroupRanking(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of place categories * */ getPlaceCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a Place Group Category * * @param categoryId The identifier for the place group category being retrieved */ getPlaceCategory(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a place group * * @param placeGroupId */ getPlaceGroup(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of place group members * * @param placeGroupId * @param alwaysLimitByTopmost */ getPlaceGroupMembers(placeGroupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves ranking data by place group. * Depending on the \"chart\" parameter retrieved ranking data could be cost, use, or demand per area, cost or use per day, heating sensitivity or cooling sensitivity Specify values for any query parameters whose database values are to be overridden. For the heating sensitivity and cooling sensitivity charts we sort by weather sensitivity (slope) and exclude non-weather meters **PLEASE NOTE: As shown in the table above, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | ------------------ | -------------------------------------------- | | areaCost | PlaceGroupDigestAreaRankingResponseDTO | | areaUse | PlaceGroupDigestAreaRankingResponseDTO | | cost | PlaceGroupDigestRankingResponseDTO | | use | PlaceGroupDigestRankingResponseDTO | | areaDemand | PlaceGroupDigestAreaDemandRankingResponseDTO | | coolingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | heatingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | benchmark1Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark1Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | * @param groupId The place group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - areacost, areause, areademand, cost, use, heatingsensitivity, coolingsensitivity, benchmark1use, benchmark1cost, benchmark2use, benchmark2cost, benchmark3use, benchmark3cost * @param billingPeriodOption The billing period option - last12periods, currentyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getPlaceGroupRanking(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of filters that can be used to create Meter Groups * */ getUserDefinedAutoMeterGroupFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of filters that can be used to create Place Groups * */ getUserDefinedAutoPlaceGroupFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter groups * * @param filter */ getAllMeterGroupsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of place groups * * @param filter */ getAllPlaceGroupsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of meter categories * */ getMeterCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieve a meter group category * * @param categoryId The identifier for the meter group category being retrieved */ getMeterCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a meter group * * @param meterGroupId */ getMeterGroupWithHttpInfo(meterGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of meter group members * * @param groupId * @param alwaysLimitByTopmost */ getMeterGroupMembersWithHttpInfo(groupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves cost, use, unit cost or demand per day ranking data by meter group. * Specify values for any query parameters whose database values are to be overridden. **PLEASE NOTE: As shown in the table below, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | -------- | ---------------------------------------- | | cost | MeterGroupDigestRankingResponseDTO | | use | MeterGroupDigestRankingResponseDTO | | unitCost | MeterGroupDigestRankingResponseDTO | | demand | MeterGroupDigestDemandRankingResponseDTO | * @param groupId The meter group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - cost, use, unitcost, demand * @param billingPeriodOption The billing period option - last12periods, lastyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getMeterGroupRankingWithHttpInfo(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place categories * */ getPlaceCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieve a Place Group Category * * @param categoryId The identifier for the place group category being retrieved */ getPlaceCategoryWithHttpInfo(categoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a place group * * @param placeGroupId */ getPlaceGroupWithHttpInfo(placeGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of place group members * * @param placeGroupId * @param alwaysLimitByTopmost */ getPlaceGroupMembersWithHttpInfo(placeGroupId: number, alwaysLimitByTopmost?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves ranking data by place group. * Depending on the \"chart\" parameter retrieved ranking data could be cost, use, or demand per area, cost or use per day, heating sensitivity or cooling sensitivity Specify values for any query parameters whose database values are to be overridden. For the heating sensitivity and cooling sensitivity charts we sort by weather sensitivity (slope) and exclude non-weather meters **PLEASE NOTE: As shown in the table above, this API endpoint returns different response types based on the \"chart\" value. Despite what you see below regarding HTTP status codes for each response type, _all_ of these response types will return 200 OK.** | Chart | Response Type | | ------------------ | -------------------------------------------- | | areaCost | PlaceGroupDigestAreaRankingResponseDTO | | areaUse | PlaceGroupDigestAreaRankingResponseDTO | | cost | PlaceGroupDigestRankingResponseDTO | | use | PlaceGroupDigestRankingResponseDTO | | areaDemand | PlaceGroupDigestAreaDemandRankingResponseDTO | | coolingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | heatingSensitivity | PlaceGroupDigestWeatherRankingResponseDTO | | benchmark1Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Use | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark1Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark2Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | | benchmark3Cost | PlaceGroupDigestBenchmarkRankingResponseDTO | * @param groupId The place group to retrieve data for * @param dataView The desired data view - actual, calendarized, normalized * @param chart The desired chart - areacost, areause, areademand, cost, use, heatingsensitivity, coolingsensitivity, benchmark1use, benchmark1cost, benchmark2use, benchmark2cost, benchmark3use, benchmark3cost * @param billingPeriodOption The billing period option - last12periods, currentyear, lastfiscalyear, custom (optional) * @param startPeriod The custom start period (optional) * @param endPeriod The custom end period (optional) * @param commodityId Id of commodity to filter by (optional) * @param commodityCategoryId Id of commodity category to filter by (optional) * @param highToLowRanking Ranking from high to low, or low to high? (optional) * @param showExcludedMembers Show group members excluded from the group? (optional) * @param showZeroAverages Show group members whose ranking averages are zero? (optional) */ getPlaceGroupRankingWithHttpInfo(groupId: number, dataView: string, chart: string, billingPeriodOption?: string, startPeriod?: number, endPeriod?: number, commodityId?: number, commodityCategoryId?: number, highToLowRanking?: boolean, showExcludedMembers?: boolean, showZeroAverages?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of filters that can be used to create Meter Groups * */ getUserDefinedAutoMeterGroupFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of filters that can be used to create Place Groups * */ getUserDefinedAutoPlaceGroupFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsIntervalDataManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates an interval data import profile * * @param body The details about the profile being created */ createReadingImportProfile(body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates new readings * * @param body Data representing the readings being imported */ createReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a reading import profile * * @param profileId The identifier for the profile being deleted */ deleteReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes one or more sets of meter readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body The channel id, begin date and time and end date and time of the set of meter readings to be deleted */ deleteReadings(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a single interval data reading by its ID * * @param readingId Unique ID of the reading to delete */ deleteSingleReading(readingId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an interval data import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editReadingImportProfile(profileId: number, body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a single interval data reading. Duplicate timestamps are not allowed for readings on a given channel. If the reading being edited has the same timestamp as another reading on the same channel, this end point throws an error * * @param readingId Unique ID of the reading to edit * @param body Updated reading properties */ editSingleReading(readingId: number, body?: Reading, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns one reading import profile * * @param profileId */ getReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Returns all Reading Import profiles * */ getReadingImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of a channel reading (\"interval\") data import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to export and the profile that defines the structure. */ readingImport(body?: ReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an interval data import profile * * @param body The details about the profile being created */ createReadingImportProfileWithHttpInfo(body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates new readings * * @param body Data representing the readings being imported */ createReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a reading import profile * * @param profileId The identifier for the profile being deleted */ deleteReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes one or more sets of meter readings. Each set of meter readings to be deleted is on one channel and covers a time range signified by a begin and end date and time. The time range includes all readings greater than the begin time and less than or equal to the end date and time. To delete only one reading, set the begin and end date and time to the same value. * * @param body The channel id, begin date and time and end date and time of the set of meter readings to be deleted */ deleteReadingsWithHttpInfo(body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a single interval data reading by its ID * * @param readingId Unique ID of the reading to delete */ deleteSingleReadingWithHttpInfo(readingId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an interval data import profile * * @param profileId The identifier for the profile being edited * @param body The details about the profile being edited */ editReadingImportProfileWithHttpInfo(profileId: number, body?: ReadingImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a single interval data reading. Duplicate timestamps are not allowed for readings on a given channel. If the reading being edited has the same timestamp as another reading on the same channel, this end point throws an error * * @param readingId Unique ID of the reading to edit * @param body Updated reading properties */ editSingleReadingWithHttpInfo(readingId: number, body?: Reading, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns one reading import profile * * @param profileId */ getReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Returns all Reading Import profiles * */ getReadingImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * This endpoint allows the import of a channel reading (\"interval\") data import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to export and the profile that defines the structure. */ readingImportWithHttpInfo(body?: ReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsLicenseFeatureIntervalDataAnalysisViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves interval data for a specific widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for */ getIntervalData(specificWidgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves interval data for a specific widget NOTE: Does not support global dashboard filtering with Topmost Place, Place Group API filters. * * @param specificWidgetId Specific widget identifier to get the data for */ getIntervalDataWithHttpInfo(specificWidgetId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsManuallyAdjustSavingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates or removes manual adjustments to savings for a provided meter and bill * * @param meterId The meter for which the manual adjustment is being made * @param billId The bill for which the manual adjustment is being made * @param body */ manualAdjustment(meterId: number, billId: number, body?: ManualAdjustmentRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates or removes manual adjustments to savings for a provided meter and bill * * @param meterId The meter for which the manual adjustment is being made * @param billId The bill for which the manual adjustment is being made * @param body */ manualAdjustmentWithHttpInfo(meterId: number, billId: number, body?: ManualAdjustmentRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Mass update certain cost avoidance settings for meters that match the filter conditions Baseline and Savings will be reprocessed for affected meters * * @param body Filters and new cost avoidance setting values */ bulkEditMeterCostAvoidanceSettings(body?: BulkMeterCostAvoidanceSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Mass update certain cost avoidance settings for meters that match the filter conditions Baseline and Savings will be reprocessed for affected meters * * @param body Filters and new cost avoidance setting values */ bulkEditMeterCostAvoidanceSettingsWithHttpInfo(body?: BulkMeterCostAvoidanceSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Executes the baseline and cost avoidance processors with provided baseline and cost avoidance settings for the provided meter. Results are not saved unless the \"save\" flag is set to true. If \"save\" is true, MeterSavingsSettings-Manage permission is also required * * @param meterId ID of the meter for which baseline will be reprocessed * @param save If true, the baseline results will be saved to the database * @param body Provided baseline and avoidance settings */ generateBaseline(meterId: number, save?: boolean, body?: BaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Executes the baseline processor with stored baseline settings for the provided meter * * @param meterId ID of the meter for which baseline data will be returned */ generateBaselineGet(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Executes the baseline and cost avoidance processors with provided baseline and cost avoidance settings for the provided meter. Results are not saved unless the \"save\" flag is set to true. If \"save\" is true, MeterSavingsSettings-Manage permission is also required * * @param meterId ID of the meter for which baseline will be reprocessed * @param save If true, the baseline results will be saved to the database * @param body Provided baseline and avoidance settings */ generateBaselineWithHttpInfo(meterId: number, save?: boolean, body?: BaselineProcessorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Executes the baseline processor with stored baseline settings for the provided meter * * @param meterId ID of the meter for which baseline data will be returned */ generateBaselineGetWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMetersCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a data point * * @param body Data representing the data point being created */ createDataPoint(body?: DataPointCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA channel * * @param body Data representing the ESA channel being created */ createEsaChannel(body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA reading import profile * * @param body Object containing settings for the new profile */ createEsaReadingImportProfile(body?: EsaReadingImportProfileCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a meter * * @param body Data representing the meter being created */ createMeter(body?: MeterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a new route and assigns a group of meters to it * * @param body Data representing the route being created */ createRoute(body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create meters on a particular place * * @param placeId The id of the place * @param body The meters to create on the place */ createUtilityPlatformMetersByPlace(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of an ESA reading import file. The file should be a base64-encoded file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEsaReadingWithProfile(body?: EsaReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new aggregate meter, update an existing version, create a new version If AggregateMeterId is null: a new aggregate meter and version is always created If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error If AggregateMeterId exists: we will always update the Aggregate's MeterInfo and AccountInfo If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated * * @param placeId The id of the place to insert the aggregate meter * @param body The release request details */ upsertAggregateMeter(placeId: number, body?: UpsertAggregateMeterRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a data point * * @param body Data representing the data point being created */ createDataPointWithHttpInfo(body?: DataPointCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA channel * * @param body Data representing the ESA channel being created */ createEsaChannelWithHttpInfo(body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA reading import profile * * @param body Object containing settings for the new profile */ createEsaReadingImportProfileWithHttpInfo(body?: EsaReadingImportProfileCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a meter * * @param body Data representing the meter being created */ createMeterWithHttpInfo(body?: MeterCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a new route and assigns a group of meters to it * * @param body Data representing the route being created */ createRouteWithHttpInfo(body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create meters on a particular place * * @param placeId The id of the place * @param body The meters to create on the place */ createUtilityPlatformMetersByPlaceWithHttpInfo(placeId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * This endpoint allows the import of an ESA reading import file. The file should be a base64-encoded file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEsaReadingWithProfileWithHttpInfo(body?: EsaReadingImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Create a new aggregate meter, update an existing version, create a new version If AggregateMeterId is null: a new aggregate meter and version is always created If AggregateMeterId is not null: it must exist and only associated with 1 account otherwise error If AggregateMeterId exists: we will always update the Aggregate's MeterInfo and AccountInfo If AggregateMeterId exists and no version exists on the same account and meter with the specified billing period: a new version is created If AggregateMeterId exists and a version exists on the same account and meter with the specified billing period: the version is updated * * @param placeId The id of the place to insert the aggregate meter * @param body The release request details */ upsertAggregateMeterWithHttpInfo(placeId: number, body?: UpsertAggregateMeterRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMetersDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a data point * * @param dataPointId The data point identifier */ deleteDataPoint(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA channel * * @param esaChannelId The ESA channel identifier */ deleteEsaChannel(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an ESA reading import profile * * @param profileId The identifier of the profile to delete */ deleteEsaReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a meter * * @param meterId The identifier for the meter being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteMeter(meterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a route * * @param id The identifier for the route being deleted */ deleteRoute(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a data point * * @param dataPointId The data point identifier */ deleteDataPointWithHttpInfo(dataPointId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an ESA channel * * @param esaChannelId The ESA channel identifier */ deleteEsaChannelWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an ESA reading import profile * * @param profileId The identifier of the profile to delete */ deleteEsaReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a meter * * @param meterId The identifier for the meter being deleted * @param deleteBills Should this cascade to delete any bills associated with this meter */ deleteMeterWithHttpInfo(meterId: number, deleteBills?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a route * * @param id The identifier for the route being deleted */ deleteRouteWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMetersEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Adds a meter to a route * * @param routeId The identifier for the route to add the meters to * @param body Object representing meter to add to the route */ addMeter(routeId: number, body?: RouteMeter, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Turn a Meter into an ESA Calculated Meter This is only possible if the Meter has NO EsaChannels. A Primary Value ESAChannel will be created, according to the EsaChannelCreateDTO. It must be a Formula Channel. The formula is only permitted to reference other ESA Meters. The referenced Meters' Primary Value Channels will be used in the formula calculation. * * @param meterId The identifier for the meter being converted to an ESA Calculated Meter * @param body */ convertToEsaCalculatedMeter(meterId: number, body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to add the version to * @param body */ createChannelVersion(meterId: number, channelId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel version being created */ createEsaChannelVersion(esaChannelId: number, body?: EsaChannelVersionCreateWithBeginDate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates and assigns a channel to a meter * * @param meterId Id of the meter to link the channel to * @param body Data representing the channel being created */ createMeterChannel(meterId: number, body?: ChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a channel version There must always be one version on a channel If you try and delete the only version on a channel an exception will occur * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to delete */ deleteChannelVersion(meterId: number, channelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a meter's channel All readings linked to this channel will also be deleted. A channel that is part of a distribution cannot be deleted. * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to delete */ deleteMeterChannel(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update a channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to update * @param body */ editChannelVersion(meterId: number, channelId: number, versionId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a data point * * @param dataPointId The data point identifier * @param body Data representing the data point being edited */ editDataPoint(dataPointId: number, body?: DataPointEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit emission source data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Emission Source data to assign to the meter */ editEmissionSourceLink(meterId: number, body?: EmissionSourceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel being edited */ editEsaChannel(esaChannelId: number, body?: EsaChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier * @param body Data representing the ESA channel version being edited */ editEsaChannelVersion(esaChannelId: number, versionId: number, body?: EsaChannelVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an ESA reading import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings for the profile */ editEsaReadingImportProfile(profileId: number, body?: EsaReadingImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Updates a meter's channel If a channel version exists and is not passed into the request body it will continue to exist and no data will be changed. To delete a specific channel version call DELETE meter/{meterId}/channel/{channelId}/version/{versionId} * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to update * @param body */ editMeterChannel(meterId: number, channelId: number, body?: ChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param meterId * @param body */ editMeterSerialNumberVersion(meterId: number, body?: MeterSerialNumberHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular meter * * @param meterId The identifier for the meter * @param body Data representing the meter user defined fields / custom fields being edited */ editMeterUDFs(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a meter - unlike the original v3 EditMeter API, the meter use unit will be removed if it is null * * @param meterId The meter identifier for the meter being edited * @param body Data representing the meter being edited */ editMeterWithUnits(meterId: number, body?: MeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a route * * @param id The identifier for the route being edited * @param body Data representing the route being edited */ editRoute(id: number, body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit SmartAnalytics (Wattics) data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Identifier for the SmartAnaltyics data point to assign to the meter */ editWatticsDataPointLink(meterId: number, body?: WatticsDataPointRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits the data point sentinel configuration * * @param dataPointId * @param body The data point identifier */ enableSentinel(dataPointId: number, body?: DataPointSentinel, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get data access release details * * @param dataAccessReleaseId The id of the data access release */ getDataAccessReleaseDetails(dataAccessReleaseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Move list of meters to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of meterIds to move under the parentPlaceId */ moveMeter(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Fires a custom meter action. Custom meter actions are setup as webhooks * * @param body */ processMeterCustomAction(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Removes a meter from a route * * @param routeId The identifier for the route the meter is being remove from * @param meterId The identifier for the meter being removed */ removeMeter(routeId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMeters(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddresses(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Email a data access release request * * @param meterId The meter that the release is for * @param body The release request details */ sendDataAccessReleaseRequestEmail(meterId: number, body?: SendDataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Adds a meter to a route * * @param routeId The identifier for the route to add the meters to * @param body Object representing meter to add to the route */ addMeterWithHttpInfo(routeId: number, body?: RouteMeter, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Turn a Meter into an ESA Calculated Meter This is only possible if the Meter has NO EsaChannels. A Primary Value ESAChannel will be created, according to the EsaChannelCreateDTO. It must be a Formula Channel. The formula is only permitted to reference other ESA Meters. The referenced Meters' Primary Value Channels will be used in the formula calculation. * * @param meterId The identifier for the meter being converted to an ESA Calculated Meter * @param body */ convertToEsaCalculatedMeterWithHttpInfo(meterId: number, body?: EsaChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to add the version to * @param body */ createChannelVersionWithHttpInfo(meterId: number, channelId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel version being created */ createEsaChannelVersionWithHttpInfo(esaChannelId: number, body?: EsaChannelVersionCreateWithBeginDate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates and assigns a channel to a meter * * @param meterId Id of the meter to link the channel to * @param body Data representing the channel being created */ createMeterChannelWithHttpInfo(meterId: number, body?: ChannelCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a channel version There must always be one version on a channel If you try and delete the only version on a channel an exception will occur * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to delete */ deleteChannelVersionWithHttpInfo(meterId: number, channelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a meter's channel All readings linked to this channel will also be deleted. A channel that is part of a distribution cannot be deleted. * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to delete */ deleteMeterChannelWithHttpInfo(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update a channel version * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel the version is linked to * @param versionId Id of the channel version to update * @param body */ editChannelVersionWithHttpInfo(meterId: number, channelId: number, versionId: number, body?: ChannelVersionWithBeginDateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a data point * * @param dataPointId The data point identifier * @param body Data representing the data point being edited */ editDataPointWithHttpInfo(dataPointId: number, body?: DataPointEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit emission source data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Emission Source data to assign to the meter */ editEmissionSourceLinkWithHttpInfo(meterId: number, body?: EmissionSourceLinkRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA channel * * @param esaChannelId The ESA channel identifier * @param body Data representing the ESA channel being edited */ editEsaChannelWithHttpInfo(esaChannelId: number, body?: EsaChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier * @param body Data representing the ESA channel version being edited */ editEsaChannelVersionWithHttpInfo(esaChannelId: number, versionId: number, body?: EsaChannelVersionEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an ESA reading import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings for the profile */ editEsaReadingImportProfileWithHttpInfo(profileId: number, body?: EsaReadingImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates a meter's channel If a channel version exists and is not passed into the request body it will continue to exist and no data will be changed. To delete a specific channel version call DELETE meter/{meterId}/channel/{channelId}/version/{versionId} * * @param meterId Id of the meter the channel is linked to * @param channelId Id of the channel to update * @param body */ editMeterChannelWithHttpInfo(meterId: number, channelId: number, body?: ChannelEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param meterId * @param body */ editMeterSerialNumberVersionWithHttpInfo(meterId: number, body?: MeterSerialNumberHistoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular meter * * @param meterId The identifier for the meter * @param body Data representing the meter user defined fields / custom fields being edited */ editMeterUDFsWithHttpInfo(meterId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edits a meter - unlike the original v3 EditMeter API, the meter use unit will be removed if it is null * * @param meterId The meter identifier for the meter being edited * @param body Data representing the meter being edited */ editMeterWithUnitsWithHttpInfo(meterId: number, body?: MeterEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a route * * @param id The identifier for the route being edited * @param body Data representing the route being edited */ editRouteWithHttpInfo(id: number, body?: RouteRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit SmartAnalytics (Wattics) data on a meter * * @param meterId The meter identifier for the meter to edit * @param body Identifier for the SmartAnaltyics data point to assign to the meter */ editWatticsDataPointLinkWithHttpInfo(meterId: number, body?: WatticsDataPointRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits the data point sentinel configuration * * @param dataPointId * @param body The data point identifier */ enableSentinelWithHttpInfo(dataPointId: number, body?: DataPointSentinel, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get data access release details * * @param dataAccessReleaseId The id of the data access release */ getDataAccessReleaseDetailsWithHttpInfo(dataAccessReleaseId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Move list of meters to be under parentPlaceId * * @param parentPlaceId The identifier for the new parent place * @param body List of meterIds to move under the parentPlaceId */ moveMeterWithHttpInfo(parentPlaceId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Fires a custom meter action. Custom meter actions are setup as webhooks * * @param body */ processMeterCustomActionWithHttpInfo(body?: WebhookCustomAction, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Removes a meter from a route * * @param routeId The identifier for the route the meter is being remove from * @param meterId The identifier for the meter being removed */ removeMeterWithHttpInfo(routeId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Search utility platform meters * * @param pageSize The number of elements to return in a page * @param pageNumber The current page number * @param body The meter search criteria */ searchUtilityPlatformMetersWithHttpInfo(pageSize?: number, pageNumber?: number, body?: MeterSearchRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Search service addresses * * @param address The address fragment to search for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ searchUtilityPlatformServiceAddressesWithHttpInfo(address?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Email a data access release request * * @param meterId The meter that the release is for * @param body The release request details */ sendDataAccessReleaseRequestEmailWithHttpInfo(meterId: number, body?: SendDataAccessReleaseRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMetersViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Download file for a channel version custom field * * @param meterId * @param channelId * @param versionId * @param udfId */ downloadChannelVersionCustomFieldFile(meterId: number, channelId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a meter custom field * * @param meterId * @param udfId */ downloadMeterCustomFieldFile(meterId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated bill account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getAccountLineItems(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated cost details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillCost(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated demand details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDemand(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * All details related to calculated bill setup including use, cost, meter line items, and account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDetails(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get calculated use details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillUse(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of calculated bill versions on this account and meter relationship * * @param accountId ID of the account to get all assigned calculated bill versions * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillVersionHistory(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions on a meter * * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBills(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calendarized Use vs Weather data * * @param meterId The meter identifier */ getCalendarizedUseVsWeatherData(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPoints(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA channel * * @param esaChannelId The ESA channel identifier */ getEsaChannel(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier */ getEsaChannelVersion(esaChannelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all ESA channel version for a specified ESA channel * * @param esaChannelId */ getEsaChannelVersions(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannels(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets an ESA reading import profile * * @param profileId */ getEsaReadingImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all ESA reading import profiles * */ getEsaReadingImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the ghg meter factors * * @param meterId The meter identifier for ghg factors are being retrieved */ getGHGMeterFactors(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one meter * * @param meterId The meter identifier for the meter being retrieved */ getMeter(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterActualMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterActualYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get bill split parent information for a meter * * @param meterId ID of the meter */ getMeterBillSplitParentDetails(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedTrend(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterCalendarizedYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a channel and its channel versions linked to a meter * * @param meterId Id of the linked meter to retrieve the channel information for * @param channelId Id of the channel to retrieve information for */ getMeterChannel(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all channel and channel versions linked to a meter * * @param meterId Id of the meter to retrieve the channel information for */ getMeterChannels(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the configured GHG scope category and factor for a meter. GHG License is required to call this endpoint. * * @param meterId The meter to retrieve settings for */ getMeterGHGSettings(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Meter Groups for a particular meter * * @param meterId The meter identifier for which group values are being retrieved */ getMeterGroups(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated bill meter line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getMeterLineItems(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterNormalizedMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterNormalizedYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all rates for a particular meter * * @param meterId The meter identifier for which rate values are being retrieved */ getMeterRates(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data for a given meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months */ getMeterSavingsMonthly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves savings data for a single meter for a given number of years. * * @param meterId The meter for which to return data * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 */ getMeterSavingsYearly(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyList(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all templates for a particular meter * * @param meterId The meter identifier for which template values are being retrieved */ getMeterTemplates(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular meter * * @param meterId The meter identifier for which user defined field / custom field values are being retrieved */ getMeterUdfs(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of readings * * @param channelId Specific Channel ID * @param beginDate The starting date of readings to return * @param endDate The end date of readings to return * @param originalValue If 'true', returns the original observation value. If 'false' returns the computed observation value based on the channel type. NOTE: this parameter is no longer used and has been deprecated. */ getReadings(channelId: number, beginDate?: Date, endDate?: Date, originalValue?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one route * * @param id The identifier for route being retrieved */ getRoute(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves one route and all the meters on that route The meters are ordered by display order * * @param id The identifier for route being retrieved */ getRouteDetails(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all routes * */ getRoutes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of routes with their list of meters and a list of channels on each meter with the latest reading Meters are returned in order they appear on a route If the interval filter is passed and no channels match the filter, the route is not included in the response. * * @param filter */ getRoutesWithMetersChannelsLatestReading(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of the Adjusted Cost Types * */ getSavingsAdjustedCostTypeList(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single Savings Details record of usage and cost avoidance for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBill(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get cost avoidance savings by day for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillDaily(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get Savings Details of usage and cost avoidance for a meter's bills * * @param meterId The meter for which to retrieve data * @param numberOfYears Number of years of data to return; includes the current year - Defaults to 5 */ getSavingsMeterBillList(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single cost avoidance task by its unique ID * * @param taskId */ getSavingsTask(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasks(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Special Adjustment Methods * */ getSpecialAdjustmentMethods(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Special Adjustment Types * */ getSpecialAdjustmentTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMeters(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get meters on a particular place * * @param placeId The id of the place */ getUtilityPlatformMetersByPlace(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a channel version custom field * * @param meterId * @param channelId * @param versionId * @param udfId */ downloadChannelVersionCustomFieldFileWithHttpInfo(meterId: number, channelId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a meter custom field * * @param meterId * @param udfId */ downloadMeterCustomFieldFileWithHttpInfo(meterId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated bill account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getAccountLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get calculated cost details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillCostWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated demand details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDemandWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * All details related to calculated bill setup including use, cost, meter line items, and account line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillDetailsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get calculated use details * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getCalculateBillUseWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of calculated bill versions on this account and meter relationship * * @param accountId ID of the account to get all assigned calculated bill versions * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillVersionHistoryWithHttpInfo(accountId: number, meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of calculated bill versions on a meter * * @param meterId ID of the meter to get all assigned calculated bill versions */ getCalculatedBillsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get calendarized Use vs Weather data * * @param meterId The meter identifier */ getCalendarizedUseVsWeatherDataWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all data points * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getDataPointsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an ESA channel * * @param esaChannelId The ESA channel identifier */ getEsaChannelWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an ESA channel version for a specified ESA channel * * @param esaChannelId The ESA channel identifier * @param versionId The ESA channel version identifier */ getEsaChannelVersionWithHttpInfo(esaChannelId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all ESA channel version for a specified ESA channel * * @param esaChannelId */ getEsaChannelVersionsWithHttpInfo(esaChannelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a filtered list of ESA Channels. * * @param filter * @param orderBy * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEsaChannelsWithHttpInfo(filter?: string, orderBy?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets an ESA reading import profile * * @param profileId */ getEsaReadingImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all ESA reading import profiles * */ getEsaReadingImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the ghg meter factors * * @param meterId The meter identifier for ghg factors are being retrieved */ getGHGMeterFactorsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one meter * * @param meterId The meter identifier for the meter being retrieved */ getMeterWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterActualMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up actual billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterActualYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up billing data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterActualYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get bill split parent information for a meter * * @param meterId ID of the meter */ getMeterBillSplitParentDetailsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterCalendarizedTrendWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterCalendarizedYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up calendarized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterCalendarizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a channel and its channel versions linked to a meter * * @param meterId Id of the linked meter to retrieve the channel information for * @param channelId Id of the channel to retrieve information for */ getMeterChannelWithHttpInfo(meterId: number, channelId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all channel and channel versions linked to a meter * * @param meterId Id of the meter to retrieve the channel information for */ getMeterChannelsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get the configured GHG scope category and factor for a meter. GHG License is required to call this endpoint. * * @param meterId The meter to retrieve settings for */ getMeterGHGSettingsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Meter Groups for a particular meter * * @param meterId The meter identifier for which group values are being retrieved */ getMeterGroupsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get calculated bill meter line items * * @param accountId ID of the account to receive calculated bill details * @param meterId ID of the meter to receive calculated bill details * @param versionId ID of the calculated bill distribution version */ getMeterLineItemsWithHttpInfo(accountId: number, meterId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) */ getMeterNormalizedMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized billing data by meter for a given range of months- Result includes cost, use, unit cost on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years of months (24 for actual and savings, and 24 or 26 (if 13 accounting periods) for calendarized and normalized) * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up normalized billing data for a given meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getMeterNormalizedYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up normalized data by meter for a given range of years- Result includes cost, use, unit cost on an yearly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterNormalizedYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all rates for a particular meter * * @param meterId The meter identifier for which rate values are being retrieved */ getMeterRatesWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves rolled up savings billing data for a given meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param meterId The identifier for the meter being retrieved * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months */ getMeterSavingsMonthlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up savings billing data by meter for a given number of years- Result includes cost and use savings on a monthly basis. * * @param numberOfYears Number of years of data to return includes the current year - Defaults to two years/24 months * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsMonthlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves savings data for a single meter for a given number of years. * * @param meterId The meter for which to return data * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 */ getMeterSavingsYearlyWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves savings data by meter for a given number of years. * * @param numberOfYears Number of years of data to return including the current year - Defaults to 4 * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMeterSavingsYearlyListWithHttpInfo(numberOfYears?: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all templates for a particular meter * * @param meterId The meter identifier for which template values are being retrieved */ getMeterTemplatesWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for a particular meter * * @param meterId The meter identifier for which user defined field / custom field values are being retrieved */ getMeterUdfsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getMetersUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of readings * * @param channelId Specific Channel ID * @param beginDate The starting date of readings to return * @param endDate The end date of readings to return * @param originalValue If 'true', returns the original observation value. If 'false' returns the computed observation value based on the channel type. NOTE: this parameter is no longer used and has been deprecated. */ getReadingsWithHttpInfo(channelId: number, beginDate?: Date, endDate?: Date, originalValue?: boolean, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one route * * @param id The identifier for route being retrieved */ getRouteWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one route and all the meters on that route The meters are ordered by display order * * @param id The identifier for route being retrieved */ getRouteDetailsWithHttpInfo(id: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all routes * */ getRoutesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves a list of routes with their list of meters and a list of channels on each meter with the latest reading Meters are returned in order they appear on a route If the interval filter is passed and no channels match the filter, the route is not included in the response. * * @param filter */ getRoutesWithMetersChannelsLatestReadingWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Gets a list of the Adjusted Cost Types * */ getSavingsAdjustedCostTypeListWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single Savings Details record of usage and cost avoidance for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillWithHttpInfo(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get cost avoidance savings by day for a meter and bill * * @param meterId The meter for which to retrieve data * @param billId The bill for which to retrieve data */ getSavingsMeterBillDailyWithHttpInfo(meterId: number, billId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get Savings Details of usage and cost avoidance for a meter's bills * * @param meterId The meter for which to retrieve data * @param numberOfYears Number of years of data to return; includes the current year - Defaults to 5 */ getSavingsMeterBillListWithHttpInfo(meterId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single cost avoidance task by its unique ID * * @param taskId */ getSavingsTaskWithHttpInfo(taskId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of cost avoidance tasks NOTE: does not include cost avoidance tasks created from prior versions of the software * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getSavingsTasksWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get Special Adjustment Methods * */ getSpecialAdjustmentMethodsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get Special Adjustment Types * */ getSpecialAdjustmentTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get all unplaced meters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getUnplacedMetersWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get meters on a particular place * * @param placeId The id of the place */ getUtilityPlatformMetersByPlaceWithHttpInfo(placeId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMoveAccountsBetweenVendorsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Add accounts to a vendor * * @param vendorId The identifier for the vendor to which accounts are being added * @param body List of accountIds to move a new vendor */ addAccounts(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Add accounts to a vendor * * @param vendorId The identifier for the vendor to which accounts are being added * @param body List of accountIds to move a new vendor */ addAccountsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsMoveExistingBillsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bills * * @param body List of Bill Ids to be used to determine the commodities to be matched on the destination accounts. */ getPossibleDestinationAccounts(body?: ListIds, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of Accounts that contain meters of ALL of the commodities represented by the given Account's Bill List * * @param accountId A specific Account that should be used for finding matching Accounts (uses all Bills on the Account Bill List). */ getPossibleDestinationAccountsForAccountList(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bill List * * @param listId A specific Bill List that should be used for finding matching Accounts. */ getPossibleDestinationAccountsForList(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the list of given bills to the specified destination account and meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. * * @param body DTO containing a list of Bill Ids, the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope cateogory and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. */ moveBillsToAccount(body?: BillActionMove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the bills from the given Account's Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"accountId\"> Account for the Bill List containing a list of bills that should be moved. All bills from this Account's Bill List will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param accountId * @param body */ moveBillsToAccountFromAccountList(accountId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Moves the bills from the given Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"listId\"> Bill List containing a list of bills that should be moved. All bills from this list will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param listId * @param body */ moveBillsToAccountFromList(listId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bills * * @param body List of Bill Ids to be used to determine the commodities to be matched on the destination accounts. */ getPossibleDestinationAccountsWithHttpInfo(body?: ListIds, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of Accounts that contain meters of ALL of the commodities represented by the given Account's Bill List * * @param accountId A specific Account that should be used for finding matching Accounts (uses all Bills on the Account Bill List). */ getPossibleDestinationAccountsForAccountListWithHttpInfo(accountId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bill List * * @param listId A specific Bill List that should be used for finding matching Accounts. */ getPossibleDestinationAccountsForListWithHttpInfo(listId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the list of given bills to the specified destination account and meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. * * @param body DTO containing a list of Bill Ids, the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope cateogory and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. */ moveBillsToAccountWithHttpInfo(body?: BillActionMove, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the bills from the given Account's Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"accountId\"> Account for the Bill List containing a list of bills that should be moved. All bills from this Account's Bill List will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param accountId * @param body */ moveBillsToAccountFromAccountListWithHttpInfo(accountId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Moves the bills from the given Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name=\"listId\"> Bill List containing a list of bills that should be moved. All bills from this list will be moved. </param><param name=\"dto\"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param> * * @param listId * @param body */ moveBillsToAccountFromListWithHttpInfo(listId: number, body?: BillActionMoveList, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsPublicDashboardsOrMapsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edits the public display settings for a dashboard. Settings can only be applied to public dashboards. Filter settings cannot be applied to Map dashboards. To apply these settings, you must have the PublicDashboardsOrMaps Manage permission. You must also have either created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier for the dashboard to apply settings to. * @param body An object containing the settings to be applied. */ editDashboardSettings(dashboardId: number, body?: DashboardGlobalSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits the public display settings for a dashboard. Settings can only be applied to public dashboards. Filter settings cannot be applied to Map dashboards. To apply these settings, you must have the PublicDashboardsOrMaps Manage permission. You must also have either created the dashboard or have DashboardAdministrator Manage and the dashboard is shared at all or have DashboardAdministrator Manage permission and the dashboard is public or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you * * @param dashboardId The identifier for the dashboard to apply settings to. * @param body An object containing the settings to be applied. */ editDashboardSettingsWithHttpInfo(dashboardId: number, body?: DashboardGlobalSettingsEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRateSchedulesCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a rate schedule * * @param body The properties of the rate schedule to be created */ createRate(body?: RateCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a rate schedule * * @param body The properties of the rate schedule to be created */ createRateWithHttpInfo(body?: RateCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRateSchedulesDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete a rate schedule * * @param rateId Unique identifier of the rate schedule to be deleted */ deleteRate(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a rate schedule * * @param rateId Unique identifier of the rate schedule to be deleted */ deleteRateWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRateSchedulesEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a rate schedule version * Allows the user to create a new version for a rate schedule for use in chargeback scenarios where use or demand cost for calculated bills must be created from a predefined unit cost. ### Validation * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Inserting a rate version before an existing version will set the new version's end date to the effective date of the subsequent version. * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule to receive the new version * @param body The properties of the rate schedule version to be created */ createRateVersion(rateId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a version of a rate schedule * ### Validation * The last remaining rate version may not be deleted ### Other Remarks * When a rate version is deleted, if there is a preceding rate version, then its end date will be reset to the end date of the deleted rate version. * @param rateId Unique identifier of the rate schedule to which the version being deleted belongs * @param versionId Unique identifier of the rate schedule version to delete */ deleteRateVersion(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a rate * * @param rateId Unique identifier of the rate schedule to be edited * @param body Updated properties of the rate schedule to be edited */ editRate(rateId: number, body?: RateEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a rate schedule version * ### Validation * Effective date of the edited version * Must be after the effective date of the previous version * Must be prior to the effective date of the next version * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule whose version will be edited * @param versionId Unique identifier of the rate schedule version to be edited * @param body Updated properties of the rate schedule version to be edited */ editRateVersion(rateId: number, versionId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a rate schedule version * Allows the user to create a new version for a rate schedule for use in chargeback scenarios where use or demand cost for calculated bills must be created from a predefined unit cost. ### Validation * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Inserting a rate version before an existing version will set the new version's end date to the effective date of the subsequent version. * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule to receive the new version * @param body The properties of the rate schedule version to be created */ createRateVersionWithHttpInfo(rateId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a version of a rate schedule * ### Validation * The last remaining rate version may not be deleted ### Other Remarks * When a rate version is deleted, if there is a preceding rate version, then its end date will be reset to the end date of the deleted rate version. * @param rateId Unique identifier of the rate schedule to which the version being deleted belongs * @param versionId Unique identifier of the rate schedule version to delete */ deleteRateVersionWithHttpInfo(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a rate * * @param rateId Unique identifier of the rate schedule to be edited * @param body Updated properties of the rate schedule to be edited */ editRateWithHttpInfo(rateId: number, body?: RateEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a rate schedule version * ### Validation * Effective date of the edited version * Must be after the effective date of the previous version * Must be prior to the effective date of the next version * Account and meter line items * Subtotal calculation type is not supported ### Other Remarks * Null values are acceptable for use and demand unit costs. However, for chargeback bills to calculate correctly, these values must be provided. * @param rateId Unique identifier of the rate schedule whose version will be edited * @param versionId Unique identifier of the rate schedule version to be edited * @param body Updated properties of the rate schedule version to be edited */ editRateVersionWithHttpInfo(rateId: number, versionId: number, body?: RateVersionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRecordsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create an emission record * * @param body Data representing the record being created */ createEmissionRecord(body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates an emission record import profile * * @param body Object containing settings for the new profile */ createRecordImportProfile(body?: RecordImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes an emission record import profile * * @param profileId The identifier of the profile to delete */ deleteRecordImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits an emission record import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings to change */ editRecordImportProfile(profileId: number, body?: RecordImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * This endpoint allows the import of a emission records import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEmissionRecordsWithProfile(body?: RecordImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create an emission record * * @param body Data representing the record being created */ createEmissionRecordWithHttpInfo(body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates an emission record import profile * * @param body Object containing settings for the new profile */ createRecordImportProfileWithHttpInfo(body?: RecordImportProfileRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes an emission record import profile * * @param profileId The identifier of the profile to delete */ deleteRecordImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits an emission record import profile * * @param profileId The identifier of the profile to edit * @param body Object containing settings to change */ editRecordImportProfileWithHttpInfo(profileId: number, body?: RecordImportProfileEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * This endpoint allows the import of a emission records import file. The file should be a base64-encoded delimited text file with a UTF8 character set. * * @param body DTO containing the data to import and the profile that defines the structure. */ importEmissionRecordsWithProfileWithHttpInfo(body?: RecordImportRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRecordsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Delete an emission record * * @param emissionRecordId The Id of the emission record to delete */ deleteEmissionRecord(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an emission record * * @param emissionRecordId The Id of the emission record to delete */ deleteEmissionRecordWithHttpInfo(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRecordsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Edit an emission record * * @param emissionRecordId The Id of the emission record to edit * @param body Data representing the emission record being edited */ editEmissionRecord(emissionRecordId: number, body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an emission record * * @param emissionRecordId The Id of the emission record to edit * @param body Data representing the emission record being edited */ editEmissionRecordWithHttpInfo(emissionRecordId: number, body?: EmissionRecordRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRecordsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordList(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param collectionId The collection to export records */ collectionRecordListExcelExport(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordList(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Export list data to excel spreadsheet format * * @param emissionSourceId The emissionSource to export records */ emissionSourceRecordListExcelExport(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve an emission record by ID * * @param emissionRecordId The Id of the emission record to retrieve */ getEmissionRecord(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecords(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get an emission record import profile * * @param profileId The identifier of the profile to get */ getRecordImportProfile(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all emission record import profiles * */ getRecordImportProfiles(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the collection records list * * @param collectionId The collection identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ collectionRecordListWithHttpInfo(collectionId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param collectionId The collection to export records */ collectionRecordListExcelExportWithHttpInfo(collectionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the emission source records list * * @param emissionSourceId The emission source identifier to retrieve records list for * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ emissionSourceRecordListWithHttpInfo(emissionSourceId: number, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Export list data to excel spreadsheet format * * @param emissionSourceId The emissionSource to export records */ emissionSourceRecordListExcelExportWithHttpInfo(emissionSourceId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve an emission record by ID * * @param emissionRecordId The Id of the emission record to retrieve */ getEmissionRecordWithHttpInfo(emissionRecordId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieve a list of emission records * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getEmissionRecordsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get an emission record import profile * * @param profileId The identifier of the profile to get */ getRecordImportProfileWithHttpInfo(profileId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all emission record import profiles * */ getRecordImportProfilesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsReportAdministratorManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * */ installReports(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * */ installReportsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsReportGroupsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param body */ createReportGroup(body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a Report Group * * @param reportGroupId */ deleteReportGroup(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param reportGroupId * @param body */ editReportGroup(reportGroupId: number, body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ createReportGroupWithHttpInfo(body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a Report Group * * @param reportGroupId */ deleteReportGroupWithHttpInfo(reportGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param reportGroupId * @param body */ editReportGroupWithHttpInfo(reportGroupId: number, body?: ReportGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsReportsRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Subscribe to a report and receive scheduled emails This must be a saved report that belongs to or is shared with the current user Only SSRS reports are supported * * @param specificReportId * @param body */ createReportSubscription(specificReportId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Save a specific report to Saved Reports * * @param specificReportId The specific report to save * @param body The specific report create properties */ createSpecificReport(specificReportId: number, body?: ReportCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId */ deleteReportSubscription(specificReportId: number, reportSubscriptionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param specificReportId */ deleteSpecificReport(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Execute a report, save it in a given format, and email it to a list of recipients. If distributing reports, returns a 204 No Content if onlySendIfData is set to True and the report generated no data; returns a 200 and the generated report for download or an empty body if onlySendIfData is set to True * * @param specificReportId The ID of the specific report to run * @param body Allows the user to run one report and optionally email it to one or more recipients. They can optionally specify whether or not the report(s) should be sent if they contain no data. */ distributeReport(specificReportId: number, body?: DistributedReportsConfiguration, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be edited * @param body The list of filters to apply */ editReportFilters(specificReportId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId * @param body */ editReportSubscription(specificReportId: number, reportSubscriptionId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a specific report * * @param specificReportId The specific report to edit * @param body The specific report edit properties */ editSpecificReport(specificReportId: number, body?: ReportEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be retrieved */ getReportFilters(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get sharing information for a report * Only the user who created the report or a report administrator is permitted to get sharing details for a report. * @param specificReportId The specific report for which to retrieve sharing information */ getReportSharingDetails(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all available report subscription schedule types, and their day indicator values * */ getReportSubscriptionScheduleTypes(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a report by its specificReportID. * * @param specificReportId */ getSpecificReport(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a filterable list of installed, saved, and shared reports available to the current user. * * @param filter */ getSpecificReports(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Execute and email report subscriptions that are ready to be run * */ processReportSubscriptions(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Generates a \"quick report\" in the specified export format (or in its preferred export format if not specified) as identified by the provided report code and applying ONLY the filters supplied. * * @param body */ runQuickReport(body?: QuickReport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Run a report and download in the provided format * * @param specificReportId The ID of the specific report to run * @param format The format in which the generated report should be downloaded. Supported options are [\"excel\", \"csv\", \"pdf\", \"word\"] */ runReport(specificReportId: number, format?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Share a saved report with other users * * @param specificReportId ID of the saved report to share * @param body Updated sharing details for the report */ shareSavedReport(specificReportId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the visibility of a report for the current user This must be a report you can see Which means you must have created the report or have ReportAdministrator Manage permission and the report is shared at all or have SharedReports View permission and the report is shared with you * * @param specificReportId Specific dashboard * @param body Set Visibility */ toggleSharedReportVisibility(specificReportId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Subscribe to a report and receive scheduled emails This must be a saved report that belongs to or is shared with the current user Only SSRS reports are supported * * @param specificReportId * @param body */ createReportSubscriptionWithHttpInfo(specificReportId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Save a specific report to Saved Reports * * @param specificReportId The specific report to save * @param body The specific report create properties */ createSpecificReportWithHttpInfo(specificReportId: number, body?: ReportCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId */ deleteReportSubscriptionWithHttpInfo(specificReportId: number, reportSubscriptionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param specificReportId */ deleteSpecificReportWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Execute a report, save it in a given format, and email it to a list of recipients. If distributing reports, returns a 204 No Content if onlySendIfData is set to True and the report generated no data; returns a 200 and the generated report for download or an empty body if onlySendIfData is set to True * * @param specificReportId The ID of the specific report to run * @param body Allows the user to run one report and optionally email it to one or more recipients. They can optionally specify whether or not the report(s) should be sent if they contain no data. */ distributeReportWithHttpInfo(specificReportId: number, body?: DistributedReportsConfiguration, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be edited * @param body The list of filters to apply */ editReportFiltersWithHttpInfo(specificReportId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Edit a report subscription This must be a subscription that belongs to the current user * * @param specificReportId * @param reportSubscriptionId * @param body */ editReportSubscriptionWithHttpInfo(specificReportId: number, reportSubscriptionId: number, body?: ReportSubscriptionRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a specific report * * @param specificReportId The specific report to edit * @param body The specific report edit properties */ editSpecificReportWithHttpInfo(specificReportId: number, body?: ReportEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the filters for a specific report. * * @param specificReportId The specific report for which the filters are to be retrieved */ getReportFiltersWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get sharing information for a report * Only the user who created the report or a report administrator is permitted to get sharing details for a report. * @param specificReportId The specific report for which to retrieve sharing information */ getReportSharingDetailsWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all available report subscription schedule types, and their day indicator values * */ getReportSubscriptionScheduleTypesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a report by its specificReportID. * * @param specificReportId */ getSpecificReportWithHttpInfo(specificReportId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a filterable list of installed, saved, and shared reports available to the current user. * * @param filter */ getSpecificReportsWithHttpInfo(filter?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Execute and email report subscriptions that are ready to be run * */ processReportSubscriptionsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Generates a \"quick report\" in the specified export format (or in its preferred export format if not specified) as identified by the provided report code and applying ONLY the filters supplied. * * @param body */ runQuickReportWithHttpInfo(body?: QuickReport, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Run a report and download in the provided format * * @param specificReportId The ID of the specific report to run * @param format The format in which the generated report should be downloaded. Supported options are [\"excel\", \"csv\", \"pdf\", \"word\"] */ runReportWithHttpInfo(specificReportId: number, format?: string, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Share a saved report with other users * * @param specificReportId ID of the saved report to share * @param body Updated sharing details for the report */ shareSavedReportWithHttpInfo(specificReportId: number, body?: ShareRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the visibility of a report for the current user This must be a report you can see Which means you must have created the report or have ReportAdministrator Manage permission and the report is shared at all or have SharedReports View permission and the report is shared with you * * @param specificReportId Specific dashboard * @param body Set Visibility */ toggleSharedReportVisibilityWithHttpInfo(specificReportId: number, body?: ToggleVisible, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsRolesManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * * * @param body */ createUserRole(body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a user role * * @param userRoleId The identifier for the role being deleted */ deleteUserRole(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param userRoleId * @param body */ editUserRole(userRoleId: number, body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param userRoleId * @param body */ setUserRoleHidden(userRoleId: number, body?: HiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * * * @param body */ createUserRoleWithHttpInfo(body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a user role * * @param userRoleId The identifier for the role being deleted */ deleteUserRoleWithHttpInfo(userRoleId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param userRoleId * @param body */ editUserRoleWithHttpInfo(userRoleId: number, body?: SystemUserRoleWithHiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * * * @param userRoleId * @param body */ setUserRoleHiddenWithHttpInfo(userRoleId: number, body?: HiddenRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which the other savings is being created * @param body Data representing the other savings adjustment being created */ createOtherSavings(meterId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create other savings category * * @param body Data representing the other saving category being created */ createOtherSavingsCategory(body?: OtherSavingsCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which to create a special adjustment * @param body Data representing the special adjustment being created */ createSpecialAdjustment(meterId: number, body?: SpecialAdjustmentCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete an other savings adjustment * * @param meterId The meter for which the other savings is being deleted * @param otherSavingsId The other saving identifier which is being deleted */ deleteOtherSavings(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter from which to delete the special adjustment * @param specialAdjustmentId The special adjustment to delete */ deleteSpecialAdjustmentById(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter whose other savings is being edited * @param otherSavingsId The other savings to edit * @param body Data representing the other savings adjustment being edited */ editOtherSavings(meterId: number, otherSavingsId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter with the special adjustment to edit * @param specialAdjustmentId The special adjustment to edit * @param body Data representing the special adjustment being edited */ editSpecialAdjustment(meterId: number, specialAdjustmentId: number, body?: SpecialAdjustmentEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which the other savings is being created * @param body Data representing the other savings adjustment being created */ createOtherSavingsWithHttpInfo(meterId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create other savings category * * @param body Data representing the other saving category being created */ createOtherSavingsCategoryWithHttpInfo(body?: OtherSavingsCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a new special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter for which to create a special adjustment * @param body Data representing the special adjustment being created */ createSpecialAdjustmentWithHttpInfo(meterId: number, body?: SpecialAdjustmentCreate, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete an other savings adjustment * * @param meterId The meter for which the other savings is being deleted * @param otherSavingsId The other saving identifier which is being deleted */ deleteOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter from which to delete the special adjustment * @param specialAdjustmentId The special adjustment to delete */ deleteSpecialAdjustmentByIdWithHttpInfo(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an other savings adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter whose other savings is being edited * @param otherSavingsId The other savings to edit * @param body Data representing the other savings adjustment being edited */ editOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, body?: OtherSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a special adjustment Meter Cost Avoidance Savings will be re-calculated * * @param meterId The meter with the special adjustment to edit * @param specialAdjustmentId The special adjustment to edit * @param body Data representing the special adjustment being edited */ editSpecialAdjustmentWithHttpInfo(meterId: number, specialAdjustmentId: number, body?: SpecialAdjustmentEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get a other savings for a meter * * @param meterId The meter for which the other savings are being retrieved */ getAllOtherSavings(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get one other savings for a meter * * @param meterId The meter for which the other savings are being retrieved * @param otherSavingsId The identifier for the other savings record which is being retrieved */ getOneOtherSavings(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get other savings categories * */ getOtherSavingsCategories(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a single special adjustment by its unique ID * * @param meterId The meter for which to return the special adjustment * @param specialAdjustmentId Unique ID of the special adjustment to return */ getSpecialAdjustment(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get all the special adjustments for the meter * * @param meterId The meter for which to return special adjustment */ getSpecialAdjustments(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a other savings for a meter * * @param meterId The meter for which the other savings are being retrieved */ getAllOtherSavingsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get one other savings for a meter * * @param meterId The meter for which the other savings are being retrieved * @param otherSavingsId The identifier for the other savings record which is being retrieved */ getOneOtherSavingsWithHttpInfo(meterId: number, otherSavingsId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get other savings categories * */ getOtherSavingsCategoriesWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a single special adjustment by its unique ID * * @param meterId The meter for which to return the special adjustment * @param specialAdjustmentId Unique ID of the special adjustment to return */ getSpecialAdjustmentWithHttpInfo(meterId: number, specialAdjustmentId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get all the special adjustments for the meter * * @param meterId The meter for which to return special adjustment */ getSpecialAdjustmentsWithHttpInfo(meterId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsSavingsEngineRunspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Calculate savings for the meters that match the filter conditions, using the provided settings * * @param body Settings and filter conditions for savings processing */ calculateSavings(body?: CalculateSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Return available filters for Cost Avoidance processors Filters: - Commodity ID - Commodity Name - Meter Group Name - Building Group Name - Topmost Place Code - Topmost Place Name * */ getCostAvoidanceFilters(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Calculate savings for the meters that match the filter conditions, using the provided settings * * @param body Settings and filter conditions for savings processing */ calculateSavingsWithHttpInfo(body?: CalculateSavingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return available filters for Cost Avoidance processors Filters: - Commodity ID - Commodity Name - Meter Group Name - Building Group Name - Topmost Place Code - Topmost Place Name * */ getCostAvoidanceFiltersWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsUnitSystemSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a commodity * * @param body Data representing the commodity being created */ createCommodity(body?: CommodityRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a commodity category * * @param body Data representing the commodity category being created */ createCommodityCategory(body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a commodity * * @param commodityId The commodity Id */ deleteCommodity(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a commodity category * * @param commodityCategoryId The commodity category identifier */ deleteCommodityCategory(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a commodity * * @param commodityId The commodity Id * @param body Data that will be used to update the commodity */ editCommodity(commodityId: number, body?: CommodityEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a commodity category * * @param commodityCategoryId The commodity category identifier * @param body Data representing the commodity category being created */ editCommodityCategory(commodityCategoryId: number, body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a commodity * * @param body Data representing the commodity being created */ createCommodityWithHttpInfo(body?: CommodityRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Creates a commodity category * * @param body Data representing the commodity category being created */ createCommodityCategoryWithHttpInfo(body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a commodity * * @param commodityId The commodity Id */ deleteCommodityWithHttpInfo(commodityId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Deletes a commodity category * * @param commodityCategoryId The commodity category identifier */ deleteCommodityCategoryWithHttpInfo(commodityCategoryId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a commodity * * @param commodityId The commodity Id * @param body Data that will be used to update the commodity */ editCommodityWithHttpInfo(commodityId: number, body?: CommodityEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a commodity category * * @param commodityCategoryId The commodity category identifier * @param body Data representing the commodity category being created */ editCommodityCategoryWithHttpInfo(commodityCategoryId: number, body?: CommodityCategoryRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Create a new user. Requires Manage permission for Users & Roles * * @param body The object defining the properties for the new user */ createUser(body?: UserCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a user group * * @param body Data representing the user group being created */ createUserGroup(body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Delete a user group * * @param userGroupId Id of the user group to delete */ deleteUserGroup(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a system user's role. * * @param userId * @param body */ editSystemUsersRole(userId: number, body?: UserRoleRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit an existing user. Requires Manage permission for Users & Roles. Please note that password is optional; all other items are required. MaxApprovalAmount may be null; if there is an existing value and null is passed, the existing value will be overwritten. * * @param userId The ID of the user to edit * @param body The object defining the updated properties of the existing user. */ editUser(userId: number, body?: UserEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edit a user group * * @param userGroupId Id of the user group to edit * @param body Data representing the user group being edited */ editUserGroup(userGroupId: number, body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Update the default notification settings assigned to new users * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationSystemSettings(body?: NotificationSystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Create a new user. Requires Manage permission for Users & Roles * * @param body The object defining the properties for the new user */ createUserWithHttpInfo(body?: UserCreateRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Create a user group * * @param body Data representing the user group being created */ createUserGroupWithHttpInfo(body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Delete a user group * * @param userGroupId Id of the user group to delete */ deleteUserGroupWithHttpInfo(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a system user's role. * * @param userId * @param body */ editSystemUsersRoleWithHttpInfo(userId: number, body?: UserRoleRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit an existing user. Requires Manage permission for Users & Roles. Please note that password is optional; all other items are required. MaxApprovalAmount may be null; if there is an existing value and null is passed, the existing value will be overwritten. * * @param userId The ID of the user to edit * @param body The object defining the updated properties of the existing user. */ editUserWithHttpInfo(userId: number, body?: UserEditRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edit a user group * * @param userGroupId Id of the user group to edit * @param body Data representing the user group being edited */ editUserGroupWithHttpInfo(userGroupId: number, body?: UserGroupRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Update the default notification settings assigned to new users * * @param body Values to update the system notification settings. If a setting is not passed it's value is not updated. */ updateNotificationSystemSettingsWithHttpInfo(body?: NotificationSystemSettingsRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * The default notification settings assigned to new users * */ getNotificationSystemSettings(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Return a specific user and its properties. Requires View permission for Users & Roles * * @param userId The ID of the user to return */ getUser(userId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Gets a list of user group members * * @param userGroupId Id of the user group to get the list of members */ getUserGroupMembers(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * The default notification settings assigned to new users * */ getNotificationSystemSettingsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Return a specific user and its properties. Requires View permission for Users & Roles * * @param userId The ID of the user to return */ getUserWithHttpInfo(userId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Gets a list of user group members * * @param userGroupId Id of the user group to get the list of members */ getUserGroupMembersWithHttpInfo(userGroupId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsVendorsAndRatesModuleViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Download file for a rate custom field * * @param rateId * @param versionId * @param udfId */ downloadRateCustomFieldFile(rateId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Download file for a vendor custom field * * @param vendorId * @param udfId */ downloadVendorCustomFieldFile(vendorId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by commodities for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param commodityId The commodity to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getCommodityActualYearly(commodityId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a rate schedule * * @param rateId Unique ID of the rate schedule */ getRate(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by rate for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param rateId The rate to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getRateActualYearly(rateId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get the unit used by a rate. The unit is determined by the usage unit on the most recent template assigned to a meter with the given rate. * * @param rateId Unique identifier of the rate schedule for which the unit will be retrieved */ getRateUnit(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a rate version with its details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve * @param versionId ID of the rate schedule version to retrieve */ getRateVersion(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve */ getRateVersions(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRates(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves one vendor * * @param vendorId The identifier for the vendor being retrieved */ getVendor(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves rolled up actual billing data by vendor for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param vendorId The vendor to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getVendorActualYearly(vendorId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all Contracts for a particular vendor. Contracts are not supported in EnergyCAP Version 7, this API is for reading existing contracts only and may be removed in the future. * * @param vendorId The vendor identifier for which Contracts are being retrieved */ getVendorContracts(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves the most recent template from the specified vendor * * @param vendorId The vendor identifier to search by */ getVendorTemplate(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Retrieves all user defined fields / custom fields for a particular vendor * * @param vendorId The vendor identifier for which user defined field / custom field values are being retrieved */ getVendorUdfs(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendors(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfs(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a rate custom field * * @param rateId * @param versionId * @param udfId */ downloadRateCustomFieldFileWithHttpInfo(rateId: number, versionId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Download file for a vendor custom field * * @param vendorId * @param udfId */ downloadVendorCustomFieldFileWithHttpInfo(vendorId: number, udfId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by commodities for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param commodityId The commodity to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getCommodityActualYearlyWithHttpInfo(commodityId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a rate schedule * * @param rateId Unique ID of the rate schedule */ getRateWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by rate for a given number of years- Result includes cost, use, unit cost on an yearly basis. * * @param rateId The rate to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getRateActualYearlyWithHttpInfo(rateId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get the unit used by a rate. The unit is determined by the usage unit on the most recent template assigned to a meter with the given rate. * * @param rateId Unique identifier of the rate schedule for which the unit will be retrieved */ getRateUnitWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a rate version with its details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve * @param versionId ID of the rate schedule version to retrieve */ getRateVersionWithHttpInfo(rateId: number, versionId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines * * @param rateId ID of the rate schedule to retrieve */ getRateVersionsWithHttpInfo(rateId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Get a list of all rate schedules matching the provided filters * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getRatesWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves one vendor * * @param vendorId The identifier for the vendor being retrieved */ getVendorWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves rolled up actual billing data by vendor for a given number of years- Result includes cost, use, unit cost on an yearly basis. It also includes commodity level break up. * * @param vendorId The vendor to retrieve data for * @param numberOfYears Number of years of data to return includes the current year - Defaults to 4 */ getVendorActualYearlyWithHttpInfo(vendorId: number, numberOfYears?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all Contracts for a particular vendor. Contracts are not supported in EnergyCAP Version 7, this API is for reading existing contracts only and may be removed in the future. * * @param vendorId The vendor identifier for which Contracts are being retrieved */ getVendorContractsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves the most recent template from the specified vendor * * @param vendorId The vendor identifier to search by */ getVendorTemplateWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Retrieves all user defined fields / custom fields for a particular vendor * * @param vendorId The vendor identifier for which user defined field / custom field values are being retrieved */ getVendorUdfsWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Retrieves all user defined fields / custom fields for all vendors * * @param filter * @param pageSize The number of elements to return in a page * @param pageNumber The current page number */ getVendorsUdfsWithHttpInfo(filter?: string, pageSize?: number, pageNumber?: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsVendorsCreatespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Creates a vendor * * @param body Data representing the vendor being created */ createVendor(body?: VendorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Creates a vendor * * @param body Data representing the vendor being created */ createVendorWithHttpInfo(body?: VendorRequest, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsVendorsDeletespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Deletes a vendor * * @param vendorId The identifier for the vendor being deleted */ deleteVendor(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Deletes a vendor * * @param vendorId The identifier for the vendor being deleted */ deleteVendorWithHttpInfo(vendorId: number, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsVendorsEditspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Copies any template attached to the provided sourceVendorId to each of the recipientVendorIds specified in the body. If the recipient vendor has a template defined, it will be replaced with the lines on the source vendor's template. If the recipient vendor does not have a template defined, a new template will be created with the lines on the source vendor's template. * * @param sourceVendorId Identifier for the \"Source\" vendor, which serves as the source for the template to be copied * @param body List of identifiers for the \"Recipient\" vendors, who will each receive a copy of the template attached to the Source vendor */ copyVendorTemplate(sourceVendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits a vendor * * @param vendorId The identifier for the vendor being edited * @param body Data representing the vendor being edited */ editVendor(vendorId: number, body?: VendorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Edits user defined field / custom field values for a particular vendor * * @param vendorId The identifier for the vendor * @param body Data representing the vendor user defined fields / custom fields being edited */ editVendorUDFs(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Updates the template for the specified vendor * * @param vendorId The vendor to apply the template to * @param body Definition of the lines to apply to the template. If vendorLines is empty, any existing template will be deleted */ putVendorTemplate(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Copies any template attached to the provided sourceVendorId to each of the recipientVendorIds specified in the body. If the recipient vendor has a template defined, it will be replaced with the lines on the source vendor's template. If the recipient vendor does not have a template defined, a new template will be created with the lines on the source vendor's template. * * @param sourceVendorId Identifier for the \"Source\" vendor, which serves as the source for the template to be copied * @param body List of identifiers for the \"Recipient\" vendors, who will each receive a copy of the template attached to the Source vendor */ copyVendorTemplateWithHttpInfo(sourceVendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits a vendor * * @param vendorId The identifier for the vendor being edited * @param body Data representing the vendor being edited */ editVendorWithHttpInfo(vendorId: number, body?: VendorEdit, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Edits user defined field / custom field values for a particular vendor * * @param vendorId The identifier for the vendor * @param body Data representing the vendor user defined fields / custom fields being edited */ editVendorUDFsWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; /** * Updates the template for the specified vendor * * @param vendorId The vendor to apply the template to * @param body Definition of the lines to apply to the template. If vendorLines is empty, any existing template will be deleted */ putVendorTemplateWithHttpInfo(vendorId: number, body?: Array, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsWeatherSettingsManagespanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Import mean daily temperature readings for weather stations which are connected to EnergyCAP weather services * ### Other Remarks By default, this endpoint may be called without parameters to import weather for all \"used\" weather stations (at least one building is assigned to it) beginning from the current date minus 31 days. By providing a begin date, API users may go further back in history to backfill missing weather data. If a weather station has no readings at all, then the begin date will be set to 1899-12-31 so we can import history However the begin date is ascertained, readings will be imported from that date through today's date, overwriting any existing readings or filling in any missing readings. The API user may also provide a list of weather station codes. Even if the provided stations are not yet used, weather readings will be imported for them. * @param body */ importWeatherData(body?: WeatherImportSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable; /** * Import mean daily temperature readings for weather stations which are connected to EnergyCAP weather services * ### Other Remarks By default, this endpoint may be called without parameters to import weather for all \"used\" weather stations (at least one building is assigned to it) beginning from the current date minus 31 days. By providing a begin date, API users may go further back in history to backfill missing weather data. If a weather station has no readings at all, then the begin date will be set to 1899-12-31 so we can import history However the begin date is ascertained, readings will be imported from that date through today's date, overwriting any existing readings or filling in any missing readings. The API user may also provide a list of weather station codes. Even if the provided stations are not yet used, weather readings will be imported for them. * @param body */ importWeatherDataWithHttpInfo(body?: WeatherImportSettings, extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SpanClasspropertyinfoPermissionPermissionsWeatherSettingsViewspanService { protected http: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(http: HttpClient, basePath: string, configuration: Configuration); /** * * Extends object by coping non-existing properties. * @param objA object to be extended * @param objB source object */ private extendObj; /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * Get weather stations. Includes custom-created weather stations * */ getWeatherStations(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>; /** * Get weather stations. Includes custom-created weather stations * */ getWeatherStationsWithHttpInfo(extraHttpRequestParams?: { search: string | { [param: string]: string | string[]; }; }, extraHttpRequestHeaders?: { [header: string]: string | string[]; }): Observable>>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare const APIS: (typeof AccountService | typeof AccountDigestService | typeof AccountMeterService | typeof AccrualService | typeof ActivityService | typeof AdminService | typeof ApiService | typeof ApiKeyService | typeof AuditService | typeof AuthenticationService | typeof BatchService | typeof BillService | typeof BillAccountChargeSplitService | typeof BillSplitService | typeof BillViewService | typeof BudgetService | typeof CalculatedBillService | typeof ChannelService | typeof ChargebackEngineService | typeof ChargebackTaskService | typeof ChargebackWorkflowService | typeof CollectionService | typeof CommodityService | typeof CommodityCategoryService | typeof CommodityDigestService | typeof CostCategoryService | typeof CostCenterService | typeof CostCenterDigestService | typeof CountryService | typeof CustomerService | typeof DashboardService | typeof DataPointService | typeof EmissionRecordService | typeof EmissionSourceService | typeof EnergyManagerService | typeof EnergyProjectService | typeof EnergyStarService | typeof EnvironmentService | typeof EsaChannelService | typeof EsaPlaceService | typeof EsaReadingService | typeof ExportService | typeof FileStoreService | typeof FilterService | typeof FlagService | typeof FormulaService | typeof GHGService | typeof GeneralLedgerService | typeof HierarchyService | typeof ImportService | typeof ListService | typeof MeService | typeof MeterService | typeof MeterDigestService | typeof MeterGroupService | typeof MeterGroupDigestService | typeof NotificationService | typeof ObservationService | typeof ObservationTypeService | typeof PlaceService | typeof PlaceBenchmarkService | typeof PlaceDigestService | typeof PlaceGroupService | typeof PlaceGroupDigestService | typeof PostalCodeService | typeof PrimaryUseService | typeof RateService | typeof RateDigestService | typeof ReportService | typeof ReportBuilderService | typeof ReportDistributionService | typeof RouteService | typeof SavingsService | typeof ScheduleService | typeof SearchService | typeof SentinelService | typeof SetupService | typeof SummaryAccountService | typeof SystemUserService | typeof TagService | typeof TaskService | typeof TemplateService | typeof TimeZoneService | typeof UDFService | typeof UnitService | typeof UserGroupService | typeof UserRoleService | typeof UtilityPlatformService | typeof VendorService | typeof VendorDigestService | typeof WeatherStationService | typeof WebCaptureCredentialService | typeof WebhookService | typeof WidgetService | typeof WorkflowService | typeof SpanClasspropertyinfoPaginatedPaginatedspanService | typeof SpanClasspropertyinfoPermissionPermissionsAccountingSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsAccountsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsAccountsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsAccountsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsAccountsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsAccrualSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsAccrualSettingsRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsAccrualSettingsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsApplicationSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsApplicationSettingsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsApproveBillsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsBaselineEngineRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsBillCAPtureViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsChargebackReversalsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsChargebacksManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsChargebacksModuleViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsChargebacksRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsCollectionsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsCollectionsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsCollectionsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsCollectionsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsCostCentersCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsCostCentersDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsCostCentersEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsCostCentersViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsDashboardAndMapsModuleViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsDistributedReportsSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsEnergyManagerModuleViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsExportBillsRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsExportHoldManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsFacilityProjectsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsFacilityProjectsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsFacilityProjectsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsFlaggedItemsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsFlaggedItemsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsGroupsAndBenchmarksModuleViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsIntervalDataManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsLicenseFeatureIntervalDataAnalysisViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsManuallyAdjustSavingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsMetersCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsMetersDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsMetersEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsMetersViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsMoveAccountsBetweenVendorsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsMoveExistingBillsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsPublicDashboardsOrMapsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsRateSchedulesCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsRateSchedulesDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsRateSchedulesEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsRecordsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsRecordsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsRecordsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsRecordsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsReportAdministratorManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsReportGroupsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsReportsRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsRolesManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsSavingsEngineRunspanService | typeof SpanClasspropertyinfoPermissionPermissionsUnitSystemSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsVendorsAndRatesModuleViewspanService | typeof SpanClasspropertyinfoPermissionPermissionsVendorsCreatespanService | typeof SpanClasspropertyinfoPermissionPermissionsVendorsDeletespanService | typeof SpanClasspropertyinfoPermissionPermissionsVendorsEditspanService | typeof SpanClasspropertyinfoPermissionPermissionsWeatherSettingsManagespanService | typeof SpanClasspropertyinfoPermissionPermissionsWeatherSettingsViewspanService)[]; /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class SafeWaitHandle { /** * */ isInvalid: boolean | null | undefined; /** * */ isClosed: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class WaitHandle { safeWaitHandle: SafeWaitHandle | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class CancellationToken { /** * */ isCancellationRequested: boolean | null | undefined; /** * */ canBeCanceled: boolean | null | undefined; waitHandle: WaitHandle | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class EsaSentinelPredictionRequest { /** * The start local date/time of the range for which predictions are requested. If equal to endLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions since this date and time (exclusive). */ startLocalDate: Date | null | undefined; /** * The end local date/time of the range for which predictions are requested If equal to startLocalDate, returns sentinel prediction at this date and time (if present). Otherwise, returns sentinel predictions up to (and including) this date and time. Must be greater than or equal to StartLocalDate */ endLocalDate: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IActionResult { } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class IOutputFormatter { } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupDigestChild { /** * */ meterId: number | null | undefined; /** * */ meterCode: string | null | undefined; /** * */ meterInfo: string | null | undefined; /** * */ meterDisplay: string | null | undefined; commodity: CommodityChild | null | undefined; /** * */ includeInCharts: boolean | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupDigestDemandRankingChild { /** * */ cost: number | null | undefined; /** * */ value: number | null | undefined; /** * */ meterId: number | null | undefined; /** * */ meterCode: string | null | undefined; /** * */ meterInfo: string | null | undefined; /** * */ meterDisplay: string | null | undefined; commodity: CommodityChild | null | undefined; /** * */ includeInCharts: boolean | null | undefined; /** * Indicates whether the Meter is Active */ active: boolean | null | undefined; /** * Indicates whether the Meter is a calculated meter */ isCalculatedMeter: boolean | null | undefined; /** * Indicates whether the Meter is a parent of a split */ isSplitParentMeter: boolean | null | undefined; /** * Indicates whether the Meter is a child of a split */ isSplitChildMeter: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class MeterGroupDigestDemandRankingResponse { /** * */ highCost: number | null | undefined; /** * */ lowCost: number | null | undefined; /** * */ averageCost: number | null | undefined; /** * */ medianCost: number | null | undefined; /** * */ highValue: number | null | undefined; /** * */ lowValue: number | null | undefined; /** * */ averageValue: number | null | undefined; /** * */ medianValue: number | null | undefined; costUnit: UnitChild | null | undefined; /** * */ benchmarkUnit: string | null | undefined; /** * */ benchmarkValueUnit: string | null | undefined; /** * */ benchmarkFactorUnit: string | null | undefined; /** * */ results: Array | null | undefined; /** * */ meterGroupId: number | null | undefined; /** * */ meterGroupCode: string | null | undefined; /** * */ meterGroupInfo: string | null | undefined; /** * */ meterGroupDisplay: string | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ModelVoid { } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class OkObjectResult { /** * Required (defined) */ value: any | null | undefined; /** * Required (defined) */ formatters: Array | null | undefined; /** * Required (defined) */ contentTypes: Array | null | undefined; /** * Required (defined) */ declaredType: string | null | undefined; /** * Required (defined) */ statusCode: number | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestBenchmarkRankingChild { /** * The cost for this place */ cost: number | null | undefined; /** * The use for this place */ use: number | null | undefined; /** * The benchmark value for this place */ value: number | null | undefined; /** * Does this place have incomplete data? */ incompleteData: boolean | null | undefined; /** * */ placeId: number | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeDisplay: string | null | undefined; /** * */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestBenchmarkRankingResponse { /** * The highest cost for this group */ highCost: number | null | undefined; /** * The lowest cost for this group */ lowCost: number | null | undefined; /** * The average cost for this group */ averageCost: number | null | undefined; /** * The median cost for this group */ medianCost: number | null | undefined; /** * The highest use for this group */ highUse: number | null | undefined; /** * The lowest use for this group */ lowUse: number | null | undefined; /** * The average use for this group */ averageUse: number | null | undefined; /** * The median use for this group */ medianUse: number | null | undefined; /** * The highest benchmark value for this group */ highValue: number | null | undefined; /** * The lowest benchmark value for this group */ lowValue: number | null | undefined; /** * The median benchmark value for this group */ medianValue: number | null | undefined; /** * */ results: Array | null | undefined; /** * */ placeGroupId: number | null | undefined; /** * */ placeGroupCode: string | null | undefined; /** * */ placeGroupInfo: string | null | undefined; /** * This is the user's preferred way of viewing this entity - could be code or info based on the master \"data object view\" setting in DB */ placeGroupDisplay: string | null | undefined; /** * This will provide the benchmark unit eg:MMBTU/ft² or $/day */ benchmarkUnit: string | null | undefined; /** * This will provide the unit for the benchmarking factor eg:ft² or day */ benchmarkFactorUnit: string | null | undefined; /** * This will provide the unit for the benchmark value eg:$ for cost/day, MMBTU for annualized use/area */ benchmarkValueUnit: string | null | undefined; useUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestChild { /** * */ placeId: number | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeDisplay: string | null | undefined; /** * */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestWeatherRankingChild { /** * */ baseValue: number | null | undefined; /** * */ slopeValue: number | null | undefined; /** * */ placeId: number | null | undefined; /** * */ placeCode: string | null | undefined; /** * */ placeInfo: string | null | undefined; /** * */ placeDisplay: string | null | undefined; /** * */ includeInCharts: boolean | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class PlaceGroupDigestWeatherRankingResponse { /** * */ highWeatherLoad: number | null | undefined; /** * */ lowWeatherLoad: number | null | undefined; /** * */ averageWeatherLoad: number | null | undefined; /** * */ medianWeatherLoad: number | null | undefined; /** * */ highNonWeatherLoad: number | null | undefined; /** * */ lowNonWeatherLoad: number | null | undefined; /** * */ averageNonWeatherLoad: number | null | undefined; /** * */ medianNonWeatherLoad: number | null | undefined; /** * */ results: Array | null | undefined; /** * */ placeGroupId: number | null | undefined; /** * */ placeGroupCode: string | null | undefined; /** * */ placeGroupInfo: string | null | undefined; /** * This is the user's preferred way of viewing this entity - could be code or info based on the master \"data object view\" setting in DB */ placeGroupDisplay: string | null | undefined; /** * This will provide the benchmark unit eg:MMBTU/ft² or $/day */ benchmarkUnit: string | null | undefined; /** * This will provide the unit for the benchmarking factor eg:ft² or day */ benchmarkFactorUnit: string | null | undefined; /** * This will provide the unit for the benchmark value eg:$ for cost/day, MMBTU for annualized use/area */ benchmarkValueUnit: string | null | undefined; useUnit: UnitChild | null | undefined; costUnit: UnitChild | null | undefined; /** * The date and time the data was updated */ updated: Date | null | undefined; } /** * EnergyCAP SDK * Document used to generate the EnergyCAP SDK * * OpenAPI spec version: 8.2604 * Contact: support@energycap.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ declare class ProblemDetails { [key: string]: any | any; /** * */ type: string | null | undefined; /** * */ title: string | null | undefined; /** * */ status: number | null | undefined; /** * */ detail: string | null | undefined; /** * */ instance: string | null | undefined; } declare const BASE_PATH: InjectionToken; declare const COLLECTION_FORMATS: { csv: string; tsv: string; ssv: string; pipes: string; }; declare class EnergyCapSdkModule { static forConfig(configurationFactory: () => Configuration): ModuleWithProviders; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } export { APIS, AbnormalBillCostWithOutlierAnalysisSettingRequest, AbnormalBillCostWithOutlierAnalysisSettingResponse, AbnormalBillDemandWithOutlierAnalysisSettingRequest, AbnormalBillDemandWithOutlierAnalysisSettingResponse, AbnormalBillUseWithOutlierAnalysisSettingRequest, AbnormalBillUseWithOutlierAnalysisSettingResponse, AccountAlertRequest, AccountAlertResponse, AccountAuditEnable, AccountAuditSettingsRequest, AccountAuditSettingsResponse, AccountBillAccountChargeSplitSettingsResponse, AccountChild, AccountChildWithType, AccountCodeHistoryChild, AccountCodeHistoryRequest, AccountCodeHistoryResponse, AccountConnectionStatusResponse, AccountCreate, AccountDigestActualMonthlyResponse, AccountDigestActualMonthlyResponseCommodityData, AccountDigestActualMonthlyResponseCommodityResults, AccountDigestActualMonthlyResponseResults, AccountDigestActualYearlyResponse, AccountDigestActualYearlyResponseCommodityData, AccountDigestActualYearlyResponseCommodityResults, AccountDigestActualYearlyResponseResults, AccountDigestService, AccountEdit, AccountMeterChild, AccountMeterChildWithSerialNumber, AccountMeterEdit, AccountMeterRateResponse, AccountMeterRequest, AccountMeterResponse, AccountMeterService, AccountOrMeterUsage, AccountPeriodRequest, AccountPeriodResponse, AccountRateChild, AccountRateRequest, AccountRateResponse, AccountResponse, AccountService, AccountTemplateResponse, AccountTypeChild, AccountUDFResponse, AccountingSettings, AccountingSettingsClassPermission, AccountingSettingsRequest, AccountingSettingsResponse, Accounts, AccountsClassPermission, AccountsModule, AccountsModuleActualData, AccountsModuleActualDataClassPermission, AccountsModuleClassPermission, AccrualProcessorRequest, AccrualService, AccrualSettings, AccrualSettingsClassPermission, AccrualSettingsResponse, ActionableBillCounts, Activity, ActivityService, ActualVsBudgetResponse, AddressChild, AddressChildBase, AddressLookup, AdjustedCostTypeResponse, AdjustmentBaseMethodChild, AdminService, AdminSettingsRequest, AdminSettingsResponse, AggregatedComparisonResponseGHGPerformanceComparison, AggregatedItemRankResponse, AggregatedMonthlyCAPTrendResponse, AggregatedResponseGHGBuildingRank, AggregatedResponseItemRankWithUnitResponse, AllInstalledReports, AllInstalledReportsClassPermission, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyEditRequest, ApiKeyResponse, ApiKeyService, ApiService, ApiUser, ApplicationSettings, ApplicationSettingsClassPermission, ApprovalWorkflowChild, ApprovalWorkflowRequestChild, ApprovalWorkflowSettings, ApproveBills, ApproveBillsClassPermission, ArcadiaAccount, ArcadiaAccountCustomData, ArcadiaProvider, AreaNormalizedResponse, AssignVersionsToStep, AucRangeRequest, AucRangeResponse, AuditService, AuditSettingRequest, AuditSettingResponse, AuditSettingsRequest, AuditSettingsResponse, AuthenticationService, BASE_PATH, BaselineEngine, BaselineEngineClassPermission, BaselineLog, BaselineProcessorRequest, BaselineProcessorRequestBaselineBill, BaselineProcessorResponse, BaselineProcessorResponseBaselineBill, BatchChild, BatchCreate, BatchEdit, BatchLogResponse, BatchResponse, BatchService, BatchSettings, BatchWorkflowChild, BatchWorkflowSettings, BenchmarkCategoryResponse, BenchmarkEdit, BenchmarkSettingsEdit, BenchmarkSettingsResponse, BenchmarkValue, BenchmarkValueRequest, BenchmarkValuesResponse, BenchmarkWithUsedCountResponse, BillAccountBodyLineCreate, BillAccountBodyLineEdit, BillAccountChargeSplitMethodRequest, BillAccountChargeSplitMethodResponse, BillAccountChargeSplitService, BillAccountChargeSplitSettingResponse, BillAccountChargeSplitSettingsResponse, BillAccountMeterChild, BillAccountMeterResponse, BillAccountMeterStatisticsResponse, BillAccrualExclusionRequest, BillActionApprove, BillActionCustom, BillActionDelete, BillActionExportHold, BillActionHeaderUpdate, BillActionHistoricalExport, BillActionMove, BillActionMoveList, BillActionSplit, BillActionVoid, BillCAPture, BillCAPtureClassPermission, BillCalendarizedHistory, BillContainsLineItemDescriptionsSettingRequest, BillContainsLineItemDescriptionsSettingResponse, BillContainsLineItemTypesSettingRequest, BillContainsLineItemTypesSettingResponse, BillCreate, BillDeleteActionResult, BillEdit, BillEntryBodyLine, BillEntryBodyLineChild, BillEntryBodyLineWithNounChild, BillEntryMeterChild, BillEntryObservationTypeChild, BillEntryResponse, BillExport, BillExportOptions, BillHeaderChild, BillHeaderUpdate, BillHeaderUpdateAccountPeriodChild, BillHeaderUpdateBeginDateChild, BillHeaderUpdateBillingPeriodChild, BillHeaderUpdateControlCodeChild, BillHeaderUpdateDueDateChild, BillHeaderUpdateEndDateChild, BillHeaderUpdateEstimatedChild, BillHeaderUpdateInvoiceNumberChild, BillHeaderUpdateStatementDateChild, BillHeaderWorkflowChild, BillHistoryResponse, BillIdResponse, BillImportKickoutDetailsResponse, BillImportProfileColumnMapping, BillImportProfileObservation, BillImportProfileRequest, BillImportProfileResponse, BillImportRequest, BillImportTaskKickoutSummaryResponse, BillImportWorkflowSettings, BillKickoutImportRequest, BillLineTypeMappingResponse, BillListAdministrator, BillListAdministratorClassPermission, BillMeterBodyLineCreate, BillMeterBodyLineEdit, BillMeterCreate, BillMeterEdit, BillPaymentDetailsFileResponse, BillPaymentDetailsOptionalItem, BillPaymentDetailsOptionalItemWithErrors, BillPaymentDetailsOptionalResponse, BillPaymentEventCreate, BillPaymentEventResponse, BillResponse, BillReversal, BillReversalRequest, BillService, BillSignificantlyShorterOrLongerThanPreviousSettingRequest, BillSignificantlyShorterOrLongerThanPreviousSettingResponse, BillSplitDetailsRequest, BillSplitDetailsResponse, BillSplitParentDetailsResponse, BillSplitPlaceSizeChild, BillSplitService, BillUnexport, BillUnexportOptions, BillUsage, BillViewAccountChild, BillViewAddressChild, BillViewMeterChild, BillViewResponse, BillViewService, BillViewVendorChild, BillWorkflowSettings, BillWorkflowSettingsClassPermission, BillingPeriodCostUnitChild, BillingPeriodCostUnitDeltaChild, BillingPeriodUseCostChild, BillingPeriodUseCostDeltaChild, BillingPeriodUseUnitChild, BillingPeriodUseUnitDeltaChild, BillsAndBatches, BillsAndBatchesClassPermission, BillsModule, BillsModuleClassPermission, BillsOverdueFromVendorResponse, BodylineChild, BodylineResponse, BudgetCreate, BudgetDataType, BudgetEdit, BudgetPeriodType, BudgetResponse, BudgetService, BudgetUsageMethod, BudgetVersionCreate, BudgetVersionEdit, BudgetVersionResponse, BudgetVersionSummary, BudgetVersionSummaryResponse, BudgetsAndBudgetVersions, BudgetsAndBudgetVersionsClassPermission, BuildingAndMeterGroups, BuildingAndMeterGroupsClassPermission, BuildingsAndMetersModule, BuildingsAndMetersModuleActualData, BuildingsAndMetersModuleActualDataClassPermission, BuildingsAndMetersModuleBudgets, BuildingsAndMetersModuleBudgetsClassPermission, BuildingsAndMetersModuleCalendarizedData, BuildingsAndMetersModuleCalendarizedDataClassPermission, BuildingsAndMetersModuleClassPermission, BuildingsAndMetersModuleMeterIntervalData, BuildingsAndMetersModuleMeterIntervalDataClassPermission, BuildingsAndMetersModuleNormalizedData, BuildingsAndMetersModuleNormalizedDataClassPermission, BuildingsAndMetersModuleSavings, BuildingsAndMetersModuleSavingsClassPermission, BuildingsAndMetersModuleSustainability, BuildingsAndMetersModuleSustainabilityClassPermission, BuildingsAndOrganizations, BuildingsAndOrganizationsClassPermission, BulkBaselineProcessorRequest, BulkImportArcadiaCredentialRequest, BulkImportArcadiaCredentialsResponse, BulkMeterCostAvoidanceSettings, COLLECTION_FORMATS, CalculateSavingsRequest, CalculatedBillCostRequest, CalculatedBillCostResponse, CalculatedBillDemandRequest, CalculatedBillDemandResponse, CalculatedBillDetailsResponse, CalculatedBillService, CalculatedBillUseRequest, CalculatedBillUseResponse, CalculationRequest, CalculationResponse, CalendarizedCalculationRequest, CalendarizedCalculationResponse, CalendarizedSumRequest, CancellationToken, ChannelChild, ChannelChildWithObservationType, ChannelCreate, ChannelEdit, ChannelLatestReading, ChannelResponse, ChannelService, ChannelVersionRequest, ChannelVersionResponse, ChannelVersionWithBeginDateRequest, ChargebackEngineService, ChargebackProcessorSettings, ChargebackProcessorSettingsForAggregations, ChargebackProcessorSettingsForSplits, ChargebackProcessorSettingsWithoutFilters, ChargebackReversals, ChargebackReversalsClassPermission, ChargebackTaskRequest, ChargebackTaskResponse, ChargebackTaskService, ChargebackTaskVersionResponse, ChargebackWorkflowBase, ChargebackWorkflowCreate, ChargebackWorkflowDigestChild, ChargebackWorkflowDigestResponse, ChargebackWorkflowDigestSplitChild, ChargebackWorkflowEdit, ChargebackWorkflowResponse, ChargebackWorkflowService, ChargebackWorkflowSettings, ChargebackWorkflowStep, ChargebackWorkflowStepChild, ChargebackWorkflowStepCreate, ChargebackWorkflowStepEdit, Chargebacks, ChargebacksClassPermission, ChargebacksModule, ChargebacksModuleClassPermission, Claim, CollectionChild, CollectionEmissionSourceChild, CollectionRequest, CollectionResponse, CollectionService, Collections, CollectionsClassPermission, ColumnNumberOrOverrideValueNullableInt32, ColumnNumberOrOverrideValueString, CommodityCategory, CommodityCategoryChild, CommodityCategoryRequest, CommodityCategoryResponse, CommodityCategoryService, CommodityChild, CommodityChildWithCategory, CommodityDigestActualYearlyResponse, CommodityDigestActualYearlyResponseCommodityData, CommodityDigestActualYearlyResponseCommodityResults, CommodityDigestActualYearlyResponseResults, CommodityDigestService, CommodityEditRequest, CommodityRequest, CommodityResponse, CommodityService, CommoditySkipAuditSettingRequest, CommoditySkipAuditSettingResponse, CommodityValueComparison, Configuration, ContactChild, CopyFromMeterResponse, CopyMeterRequest, CostAvoidanceSettings, CostAvoidanceTask, CostCategoryEdit, CostCategoryResponse, CostCategoryService, CostCenterAccountChild, CostCenterChild, CostCenterCreate, CostCenterDigestActualMonthlyResponse, CostCenterDigestActualMonthlyResponseCommodityData, CostCenterDigestActualMonthlyResponseCommodityResults, CostCenterDigestActualMonthlyResponseResults, CostCenterDigestActualYearlyResponse, CostCenterDigestActualYearlyResponseCommodityData, CostCenterDigestActualYearlyResponseCommodityResults, CostCenterDigestActualYearlyResponseResults, CostCenterDigestService, CostCenterResponse, CostCenterService, CostCenters, CostCentersClassPermission, CostConversion, CostConversionBase, CostSavingsChild, CostSavingsUnit, Country, CountryService, CreateTemplateFromBill, CreateUtilityPlatformMeter, CustomerChild, CustomerResponse, CustomerService, DashboardAdministrator, DashboardAdministratorClassPermission, DashboardAndMapsModule, DashboardAndMapsModuleClassPermission, DashboardCopy, DashboardCreate, DashboardEdit, DashboardGlobalSettings, DashboardGlobalSettingsEdit, DashboardResponse, DashboardService, DataAccessRelease, DataAccessReleaseMetaData, DataAccessReleaseNoFileRequest, DataAccessReleaseRequest, DataAccessReleaseState, DataAccessReleaseStatus, DataPointChild, DataPointChildWithParentAndImportId, DataPointCreate, DataPointEdit, DataPointResponse, DataPointSentinel, DataPointService, DataTypeResponse, DateRange, DayOfWeek, DeleteReadingResponse, DestinationAccountMeterChild, DestinationAccountResponse, DetailedGuidResponse, DistributeAccountChargesBase, DistributeAccountChargesToBillsRequest, DistributedReportsConfiguration, DistributedReportsSettings, DistributedReportsSettingsClassPermission, DistributionVersionManage, DistributionVersionResponse, DueDateTooLongAfterBillEndSettingRequest, DueDateTooLongAfterBillEndSettingResponse, DynamicListRequest, DynamicPercentageBillSplit, DynamicPercentageBillSplitResponse, ENERGYSTARSubmissions, ENERGYSTARSubmissionsClassPermission, EditEsaPlaceSizesRequest, EmailProperties, EmissionRecordRequest, EmissionRecordResponse, EmissionRecordService, EmissionRecordType, EmissionSourceChild, EmissionSourceCreate, EmissionSourceEdit, EmissionSourceFactorCategoryBulkUpdate, EmissionSourceLink, EmissionSourceLinkRequest, EmissionSourceMultiFactorCreate, EmissionSourceMultiFactorEdit, EmissionSourceMultiFactorResponse, EmissionSourceResponse, EmissionSourceService, EmissionsSources, EmissionsSourcesClassPermission, EmissionsSourcesModule, EmissionsSourcesModuleClassPermission, EnergyCapOptionsEnergyCapIDOptions, EnergyCapSdkModule, EnergyManagerModule, EnergyManagerModuleClassPermission, EnergyManagerService, EnergyProjectCreate, EnergyProjectEdit, EnergyProjectPlaceChild, EnergyProjectResponse, EnergyProjectService, EnergyProjectType, EnergyProjectTypeCreate, EnergySavingsChild, EnergySavingsUnit, EnergyStarCommodityLinkChild, EnergyStarCommodityLinkRequest, EnergyStarCommodityMeterTypeMapping, EnergyStarCommodityMeterTypeMappingChild, EnergyStarMeterLinkChild, EnergyStarMeterLinkRequest, EnergyStarPlaceHierarchyResponse, EnergyStarPlaceLinkRequest, EnergyStarPlaceLinkResponse, EnergyStarPlaceMetricsRequest, EnergyStarPlaceMetricsResponse, EnergyStarPlaceSubmissionStatusChild, EnergyStarPlaceSubmissionStatusResponse, EnergyStarPmMeter, EnergyStarPmProperty, EnergyStarRatingChild, EnergyStarService, EnergyStarSettings, EnergyStarSettingsRequest, EnergyStarSettingsResponse, EnergyStarSubmissionPlaceChild, EnergyStarSubmissionRequest, EnergyStarTaskPlaceChild, EnergyStarTaskResponse, EntityScheduleSummary, Environment, EnvironmentService, EsaChannelChild, EsaChannelChildWithObservationType, EsaChannelCreate, EsaChannelEdit, EsaChannelResponse, EsaChannelService, EsaChannelVersionCreate, EsaChannelVersionCreateWithBeginDate, EsaChannelVersionEdit, EsaChannelVersionResponse, EsaDeleteReadingResponse, EsaDeleteReadingSummarizedResponse, EsaIntervalDataOverlay, EsaIntervalDataResponse, EsaPlaceCreate, EsaPlaceDataRollupRequest, EsaPlaceEdit, EsaPlaceResponse, EsaPlaceService, EsaPlaceSizeCreate, EsaReadingCreate, EsaReadingCreateError, EsaReadingCreateResponse, EsaReadingDelete, EsaReadingImportProfile, EsaReadingImportProfileColumn, EsaReadingImportProfileCreate, EsaReadingImportProfileEdit, EsaReadingImportProfileResponse, EsaReadingImportRequest, EsaReadingResponse, EsaReadingService, EsaReadingSummarizedDelete, EsaReadingSummarizedResponse, EsaReadingValue, EsaReadingValueError, EsaSentinelPrediction, EsaSentinelPredictionRequest, EsaSentinelPredictionResponse, EsaSentinelPredictionsResponse, Estimated, ExportBills, ExportBillsClassPermission, ExportFormatChild, ExportHold, ExportHoldClassPermission, ExportService, ExportWorkflowChild, ExportWorkflowSettings, FacilityProjects, FacilityProjectsClassPermission, FailedReadingResponse, FailedReadings, FileDataTypeResponse, FileStoreService, FilterDataResponse, FilterEdit, FilterResponse, FilterService, FixedAmountResponse, FixedDemandRequest, FixedPercentage, FixedPercentageResponse, FixedUnitCostRequest, FixedUseRequest, FlagActionChild, FlagEdit, FlagEventChild, FlagIssueActionChild, FlagIssueEdit, FlagIssueEditAction, FlagIssueEventChild, FlagIssueListAction, FlagIssueResponse, FlagIssueStatusChild, FlagIssueTypeChild, FlagListAction, FlagResponse, FlagService, FlagStatusChild, FlagTypeChild, FlagTypeCreate, FlagWidget, FlagWidgetChild, FlaggedItems, FlaggedItemsClassPermission, FloorAreaSplit, FloorAreaSplitResponse, FormTemplateChild, FormTemplateRequest, FormTemplateResponse, FormulaService, FormulaValidationRequest, FormulaValidationResponse, Frequency, GHGBuildingRank, GHGCarbonFootprintResponse, GHGDefaultFactor, GHGFactor, GHGFactorCategory, GHGFactorChild, GHGFactorRegion, GHGFactorResponse, GHGFactorVersionHistoryResponse, GHGFactorsResponse, GHGGas, GHGGroupEmissions, GHGPerformanceComparison, GHGScope, GHGScopeCategory, GHGScopeCategoryChild, GHGScopeResponse, GHGService, GHGSettingResponse, GHGSettings, GHGTargetEmissions, GHGTypeChild, GHGVersion, GHGYearlyEmissions, GHGasDefaultSettingRequest, GHGasDefaultSettingRequestCommodityChild, GHGasDefaultSettingRequestScopeCategoryAndFactorChild, GHGasDefaultSettingResponse, GHGasDefaultSettingResponseCommodityChild, GHGasFactorAndScopeCategoryPair, GHGasFactorAndScopeCategoryPairCreate, GHGasFactorChild, GHGasScopeCategoryChild, GLSubCodeChild, GLSubCodeChildRequest, GLSubcodeRequest, GLSubcodeResponse, GeneralLedgerChild, GeneralLedgerRequest, GeneralLedgerResponse, GeneralLedgerService, GenericBodylineRequest, GenericBodylineResponse, GenericCount, GlobalCostAvoidanceSettings, GlobalCostAvoidanceSettingsClassPermission, GreenhouseGasAdministrator, GreenhouseGasAdministratorClassPermission, GroupDisplaySetting, GroupMemberRequest, GroupMeterGroupResponse, GroupPlaceGroupMember, GroupPlaceGroupResponse, GroupsAndBenchmarksModule, GroupsAndBenchmarksModuleClassPermission, GuidResponse, HiddenRequest, HierarchicalCollections, HierarchicalCollections2, HierarchicalCostCenters, HierarchicalCostCenters2, HierarchicalDataPoint, HierarchicalEmissionSource, HierarchicalMeter, HierarchicalPlaces, HierarchicalPlaces2, HierarchicalSpaces, HierarchicalSpaces2, HierarchyService, HighPrecisionTimeSeriesValue, HighPrecisionValue, IActionResult, IGHGDefaultScopeCategoryAndFactor, IOutputFormatter, Icon, ImportService, IntervalData, IntervalDataAnalysis, IntervalDataAnalysisClassPermission, IntervalDataClassPermission, IntervalDataRollup, IntervalDataRollupClassPermission, ItemRankResponse, ItemRankWithUnitResponse, JsonBillExportAccount, JsonBillExportGeneralLedger, JsonBillExportLine, JsonBillExportMeter, JsonBillExportPlace, JsonBillExportResponse, JsonBillExportVendor, KickoutField, KickoutValue, LatestBenchmarkValue, LicenseFeatureAccountingExport, LicenseFeatureAccrualBills, LicenseFeatureBillCAPtureManagedServices, LicenseFeatureBillCapturePostPay, LicenseFeatureBillCapturePrePay, LicenseFeatureBudgets, LicenseFeatureCarbonHub, LicenseFeatureChargebacks, LicenseFeatureCostAvoidance, LicenseFeatureCustomBenchmarks, LicenseFeatureEnergyCAPPayments, LicenseFeatureGhg, LicenseFeatureGhgPremium, LicenseFeatureIntervalData, LicenseFeatureIntervalDataAnalysis, LicenseFeatureLegacyGHG, LicenseFeatureNonEnglishBills, LicenseFeatureReportDesigner, LicenseFeatureReportDistribution, LicenseFeatureUIDI, LicenseFeatureVendorManagementServices, LicenseFeatures, LicenseRequest, LicenseResponse, LicenseUsage, LinkSubAccountsFilters, LinkSubAccountsRequest, ListActionAccrualExclusion, ListActionApprove, ListActionCustom, ListActionExportHold, ListActionReverse, ListActionVoid, ListColumnEdit, ListCopy, ListCreate, ListCreateResponse, ListEdit, ListIds, ListResponse, ListResponseListField, ListResponseListItem, ListService, ListTypeChild, LoginRequest, LoginResponse, ManualAdjustmentRequest, ManuallyAdjustSavings, ManuallyAdjustSavingsClassPermission, ManufacturerChild, MapDashboardSettingsRequest, MapDashboardSettingsResponse, MapPlaceChild, MapWidgetResponse, Me, MeRequest, MeService, Message, MeterAccountChild, MeterActionCreateEmissionSource, MeterBillResponse, MeterCAPResponse, MeterCalendarizedUseVsWeatherResponse, MeterCategoryRequest, MeterCategoryResponse, MeterChild, MeterChildIncludeMeterImportIdAndRoute, MeterChildIncludePlace, MeterChildIncludePlaceAndSerialNumber, MeterChildIncludePlaceChannelLatestReading, MeterChildSearch, MeterCost, MeterCreate, MeterDigestActualAndCalendarizedMonthlyResponse, MeterDigestActualAndCalendarizedMonthlyResponseResults, MeterDigestActualAndCalendarizedYearlyResponse, MeterDigestActualAndCalendarizedYearlyResponseResults, MeterDigestCalendarizedTrendResponse, MeterDigestCalendarizedTrendResponseResults, MeterDigestNormalizedMonthlyResponse, MeterDigestNormalizedMonthlyResponseResults, MeterDigestNormalizedYearlyResponse, MeterDigestNormalizedYearlyResponseResults, MeterDigestSavingsMonthlyResponse, MeterDigestSavingsMonthlyResponseResults, MeterDigestSavingsYearlyResponse, MeterDigestSavingsYearlyResponseResults, MeterDigestService, MeterEdit, MeterGroupCategoryChild, MeterGroupChild, MeterGroupDigestChild, MeterGroupDigestDemandRankingChild, MeterGroupDigestDemandRankingResponse, MeterGroupDigestRankingChild, MeterGroupDigestRankingResponse, MeterGroupDigestService, MeterGroupMember, MeterGroupMemberChild, MeterGroupRequest, MeterGroupResponse, MeterGroupService, MeterLink, MeterLinkRequest, MeterRateResponse, MeterResponse, MeterSavingsSettings, MeterSavingsSettingsClassPermission, MeterSearchRequest, MeterSerialNumberHistoryChild, MeterSerialNumberHistoryRequest, MeterSerialNumberHistoryResponse, MeterService, MeterTemplateResponse, MeterTypeChild, MeterUDFResponse, Meters, MetersClassPermission, MissingBillWidget, ModelVoid, MonthlyCAPTrend, MonthlyTimeSeriesValue, MostRecentAggregate, MoveAccountsBetweenVendors, MoveAccountsBetweenVendorsClassPermission, MoveBillsDestination, MoveCreateMeter, MoveExistingBills, MoveExistingBillsClassPermission, NamedPeriod, NormalizationSettings, NormalizationSettingsClassPermission, NotificationActionButtonResponse, NotificationBadgeResponse, NotificationCategory, NotificationDetailsResponse, NotificationResponse, NotificationService, NotificationSettingRequest, NotificationSettingResponse, NotificationSettingsResponse, NotificationSystemSettingsRequest, NotificationType, NotificationUpdateRequest, ObservationMethodChild, ObservationRule, ObservationService, ObservationType, ObservationTypeChild, ObservationTypeChildBase, ObservationTypeService, OkObjectResult, OkResult, OptionalUpdateNullableDateOnly, OptionalUpdateNullableDecimal, OptionalUpdateNullableInt32, OptionalUpdateString, OtherSavingsCategory, OtherSavingsCategoryRequest, OtherSavingsRequest, OtherSavingsResponse, OutlierSeverityChild, PeriodComparison, PeriodRange, PeriodRangeComparison, PeriodRangeComparisonDetailed, PermissionProduct, Permissions, PermissionsRequest, PlaceBenchmarkService, PlaceCategoryRequest, PlaceCategoryResponse, PlaceChild, PlaceChildWithFloorArea, PlaceCost, PlaceCreate, PlaceDigestActualAndCalendarizedMonthlyResponse, PlaceDigestActualAndCalendarizedMonthlyResponseCommodityData, PlaceDigestActualAndCalendarizedMonthlyResponseCommodityResults, PlaceDigestActualAndCalendarizedMonthlyResponseResults, PlaceDigestActualAndCalendarizedYearlyResponse, PlaceDigestActualAndCalendarizedYearlyResponseCommodityData, PlaceDigestActualAndCalendarizedYearlyResponseCommodityResults, PlaceDigestActualAndCalendarizedYearlyResponseResults, PlaceDigestActualAndCalendarizedYearlyResponseTargetComparison, PlaceDigestComparisonResponse, PlaceDigestEnergyUseIntensity, PlaceDigestEnergyUseIntensityEuiCommodity, PlaceDigestEnergyUseIntensityEuiEnergyProject, PlaceDigestGHGYearlyResponse, PlaceDigestGHGYearlyResponseGHGScope, PlaceDigestGHGYearlyResponseGHGType, PlaceDigestGHGYearlyResponseResults, PlaceDigestGHGYearlyResponseTargetComparison, PlaceDigestNormalizedCommodityTargetComparisonMonthly, PlaceDigestNormalizedCommodityTargetComparisonMonthlyCommodityResults, PlaceDigestNormalizedMonthlyResponse, PlaceDigestNormalizedMonthlyResponseCommodityData, PlaceDigestNormalizedMonthlyResponseCommodityResults, PlaceDigestNormalizedMonthlyResponseResults, PlaceDigestNormalizedTargetComparisonMonthly, PlaceDigestNormalizedTargetComparisonMonthlyResults, PlaceDigestNormalizedYearlyResponse, PlaceDigestNormalizedYearlyResponseCommodityData, PlaceDigestNormalizedYearlyResponseCommodityResults, PlaceDigestNormalizedYearlyResponseResults, PlaceDigestNormalizedYearlyResponseTargetComparison, PlaceDigestSavingsMonthlyResponse, PlaceDigestSavingsMonthlyResponseCommodityData, PlaceDigestSavingsMonthlyResponseCommodityDataCommodityResults, PlaceDigestSavingsMonthlyResponseResults, PlaceDigestSavingsYearlyResponse, PlaceDigestSavingsYearlyResponseCommodityData, PlaceDigestSavingsYearlyResponseCommodityDataCommodityResults, PlaceDigestSavingsYearlyResponseResults, PlaceDigestService, PlaceDigestTargetComparisonMonthly, PlaceDigestTargetComparisonMonthlyResults, PlaceEdit, PlaceEntityType, PlaceGroupCategoryChild, PlaceGroupChild, PlaceGroupDigestAreaDemandRankingResponse, PlaceGroupDigestAreaRankingChild, PlaceGroupDigestBenchmarkRankingChild, PlaceGroupDigestBenchmarkRankingResponse, PlaceGroupDigestChild, PlaceGroupDigestService, PlaceGroupDigestWeatherRankingChild, PlaceGroupDigestWeatherRankingResponse, PlaceGroupMember, PlaceGroupRequest, PlaceGroupResponse, PlaceGroupService, PlaceInfo, PlaceResponse, PlaceService, PlaceSizeChild, PlaceSizeCreate, PlaceSizeResponse, PlaceSubmissionTypeRequest, PlaceTypeRequest, PlaceTypeResponse, PlaceUDFResponse, PmCommodityChild, PostalCodeResponse, PostalCodeResponseWeatherStation, PostalCodeService, Preference, PreferenceRequest, PrimaryUseChild, PrimaryUseCreate, PrimaryUseResponse, PrimaryUseService, ProblemDetails, Product, ProjectManagerResponse, PublicDashboardsOrMaps, PublicDashboardsOrMapsClassPermission, QuickFilter, QuickReport, RateChild, RateChildResponse, RateCreate, RateDigestActualYearlyResponse, RateDigestActualYearlyResponseCommodityData, RateDigestActualYearlyResponseCommodityResults, RateDigestActualYearlyResponseResults, RateDigestService, RateEdit, RateResponse, RateSchedules, RateSchedulesClassPermission, RateService, RateVersionRequest, RateVersionResponse, Reading, ReadingChildBase, ReadingCreate, ReadingDelete, ReadingImportProfile, ReadingImportProfileColumn, ReadingImportProfileRequest, ReadingImportProfileResponse, ReadingImportRequest, ReadingResponse, Readings, ReadingsObservation, RecordImportProfile, RecordImportProfileEdit, RecordImportProfileRequest, RecordImportProfileResponse, RecordImportRequest, Records, RecordsClassPermission, RecordsListAdministrator, RecordsListAdministratorClassPermission, RecordsModule, RecordsModuleClassPermission, RelatedReportResponse, ReportAdministrator, ReportAdministratorClassPermission, ReportBuilderService, ReportCategoryChild, ReportChild, ReportCreate, ReportDistributionChild, ReportDistributionCreateRequest, ReportDistributionDetailsResponse, ReportDistributionEditRequest, ReportDistributionEmailSettings, ReportDistributionLogDetailsResponse, ReportDistributionLogEmailSettings, ReportDistributionLogReportSettings, ReportDistributionLogResponse, ReportDistributionService, ReportEdit, ReportGroupChildResponse, ReportGroupRequest, ReportGroupResponse, ReportGroups, ReportGroupsClassPermission, ReportService, ReportSubscriptionChild, ReportSubscriptionDayIndicatorChild, ReportSubscriptionRequest, ReportSubscriptionScheduleTypeChild, ReportSubscriptionScheduleTypeResponse, ReportType, ReportingSettingRequest, ReportingSettingResponse, Reports, ReportsClassPermission, ReportsModule, ReportsModuleClassPermission, RequiredAddressChild, ResetUserPasswords, ResetUserPasswordsClassPermission, ReversalBatchSettings, Reviewed, Roles, RolesClassPermission, RollingComparisonDetail, RollingComparisonPeriodValue, RollingComparisonResponse, RollupUnitUpdate, RollupUnitUpdateCommonUnit, RouteChild, RouteDetailsResponse, RouteMeter, RouteMeterChannelLatestReadingResponse, RouteRequest, RouteResponse, RouteService, SafeWaitHandle, SavingsAdjustments, SavingsAdjustmentsClassPermission, SavingsDailyData, SavingsEngine, SavingsEngineClassPermission, SavingsLog, SavingsMeterBillDailyResponse, SavingsMeterBillResponse, SavingsService, ScheduleChild, ScheduleCreate, ScheduleDay, ScheduleDayCreate, ScheduleEdit, ScheduleResponse, ScheduleService, ScheduleWithEntitySummaries, SearchAccountChild, SearchAccountChildSearchAccountChild, SearchAccountMeterBillEntry, SearchBillChild, SearchBillChildSearchBillAccountChild, SearchBillChildSearchBillChild, SearchCollectionChild, SearchCollectionChildSearchCollection, SearchCostCenterChild, SearchCostCenterChildSearchCostCenter, SearchEmissionSourceChild, SearchEmissionSourceChildSearchEmissionSource, SearchMeterChild, SearchMeterChildSearchMeterChild, SearchParentPlaceChild, SearchPlaceChild, SearchPlaceChildSearchPlaceChild, SearchPlaceGroup, SearchResponse, SearchService, SearchVendorChild, SearchVendorChildSearchVendorChild, SendDataAccessReleaseRequest, SendNotifications, SendNotificationsClassPermission, SentinelService, Setup, SetupService, ShareRequest, ShareResponse, SharedBillLists, SharedBillListsClassPermission, SharedDashboardsOrMaps, SharedDashboardsOrMapsClassPermission, SharedRecordsLists, SharedRecordsListsClassPermission, SharedReports, SharedReportsClassPermission, SingleBoolean, SingleValue, SourceBatchLogResponse, SpanClasspropertyinfoPaginatedPaginatedspanService, SpanClasspropertyinfoPermissionPermissionsAccountingSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsAccountsCreatespanService, SpanClasspropertyinfoPermissionPermissionsAccountsDeletespanService, SpanClasspropertyinfoPermissionPermissionsAccountsEditspanService, SpanClasspropertyinfoPermissionPermissionsAccountsViewspanService, SpanClasspropertyinfoPermissionPermissionsAccrualSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsAccrualSettingsRunspanService, SpanClasspropertyinfoPermissionPermissionsAccrualSettingsViewspanService, SpanClasspropertyinfoPermissionPermissionsApplicationSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsApplicationSettingsViewspanService, SpanClasspropertyinfoPermissionPermissionsApproveBillsManagespanService, SpanClasspropertyinfoPermissionPermissionsBaselineEngineRunspanService, SpanClasspropertyinfoPermissionPermissionsBillCAPtureViewspanService, SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsBillWorkflowSettingsViewspanService, SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesCreatespanService, SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesDeletespanService, SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesEditspanService, SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesManagespanService, SpanClasspropertyinfoPermissionPermissionsBillsAndBatchesViewspanService, SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsCreatespanService, SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsDeletespanService, SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsEditspanService, SpanClasspropertyinfoPermissionPermissionsBudgetsAndBudgetVersionsViewspanService, SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsCreatespanService, SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsDeletespanService, SpanClasspropertyinfoPermissionPermissionsBuildingAndMeterGroupsEditspanService, SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsCreatespanService, SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsDeletespanService, SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsEditspanService, SpanClasspropertyinfoPermissionPermissionsBuildingsAndOrganizationsViewspanService, SpanClasspropertyinfoPermissionPermissionsChargebackReversalsManagespanService, SpanClasspropertyinfoPermissionPermissionsChargebacksManagespanService, SpanClasspropertyinfoPermissionPermissionsChargebacksModuleViewspanService, SpanClasspropertyinfoPermissionPermissionsChargebacksRunspanService, SpanClasspropertyinfoPermissionPermissionsCollectionsCreatespanService, SpanClasspropertyinfoPermissionPermissionsCollectionsDeletespanService, SpanClasspropertyinfoPermissionPermissionsCollectionsEditspanService, SpanClasspropertyinfoPermissionPermissionsCollectionsViewspanService, SpanClasspropertyinfoPermissionPermissionsCostCentersCreatespanService, SpanClasspropertyinfoPermissionPermissionsCostCentersDeletespanService, SpanClasspropertyinfoPermissionPermissionsCostCentersEditspanService, SpanClasspropertyinfoPermissionPermissionsCostCentersViewspanService, SpanClasspropertyinfoPermissionPermissionsDashboardAndMapsModuleViewspanService, SpanClasspropertyinfoPermissionPermissionsDistributedReportsSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsManagespanService, SpanClasspropertyinfoPermissionPermissionsENERGYSTARSubmissionsRunspanService, SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesCreatespanService, SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesDeletespanService, SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesEditspanService, SpanClasspropertyinfoPermissionPermissionsEmissionsSourcesViewspanService, SpanClasspropertyinfoPermissionPermissionsEnergyManagerModuleViewspanService, SpanClasspropertyinfoPermissionPermissionsExportBillsRunspanService, SpanClasspropertyinfoPermissionPermissionsExportHoldManagespanService, SpanClasspropertyinfoPermissionPermissionsFacilityProjectsCreatespanService, SpanClasspropertyinfoPermissionPermissionsFacilityProjectsDeletespanService, SpanClasspropertyinfoPermissionPermissionsFacilityProjectsEditspanService, SpanClasspropertyinfoPermissionPermissionsFlaggedItemsManagespanService, SpanClasspropertyinfoPermissionPermissionsFlaggedItemsViewspanService, SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsGlobalCostAvoidanceSettingsViewspanService, SpanClasspropertyinfoPermissionPermissionsGroupsAndBenchmarksModuleViewspanService, SpanClasspropertyinfoPermissionPermissionsIntervalDataManagespanService, SpanClasspropertyinfoPermissionPermissionsLicenseFeatureIntervalDataAnalysisViewspanService, SpanClasspropertyinfoPermissionPermissionsManuallyAdjustSavingsManagespanService, SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsMeterSavingsSettingsViewspanService, SpanClasspropertyinfoPermissionPermissionsMetersCreatespanService, SpanClasspropertyinfoPermissionPermissionsMetersDeletespanService, SpanClasspropertyinfoPermissionPermissionsMetersEditspanService, SpanClasspropertyinfoPermissionPermissionsMetersViewspanService, SpanClasspropertyinfoPermissionPermissionsMoveAccountsBetweenVendorsManagespanService, SpanClasspropertyinfoPermissionPermissionsMoveExistingBillsManagespanService, SpanClasspropertyinfoPermissionPermissionsPublicDashboardsOrMapsManagespanService, SpanClasspropertyinfoPermissionPermissionsRateSchedulesCreatespanService, SpanClasspropertyinfoPermissionPermissionsRateSchedulesDeletespanService, SpanClasspropertyinfoPermissionPermissionsRateSchedulesEditspanService, SpanClasspropertyinfoPermissionPermissionsRecordsCreatespanService, SpanClasspropertyinfoPermissionPermissionsRecordsDeletespanService, SpanClasspropertyinfoPermissionPermissionsRecordsEditspanService, SpanClasspropertyinfoPermissionPermissionsRecordsViewspanService, SpanClasspropertyinfoPermissionPermissionsReportAdministratorManagespanService, SpanClasspropertyinfoPermissionPermissionsReportGroupsManagespanService, SpanClasspropertyinfoPermissionPermissionsReportsRunspanService, SpanClasspropertyinfoPermissionPermissionsRolesManagespanService, SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsManagespanService, SpanClasspropertyinfoPermissionPermissionsSavingsAdjustmentsViewspanService, SpanClasspropertyinfoPermissionPermissionsSavingsEngineRunspanService, SpanClasspropertyinfoPermissionPermissionsUnitSystemSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsManagespanService, SpanClasspropertyinfoPermissionPermissionsUsersAndUserGroupsViewspanService, SpanClasspropertyinfoPermissionPermissionsVendorsAndRatesModuleViewspanService, SpanClasspropertyinfoPermissionPermissionsVendorsCreatespanService, SpanClasspropertyinfoPermissionPermissionsVendorsDeletespanService, SpanClasspropertyinfoPermissionPermissionsVendorsEditspanService, SpanClasspropertyinfoPermissionPermissionsWeatherSettingsManagespanService, SpanClasspropertyinfoPermissionPermissionsWeatherSettingsViewspanService, SpecialAdjustmentCreate, SpecialAdjustmentEdit, SpecialAdjustmentMethod, SpecialAdjustmentResponse, SpecialAdjustmentType, SpecificReportResponse, SpecificWidgetResponse, StatementDateTooLongAfterBillEndSettingRequest, StatementDateTooLongAfterBillEndSettingResponse, StatisticsResponse, SubmissionTypeResponse, SubtractRequest, SubtractResponse, SumRequest, SumResponse, SummarizationMethod, SummaryAccountService, SystemSettingsRequest, SystemSettingsResponse, SystemUserRoleChild, SystemUserRoleResponse, SystemUserRoleWithHiddenRequest, SystemUserService, TagChild, TagResponse, TagService, Target, TargetBatchLogResponse, TargetSettings, TaskChild, TaskEdit, TaskResponse, TaskService, TaskType, TemperatureResponse, TemplateChild, TemplateLine, TemplateResponse, TemplateService, TemplateVendorLineRequest, TemplateVersion, TimeFormatResponse, TimeSeriesDataResponse, TimeSeriesEntity, TimeSeriesEntitySummary, TimeSeriesSummary, TimeSeriesValue, TimeZoneChild, TimeZoneResponse, TimeZoneService, ToggleVisible, TooManyConsecutiveEstimatedBillsSettingRequest, TooManyConsecutiveEstimatedBillsSettingResponse, TopmostCollection, TopmostCostCenter, TopmostPlace, TopmostSpace, TotalBillCostDoesNotMatchLineItemTypesSettingRequest, TotalBillCostDoesNotMatchLineItemTypesSettingResponse, TrendDataResponse, TrendTarget, UDFCreate, UDFEdit, UDFFieldChild, UDFResponse, UDFSelectValueCreate, UDFSelectValueEdit, UDFSelectValueEntityResponse, UDFSelectValueResponse, UDFSelectValueUpdate, UDFService, UDFUpdate, UDFValue, Unit, UnitChild, UnitResponse, UnitService, UnitSystemSettings, UnitSystemSettingsClassPermission, UnitType, UpdateApprovedBills, UpdateApprovedBillsClassPermission, UpdateBatchStatusRequest, UpdateResult, UpdateSkippedResult, UpdateUnitsOnExistingBills, UpdateUnitsOnExistingBillsClassPermission, UpdatedOnlyResult, UpsertAggregateMeterRequest, UserChild, UserChildWithEmail, UserCreateRequest, UserEditRequest, UserGroupChild, UserGroupRequest, UserGroupResponse, UserGroupService, UserGroupWithMembers, UserResponse, UserRoleRequest, UserRoleService, UsersAndRoles, UsersAndRolesClassPermission, UsersAndUserGroups, UsersAndUserGroupsClassPermission, UtilityPlatform, UtilityPlatformMeter, UtilityPlatformService, ValueComparison, ValueWithUnit, VemChatCreate, VemChatEdit, VemChatMessageCreate, VemChatMessageResponse, VemChatResponse, VendorAuditEnable, VendorBillAccountChargeSplitSettingsResponse, VendorChild, VendorContractResponse, VendorDigestActualYearlyResponse, VendorDigestActualYearlyResponseCommodityData, VendorDigestActualYearlyResponseCommodityResults, VendorDigestActualYearlyResponseResults, VendorDigestService, VendorEdit, VendorRequest, VendorResponse, VendorService, VendorTypeChild, VendorUDFResponse, Vendors, VendorsAndRatesModule, VendorsAndRatesModuleClassPermission, VendorsClassPermission, VersionChild, VersionResponse, WaitHandle, WatticsDataPoint, WatticsDataPointChild, WatticsDataPointRequest, WatticsSite, WatticsSiteRequest, WeatherImportResult, WeatherImportSettings, WeatherSettings, WeatherSettingsClassPermission, WeatherStationChild, WeatherStationResponse, WeatherStationService, WeatherStationSummary, WebCaptureAccountResponse, WebCaptureCredentialDetailsResponse, WebCaptureCredentialResponse, WebCaptureCredentialService, WebCapturePartnerResponse, WebhookCreateRequest, WebhookCustomAction, WebhookEditRequest, WebhookEventTypeChild, WebhookLogDetailsResponse, WebhookLogResponse, WebhookResponse, WebhookService, WidgetCreate, WidgetEdit, WidgetResponse, WidgetSavingsYearlyResponse, WidgetSavingsYearlyResponseCommodityData, WidgetSavingsYearlyResponseResults, WidgetService, WorkflowDisplaySetting, WorkflowService, WorkflowSettingsRequest, WorkflowSettingsResponse, YearRange }; export type { ConfigurationParameters };