From 41e17ae7af40a5d92ec353990f088f63147b2087 Mon Sep 17 00:00:00 2001 From: publish-bot-solcast Date: Thu, 20 Nov 2025 22:16:32 +0000 Subject: [PATCH] CI: Update generated SDK for prod on 2025-11-20 --- src/Solcast/Clients/ForecastClient.cs | 48 +++++++++---------- src/Solcast/Clients/HistoricClient.cs | 30 ++++++------ src/Solcast/Clients/LiveClient.cs | 34 ++++++------- .../Models/Responses/GetForecastHsuLosses.cs | 30 ++++++------ .../Responses/GetForecastKimberLosses.cs | 14 +++--- .../Models/Responses/GetHistoricHsuLosses.cs | 18 +++---- .../Responses/GetHistoricKimberLosses.cs | 12 ++--- .../Models/Responses/GetLiveHsuLosses.cs | 20 ++++---- .../Models/Responses/GetLiveKimberLosses.cs | 14 +++--- 9 files changed, 110 insertions(+), 110 deletions(-) diff --git a/src/Solcast/Clients/ForecastClient.cs b/src/Solcast/Clients/ForecastClient.cs index 1e8e7d8..5667e37 100644 --- a/src/Solcast/Clients/ForecastClient.cs +++ b/src/Solcast/Clients/ForecastClient.cs @@ -377,20 +377,20 @@ public async Task> GetForecastRadiationAndWea } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// The number of hours to return in the response. - /// Length of the averaging period in ISO 8601 format. - /// Deposition Velocity for PM10. - /// Deposition Velocity for PM2.5. - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// The number of hours to return in the response. Default is 24. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// The angle (degrees) that the PV system is tilted off the horizontal. A tilt of 0 means the system faces directly upwards, and 90 means the system is vertical and facing the horizon. If you don't specify tilt, we use a default tilt angle based on the latitude you specify in your request. Must be between 0 and 90. - /// Amount of daily rainfall required to clean the panels (mm). Defaults to 6.0mm - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. /// Restricted. Specifies the period of time to sum rain fall data. Internally this value is set to 24 hours in line with the findings of https://ieeexplore.ieee.org/document/4060159 . /// Restricted. List of rainfall values. HSU endpoint will internally use Solcast's percepitation rate values tailored to your request time period. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. - /// Response format + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. + /// Response format (json, csv). Default is json. public async Task> GetForecastHsu( double? latitude, double? longitude, @@ -398,9 +398,9 @@ public async Task> GetForecastHsu( int? hours = null, string period = null, double? depoVelocPm10 = null, - double? depoVelocPm2.5 = null, + double? depoVelocPm25 = null, List pm10 = null, - List pm2.5 = null, + List pm25 = null, double? tilt = null, double? cleaningThreshold = null, double? initialSoiling = null, @@ -419,9 +419,9 @@ public async Task> GetForecastHsu( if (hours.HasValue) parameters.Add("hours", hours.Value.ToString()); if (period != null) parameters.Add("period", period.ToString()); if (depoVelocPm10.HasValue) parameters.Add("depoVelocPm10", depoVelocPm10.Value.ToString()); - if (depoVelocPm2.5.HasValue) parameters.Add("depoVelocPm2.5", depoVelocPm2.5.Value.ToString()); + if (depoVelocPm25.HasValue) parameters.Add("depoVelocPm25", depoVelocPm25.Value.ToString()); if (pm10 != null) parameters.Add("pm10", pm10.ToString()); - if (pm2.5 != null) parameters.Add("pm2.5", pm2.5.ToString()); + if (pm25 != null) parameters.Add("pm25", pm25.ToString()); if (tilt.HasValue) parameters.Add("tilt", tilt.Value.ToString()); if (cleaningThreshold.HasValue) parameters.Add("cleaningThreshold", cleaningThreshold.Value.ToString()); if (initialSoiling.HasValue) parameters.Add("initialSoiling", initialSoiling.Value.ToString()); @@ -462,7 +462,7 @@ public async Task> GetForecastHsu( } catch (HttpRequestException httpEx) { - var paramDetails = "latitude=" + latitude + ", " + "longitude=" + longitude + ", " + "timeZone=" + timeZone + ", " + "hours=" + hours + ", " + "period=" + period + ", " + "depoVelocPm10=" + depoVelocPm10 + ", " + "depoVelocPm2.5=" + depoVelocPm2.5 + ", " + "pm10=" + pm10 + ", " + "pm2.5=" + pm2.5 + ", " + "tilt=" + tilt + ", " + "cleaningThreshold=" + cleaningThreshold + ", " + "initialSoiling=" + initialSoiling + ", " + "rainAccumPeriod=" + rainAccumPeriod + ", " + "rainfall=" + rainfall + ", " + "manualWashDates=" + manualWashDates + ", " + "format=" + format; + var paramDetails = "latitude=" + latitude + ", " + "longitude=" + longitude + ", " + "timeZone=" + timeZone + ", " + "hours=" + hours + ", " + "period=" + period + ", " + "depoVelocPm10=" + depoVelocPm10 + ", " + "depoVelocPm25=" + depoVelocPm25 + ", " + "pm10=" + pm10 + ", " + "pm25=" + pm25 + ", " + "tilt=" + tilt + ", " + "cleaningThreshold=" + cleaningThreshold + ", " + "initialSoiling=" + initialSoiling + ", " + "rainAccumPeriod=" + rainAccumPeriod + ", " + "rainfall=" + rainfall + ", " + "manualWashDates=" + manualWashDates + ", " + "format=" + format; var status = httpEx.StatusCode.HasValue ? ((int)httpEx.StatusCode).ToString() : "unknown"; var content = httpEx.Data.Contains("Content") ? httpEx.Data["Content"] : "no content"; throw new Exception($@"HTTP error in GetForecastHsu @@ -473,7 +473,7 @@ public async Task> GetForecastHsu( } catch (Exception ex) { - var paramDetails = "latitude=" + latitude + ", " + "longitude=" + longitude + ", " + "timeZone=" + timeZone + ", " + "hours=" + hours + ", " + "period=" + period + ", " + "depoVelocPm10=" + depoVelocPm10 + ", " + "depoVelocPm2.5=" + depoVelocPm2.5 + ", " + "pm10=" + pm10 + ", " + "pm2.5=" + pm2.5 + ", " + "tilt=" + tilt + ", " + "cleaningThreshold=" + cleaningThreshold + ", " + "initialSoiling=" + initialSoiling + ", " + "rainAccumPeriod=" + rainAccumPeriod + ", " + "rainfall=" + rainfall + ", " + "manualWashDates=" + manualWashDates + ", " + "format=" + format; + var paramDetails = "latitude=" + latitude + ", " + "longitude=" + longitude + ", " + "timeZone=" + timeZone + ", " + "hours=" + hours + ", " + "period=" + period + ", " + "depoVelocPm10=" + depoVelocPm10 + ", " + "depoVelocPm25=" + depoVelocPm25 + ", " + "pm10=" + pm10 + ", " + "pm25=" + pm25 + ", " + "tilt=" + tilt + ", " + "cleaningThreshold=" + cleaningThreshold + ", " + "initialSoiling=" + initialSoiling + ", " + "rainAccumPeriod=" + rainAccumPeriod + ", " + "rainfall=" + rainfall + ", " + "manualWashDates=" + manualWashDates + ", " + "format=" + format; throw new Exception($@"Unhandled error in GetForecastHsu Parameters: {paramDetails} Error: {ex.Message}", ex); @@ -481,16 +481,16 @@ public async Task> GetForecastHsu( } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// The number of hours to return in the response. - /// Length of the averaging period in ISO 8601 format. - /// Amount of daily rainfall required to clean the panels (mm) + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// The number of hours to return in the response. Default is 24. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// Percentage of energy lost due to one day of soiling. /// Number of days after a rainfall event when it’s assumed the ground is damp, and so it’s assumed there is no soiling. /// Maximum percentage of energy lost due to soiling. Soiling will build up until this value. - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. - /// Response format + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. + /// Response format (json, csv). Default is json. public async Task> GetForecastKimber( double? latitude, double? longitude, diff --git a/src/Solcast/Clients/HistoricClient.cs b/src/Solcast/Clients/HistoricClient.cs index 5c50b40..88fc7f4 100644 --- a/src/Solcast/Clients/HistoricClient.cs +++ b/src/Solcast/Clients/HistoricClient.cs @@ -331,19 +331,19 @@ public async Task> GetHistoricRooftopPvPowe } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// Length of the averaging period in ISO 8601 format. - /// Deposition Velocity for PM10. - /// Deposition Velocity for PM2.5. - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// The angle (degrees) that the PV system is tilted off the horizontal. A tilt of 0 means the system faces directly upwards, and 90 means the system is vertical and facing the horizon. If you don't specify tilt, we use a default tilt angle based on the latitude you specify in your request. Must be between 0 and 90. /// ISO_8601 compliant starting datetime for the historical data. If the supplied value does not specify a timezone, the timezone will be inferred from the time_zone parameter, if supplied. Otherwise UTC is assumed. /// Must include one of end_date and duration. ISO_8601 compliant duration for the historical data. Must be within 31 days of the start_date. /// Must include one of end_date and duration. ISO_8601 compliant ending datetime for the historical data. Must be within 31 days of the start_date. If the supplied value does not specify a timezone, the timezone will be inferred from the time_zone parameter, if supplied. Otherwise UTC is assumed. - /// Amount of daily rainfall required to clean the panels (mm) - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// Restricted. Specifies the period of time to sum rain fall data. Internally this value is set to 24 hours in line with the findings of https://ieeexplore.ieee.org/document/4060159 . /// Restricted. List of rainfall values. HSU endpoint will internally use Solcast's percepitation rate values tailored to your request time period. /// Response format @@ -441,18 +441,18 @@ public async Task> GetHistoricHsu( } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// Length of the averaging period in ISO 8601 format. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// ISO_8601 compliant starting datetime for the historical data. If the supplied value does not specify a timezone, the timezone will be inferred from the time_zone parameter, if supplied. Otherwise UTC is assumed. /// Must include one of end_date and duration. ISO_8601 compliant duration for the historical data. Must be within 31 days of the start_date. /// Must include one of end_date and duration. ISO_8601 compliant ending datetime for the historical data. Must be within 31 days of the start_date. If the supplied value does not specify a timezone, the timezone will be inferred from the time_zone parameter, if supplied. Otherwise UTC is assumed. - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// Percentage of energy lost due to one day of soiling. /// Number of days after a rainfall event when it’s assumed the ground is damp, and so it’s assumed there is no soiling. /// Maximum percentage of energy lost due to soiling. Soiling will build up until this value. - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. - /// Response format + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. + /// Response format (json, csv). Default is json. public async Task> GetHistoricKimber( double? latitude, double? longitude, diff --git a/src/Solcast/Clients/LiveClient.cs b/src/Solcast/Clients/LiveClient.cs index 196e40f..59c6c0d 100644 --- a/src/Solcast/Clients/LiveClient.cs +++ b/src/Solcast/Clients/LiveClient.cs @@ -377,17 +377,17 @@ public async Task> GetLiveRadiationAnd } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// The number of hours to return in the response. - /// Length of the averaging period in ISO 8601 format. - /// Deposition Velocity for PM10. - /// Deposition Velocity for PM2.5. - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// The number of hours to return in the response. Default is 24. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// The angle (degrees) that the PV system is tilted off the horizontal. A tilt of 0 means the system faces directly upwards, and 90 means the system is vertical and facing the horizon. If you don't specify tilt, we use a default tilt angle based on the latitude you specify in your request. Must be between 0 and 90. - /// Amount of daily rainfall required to clean the panels (mm) - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// Restricted. Specifies the period of time to sum rain fall data. Internally this value is set to 24 hours in line with the findings of https://ieeexplore.ieee.org/document/4060159 . /// Restricted. List of rainfall values. HSU endpoint will internally use Solcast's percepitation rate values tailored to your request time period. /// Response format @@ -481,16 +481,16 @@ public async Task> GetLiveHsu( } /// The latitude of the location you request data for. Must be a decimal number between -90 and 90. /// The longitude of the location you request data for. Must be a decimal number between -180 and 180. - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. - /// The number of hours to return in the response. - /// Length of the averaging period in ISO 8601 format. - /// Amount of daily rainfall required to clean the panels (mm) + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. + /// The number of hours to return in the response. Default is 24. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// Percentage of energy lost due to one day of soiling. /// Number of days after a rainfall event when it’s assumed the ground is damp, and so it’s assumed there is no soiling. /// Maximum percentage of energy lost due to soiling. Soiling will build up until this value. - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. - /// Response format + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. + /// Response format (json, csv). Default is json. public async Task> GetLiveKimber( double? latitude, double? longitude, diff --git a/src/Solcast/Models/Responses/GetForecastHsuLosses.cs b/src/Solcast/Models/Responses/GetForecastHsuLosses.cs index fb31179..8252c1a 100644 --- a/src/Solcast/Models/Responses/GetForecastHsuLosses.cs +++ b/src/Solcast/Models/Responses/GetForecastHsuLosses.cs @@ -18,46 +18,46 @@ public class GetForecastHsuLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// The number of hours to return in the response. + /// The number of hours to return in the response. Default is 24. /// [JsonProperty("hours")] public int? Hours { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } /// - /// Deposition Velocity for PM10. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. /// [JsonProperty("depo_veloc_pm10")] public double? DepoVelocPm10 { get; set; } /// - /// Deposition Velocity for PM2.5. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. /// - [JsonProperty("depo_veloc_pm2.5")] - public double? DepoVelocPm2.5 { get; set; } + [JsonProperty("depo_veloc_pm2_5")] + public double? DepoVelocPm25 { get; set; } /// - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// [JsonProperty("pm10")] public List Pm10 { get; set; } /// - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// - [JsonProperty("pm2.5")] - public List Pm2.5 { get; set; } + [JsonProperty("pm2_5")] + public List Pm25 { get; set; } /// /// The angle (degrees) that the PV system is tilted off the horizontal. A tilt of 0 means the system faces directly upwards, and 90 means the system is vertical and facing the horizon. If you don't specify tilt, we use a default tilt angle based on the latitude you specify in your request. Must be between 0 and 90. @@ -66,13 +66,13 @@ public class GetForecastHsuLosses public double? Tilt { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm). Defaults to 6.0mm + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } @@ -90,13 +90,13 @@ public class GetForecastHsuLosses public List Rainfall { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } /// - /// Response format + /// Response format (json, csv). Default is json. /// [JsonProperty("format")] public string Format { get; set; } diff --git a/src/Solcast/Models/Responses/GetForecastKimberLosses.cs b/src/Solcast/Models/Responses/GetForecastKimberLosses.cs index 5eeb7af..f75d907 100644 --- a/src/Solcast/Models/Responses/GetForecastKimberLosses.cs +++ b/src/Solcast/Models/Responses/GetForecastKimberLosses.cs @@ -18,25 +18,25 @@ public class GetForecastKimberLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// The number of hours to return in the response. + /// The number of hours to return in the response. Default is 24. /// [JsonProperty("hours")] public int? Hours { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } @@ -60,19 +60,19 @@ public class GetForecastKimberLosses public double? MaxSoiling { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } /// - /// Response format + /// Response format (json, csv). Default is json. /// [JsonProperty("format")] public string Format { get; set; } diff --git a/src/Solcast/Models/Responses/GetHistoricHsuLosses.cs b/src/Solcast/Models/Responses/GetHistoricHsuLosses.cs index cc46c31..058580c 100644 --- a/src/Solcast/Models/Responses/GetHistoricHsuLosses.cs +++ b/src/Solcast/Models/Responses/GetHistoricHsuLosses.cs @@ -18,37 +18,37 @@ public class GetHistoricHsuLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } /// - /// Deposition Velocity for PM10. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. /// [JsonProperty("depo_veloc_pm10")] public double? DepoVelocPm10 { get; set; } /// - /// Deposition Velocity for PM2.5. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. /// [JsonProperty("depo_veloc_pm2.5")] public double? DepoVelocPm2.5 { get; set; } /// - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// [JsonProperty("pm10")] public List Pm10 { get; set; } /// - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// [JsonProperty("pm2.5")] public List Pm2.5 { get; set; } @@ -78,19 +78,19 @@ public class GetHistoricHsuLosses public string End { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } diff --git a/src/Solcast/Models/Responses/GetHistoricKimberLosses.cs b/src/Solcast/Models/Responses/GetHistoricKimberLosses.cs index b8477bc..95f4b8e 100644 --- a/src/Solcast/Models/Responses/GetHistoricKimberLosses.cs +++ b/src/Solcast/Models/Responses/GetHistoricKimberLosses.cs @@ -18,13 +18,13 @@ public class GetHistoricKimberLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } @@ -48,7 +48,7 @@ public class GetHistoricKimberLosses public string End { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } @@ -72,19 +72,19 @@ public class GetHistoricKimberLosses public double? MaxSoiling { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } /// - /// Response format + /// Response format (json, csv). Default is json. /// [JsonProperty("format")] public string Format { get; set; } diff --git a/src/Solcast/Models/Responses/GetLiveHsuLosses.cs b/src/Solcast/Models/Responses/GetLiveHsuLosses.cs index 4bbeb0d..f653126 100644 --- a/src/Solcast/Models/Responses/GetLiveHsuLosses.cs +++ b/src/Solcast/Models/Responses/GetLiveHsuLosses.cs @@ -18,43 +18,43 @@ public class GetLiveHsuLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// The number of hours to return in the response. + /// The number of hours to return in the response. Default is 24. /// [JsonProperty("hours")] public int? Hours { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } /// - /// Deposition Velocity for PM10. + /// Deposition or settling velocity of PM2.5 particulates. [m/s]. Default is 0.0009. /// [JsonProperty("depo_veloc_pm10")] public double? DepoVelocPm10 { get; set; } /// - /// Deposition Velocity for PM2.5. + /// Deposition or settling velocity of PM10 particulates. [m/s]. Default is 0.004. /// [JsonProperty("depo_veloc_pm2.5")] public double? DepoVelocPm2.5 { get; set; } /// - /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM10 values tailored to your request time period. + /// Restricted. A list of PM10 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// [JsonProperty("pm10")] public List Pm10 { get; set; } /// - /// Restricted. A list of PM2.5 values. Concentration of airborne particulate matter (PM) with aerodynamicdiameter less than 10 microns. [g/m^3] HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. + /// Restricted. Concentration of airborne particulate matter (PM) with aerodynamic diameter less than 2.5 microns. [g/m^3]. HSU endpoint will internally use Solcast's PM2.5 values tailored to your request time period. /// [JsonProperty("pm2.5")] public List Pm2.5 { get; set; } @@ -66,19 +66,19 @@ public class GetLiveHsuLosses public double? Tilt { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. If provided must be >= 0 and < 0.3437. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } diff --git a/src/Solcast/Models/Responses/GetLiveKimberLosses.cs b/src/Solcast/Models/Responses/GetLiveKimberLosses.cs index 0983f90..5c4466d 100644 --- a/src/Solcast/Models/Responses/GetLiveKimberLosses.cs +++ b/src/Solcast/Models/Responses/GetLiveKimberLosses.cs @@ -18,25 +18,25 @@ public class GetLiveKimberLosses public double? Longitude { get; set; } // Required /// - /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. + /// Timezone to return in data set. Accepted values are utc, longitudinal, or a range from -13 to 13 in 0.25 hour increments for utc offset. Default is utc. /// [JsonProperty("time_zone")] public string TimeZone { get; set; } /// - /// The number of hours to return in the response. + /// The number of hours to return in the response. Default is 24. /// [JsonProperty("hours")] public int? Hours { get; set; } /// - /// Length of the averaging period in ISO 8601 format. + /// Length of the averaging period in ISO 8601 format. Default is PT30M. /// [JsonProperty("period")] public string Period { get; set; } /// - /// Amount of daily rainfall required to clean the panels (mm) + /// Amount of daily rainfall required to clean the panels (mm). Default is 6.0. /// [JsonProperty("cleaning_threshold")] public double? CleaningThreshold { get; set; } @@ -60,19 +60,19 @@ public class GetLiveKimberLosses public double? MaxSoiling { get; set; } /// - /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. + /// Initial percentage of energy lost due to soiling at time zero in the rainfall series input. If not provided, Solcast will perform a ramp up series calculation to accurately determine this value. /// [JsonProperty("initial_soiling")] public double? InitialSoiling { get; set; } /// - /// A list of ISO 8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. + /// A list of ISO_8601 compliant dates or a repeating interval when manual cleaning of the panels occurred. A list of dates example: [2025-01-01,2025-01-05,2025-01-10]. A repeating interval example: R3/2025-01-01T00:00:00Z/P14D. Wash dates outside of the start and end of the request are discarded. /// [JsonProperty("manual_wash_dates")] public List ManualWashDates { get; set; } /// - /// Response format + /// Response format (json, csv). Default is json. /// [JsonProperty("format")] public string Format { get; set; }