AnalyzeRe.Client 1.43.8116.23517

• • Newtonsoft.Json (>= 10.0.0 && < 11.0.0)
  • RestSharpSigned (>= 105.2.3)

This Client Library wraps the AnalyzeRe REST API.
1.43
- New "Perspective" format and capabilities
-- The "Perspective" argument (when requesting metrics) can now be any one or combination of the values: NetLoss, ReinstatementPremium, ReinstatementBrokerage, Premium, FixedExpense, ProfitCommission, ProportionalExpense, NoClaimsBonus, SlidingScaleCommission. It can also be set to "LossGross" on its own as before.
-- As new fee types are implemented, they will be added as valid perspectives.
-- For backwards compatibility reasons, the old "LossNetOfAggregateTerms" perspective value implicitly includes all currently implemented fees.
-- If a perspective is not specified at metrics request time, it will default based on the Analysis Profile's new "default_perspective" parameter. For backwards-compatibility, the current default on all existing profiles is "LossNetOfAggregateTerms", but on new analysis profiles, this will default to "NetLoss".
- The "Perspective" class has been given a new IEquatable implementation that should perform better as a key in Dictionaries and HashSets.
- New static "Perspective" factory methods have been added to encourage the use of static singletons, even when the desired perspective isn't known at development-time.
- The "ValueAllocator" layer now uses its own perspective enumeration, rather than borrowing from the Perspective.Base enumeration.
-- Backwards-incompatibility warning - we decided that ValueAllocators were new enough that it was worthwhile correcting the implementation without the complexity of maintaining backwards compatibility.

1.42
- Added the new "DelayedPayment" and "FixedDatePayment" payment pattern structures, to assist with modelling claims.
- Removed the warnings constantly being logged to console by the Analyze Re client library when receiving metrics responses from the server.
- Implemented IEquatable{T} for all Fees, FeeReference, Payment and MonetaryUnit to facilitate equating these custom types, and improved the implementation for Perspective, Policy, and Reinstatement to improve null safety and performance.
- Added some LossSet interfaces to simply type checking and member access on runtime loss set types.
- Obsoleted the NestedLayerLossSet class, whose applications are entirely superseded by the Nested layer.
- Clarified which resources have a functioning "progress" property in their model (OptimizationViews only). Formerly, this was inherited by all ResourceWithStatus derivees. Marked this property obsolete on other inheriting classes (AnalysisProfile, EventCatalog, ExchangeRateTable), with a message indicating where progress can be obtained (usually the /data/status endpoint).
- Fixed the "DeepCopy" extension method converting some "null" properties back to their default value (e.g. an empty list or dictionary), making the copy inexact.
- Added an optional parameter to the "Serialize" extension method to include properties that have a null value in the JSON (defaults to false - the prior behaviour).

1.41
- Added the new server-generated "premium" property to the PortfolioView class - computed and returned by the server at POST time.
- Fixed the `.Serialize()` extension method (introduced in 1.40) to include server-managed properties (such as `id`) by default.
- Added a new optional argument to the method for explicitly excluding these properties if needed.
- Removed deprecated overloads of metrics requests (deprecated in v1.13 in Aug 2016) which took positional arguments rather than options objects.
- Metrics options are now optional (defaulting to equivalent MetricsOptions.Default value)
- Metrics requests now have a "timeout" parameter which can be used to override the API.DefaultRequestTimeout for individual metrics requests.
- "Blocking" extension methods for metrics requests now respect the timeout specified in the polling options on the request itself.
- Added a static API.GET method that can retrieve a single resource by id using a runtime-type

1.40
- The LossRank layer-operation has been modified to only support LargestLoss ordering, so the criterion property was removed accordingly.
- Added the new `BackAllocatedLayer` structure type.
- Soft-deprecated the "back_allocation" function on analyses in favour of this new structure.
- Improved error message when requests time out.
- `PollUntilReady` no longer retries timed-out requests. Temporary network failures should still be retried normally if the polled request is a standard API request.
- Fixed a relatively harmless bug where component_perspective was included twice in a co_metrics requests URL.
- The Reinstatement Brokerage can be referenced in a Losses category for the fees calculation.
- Added 'allocation_ratio_basis' to the Value Allocator layer for PerEvent(by default) or PerTrial allocated values calculations.
- Fixed a bug where enabling compression with a small chunk size could lead to incorrect offsets during upload.
- Added additional error handling for low-level socket timeouts that should make API calls less prone to random network errors.
- All Analyze Re objects now have a `.Serialize()` extension method, to simplify getting a JSON representation for debugging or persistence purposes.

1.39
- Added the new `ValueAllocator` structure type (a `Layer`-derived type similar to `Nested`).
- While the intended usage of the `ValueAllocator` is to allocate event losses on the basis of a different structure's relative contribution to some group, this can serve as a more general building block for performing vector multiplication and division.
- The `Perspective` type was enhanced with more performant `GetHashCode` and `Equals` implementations, as well as the ability to easily compare `Perspective.Base` enum values with equivalent class instances.

1.38
- Removed deprecated implicit operators for Reference instances to remove ambiguity when constructing objects that require resource references.
- If you previously had code using the implicit operators like "myNestedLayer.sink = someOtherLayer", you may need to change it to ".sink = someOtherLayer.ToReference()"
- Surface the API's new metrics_functions and projection_functions endpoints used to manage custom optimization functions.
- Surfaced the event_catalogs/GUID/profile endpoint, which gives information on the columns contained in the uploaded catalog.
- Added the target_currency to the IAPIAnalysis interface shared by OptimizationView, LayerView, and PortfolioView classes.

1.37
- Surfaced the new optional "policy" property on all layers, which allows users to change the default behaviour of which losses are transformed and/or forwarded by the layer.

1.36
- Nested layers "sink" and "sources" types changed from being ILayer references to a new base interface called `ILayerSource` which allows either reference to Layers or to LayerViews!
- As such, nested layer_views can now be built by referencing previously posted layer_view ids rather than requiring each level of nesting to fully inline (duplicate) the previous layer definition.
- As the property types have changed, this may result in some code breakage. Backwards compatibility was of the utmost concern, but any reflection-based access to the sources collection may need to be adjusted.
- Property-reflection utilities (like the GetUserFacingProperties type extension method) behave a little differently, so if you use these you may wish to check the latest documentation on those methods.

1.35
- Disabled support for TLSv1.0 and explicitly selected TLSv1.2.
- Added RecordTypeAnyOfFilter loss filter which can filter losses by their record type
- Added AdditionalColumn options to YELTOptions, allowing for the download of occurrence information

1.34
- Revised the AggregateQuotaShare class to enable its use as a nested layer sink that applies aggregate terms while simultaneously accumulating pro-rated reinstatement premiums and brokerages.

1.33
- User settings moved to the Registry by default.
- This version adds the ability to toggle between storing configured settings in the native local files (the old default) and the HKCU registry (new default).
- An application can reverted to the old behaviour using `AnalyzeRe.Properties.SharedSettingsProvider.GlobalSettingsLocation = SharedSettingsProvider.SettingsLocation.NativeLocalFile;`
- When settings are externally modified, the static client library can be updated by invoking `API.LoadSettings`
- The `API.UserAgent` header can now be modified to allow applications to provide custom identities to the Analyze Re sever.
- Added the ability to download a specific trial range of a YELT through use of the `start_trial` and `end_trial` properties in `AnalyzeRe.Metrics.YELTOptions`.
- New Fee structures which can be added to TermsLayer classes to include expenses in trial losses

1.32
- Surfaced Window Metrics (window_metrics) - a new feature on the server to support getting metrics on a range of trials without including the full tail.
- Window metrics overloads and extension methods added to match the functionality of tail_metrics, co_metrics, and exceedance_probabilities functions.
- New ProbabilityWindow class to support window metrics, which builds a probability range from a min and max.
- ProbabilityWindow has some static factory methods like "All" and "Tail" for quickly querying standard probabilities.
- For the time being, doubles can be implicitly converted to a "Tail" probability window for backwards-compatibility. This will go away in the future.
- Co-Metrics methods were all updated to support a probability window.
- Co-Metrics overloads that only take a single double probability (or list of probabilities) were soft deprecated, and redirect to use `ProbabilityWindow.Tail(p)` internally.
- All deprecation warning messages were updated to more clearly indicate what the preferred usage is.
- Requests for batch-requesting multiple points in metrics requests has been made more flexible by accepting any IEnumerable of values instead of a List.
- Fixed a bug where the 16th and 17th significant digits of probabilities/thresholds could change during a metrics request.

1.31
- Added the ability to supply Query parameters during POST requests and have them be respected.
- This means you can now do things like `ILayerView response = someLayerView.Post(API.Parameters.Fields(new[]{"id"}))` to speed up the request by having the server only send back the posted resource's new id.
- Added a singleton for the AnalyzeReJsonConverter to make one-off serialization tasks easier. You can now go `string serialized = AnalyzeReJsonConverter.Default.Serialize(layerView)` to get a resource's JSON representation.
- This update removes the redundant Analyze Re copies of RestSharp classes introduced in 1.9 in an attempt to simplify references.
- Users of low-level request methods may need to update their source using statements to reference the RestSharp namespace.
- History: In version 1.9, an attempt was made to internalize any RestSharp and Newtonsoft 3rd party dependencies by reimplementing those classes.
- History: In version 1.26, it was discovered that this led to issues and the formal NuGet package references needed to be restored.
- In this version (1.31) the deprecated wrapper classes are being removed in favour of the original RestSharp classes. This will facilitate adoption of future versions of RestSharp.
- Added correlation property to ConditionalDistributionMetrics
- Fixed a subtle bug whereby using ShallowCopy on a resource might invalidate its SubResource endpoints.

1.30
- Surfaced the ability to batch-retrieve a list of items by id using the new `API.Parameters.Ids` `RequestParameters`.
- You can easily access this using the new collection extension method `GetItems`, e.g. `API.Layers.GetItems(...)`
- You can also access this using the new static API method `BatchGet`, e.g. `API.BatchGet<ELTLossSet>(...)`
- Surfaced the ability to create marginal PortfolioViews server-side by referencing an existing PortfolioView and LayerViews to add and remove.
- You can easily access this feature using the new `portfolioView.PostMarginalPortfolioView(...)` instance method.
- You can also access this using the new static `API.PortfolioViewMarginals.Post(...)` method.
- Surfaced the new optimization `constraints` and `feasible` results on optimization candidates, which report on constraint metrics and whether the candidate meets all constraints.
- Surfaced the new optimization endpoint for retrieving initial portfolio results, which reports on all metrics for the portfolio of all initial layer shares.
- The OptimizationView class has new functions that make it easier to get results. (`GetInitialPortfolioMetrics`, `GetCandidateResult`, `GetCandidatePortfolioView`, `GetCandidateResultsCount`)
- Soft-Deprecated the old endpoints/attributes for retrieving candidate and initial portfolio results.
- Modified the CoMetrics response class to better reflect the results being returned, including renaming the "component_metrics.variance" property to "covariance".

1.29
- Fixed a bug in compression for large files that get split across multiple patch requests - which was preventing using this option in production.
- Improved compression performance, but made the decision to have compression turned off by default (was enabled by default in 1.28).
- In practice, compression increases client CPU usage significantly, and is not very beneficial unless upload speeds are under 5 MiBps.
- Fixed a bug which gave LargeFileUpload.Parameters instances the appearance that they could be cloned using extension methods.
- Formally deprecated the binary YELT format to warn against future use.
-- Performance improvements are being made to the CSV YELT format's upload, processing, and validation, removing the need for the binary variation.
- An "Advanced" search option has been added for using the API.SearchResource list command. This surfaces new API capabilities surrounding querying resources by metadata using a new Parameters.AdvancedSearch RequestParameter.

1.28
- Support for transparent compression during file upload (enabled by default)
- Overall improvements file/stream upload performance.
- Added an option to disable automatic binary YELT conversion.

1.27
- `target_currency` field added to OptimizationView
- The `Reference.Value` property was deprecated, due to it's behaviour of making network requests being potentially unexpected.
- Added explicit Reference `GetValue()` and `Resolve()` methods for retrieving the resource associated with a reference.
- New `API.PollUntil()` functionality added to allow any request to benefit from exponential back-off polling logic built into status and metrics request polling.
- `IAPIResourceWithStatus.PollUntilReady()` implementation now only polls the status property to improve polling performance with complex resources.
 - If after polling you wish to see an updated property of the resource that isn't the status property (e.g. the `LossSet.profile` property), you must perform a subsequent `Get()` of the resource yourself.
- The `Utilities.SimulationStatusMonitor` class was deprecated.
- Minor performance enhancements by circumventing unnecessary RestSharp logic, reducing request overhead.
- Source updated to take advantage of modern C#7 language features and their associated performance improvements.
- Suppressed issues when saving static client library settings from concurrent instances of the same process, and the new `AnalyzeRe.API.ManagedSettingsEnabled` property can be set to false to disable automatic settings caching and management entirely.
- All resources now inherit optional description and metadata properties.
- Queue-Position added to NotWaitingException for reporting the final current queue position of a request that was being polled.

1.26
- New event_id parameter in ParametricLossSet lets you control what event_id you see associated with Parametric losses on YELT download.
- New extension methods for categorization of property types.
- New LossRank layer structure which allows selecting a subset of losses in a year based on the relative size (rank) of losses.
- New NoClaimsBonus layer structure which can be used to apply a payout to trials which contain no losses.
- Restored Newtonsoft.Json and RestSharpSigned as formal NuGet dependencies in light of Json.NET 10 assembly static resource interference issues.

1.25
- OptimizationView now contains a collection of candidates, and candidates now have a `portfolio_view` sub-resource.
- OptimizationView now contains a server-generated `initial_portfolio_metrics` property.
- As per server-side changes, the portfolio_views must now be retrieved from the candidates. The results no longer reference pre-generated portfolio_views.
- Added support for automatically handling redirection responses, which are used for candidate portfolio_view responses.
- Added the `IResourceCollection` interface, which supports the optimization_view's candidates sub-collection.
- Added static `ResourceCollection` instances to the static API, which support a simplified method of performing collection operations on all root collections on the API.
- Added the ability to order collection get results by certain properties using the "API.Parameters.Order" request parameters.

1.24
- Added the QCLS Loss Set (Quantile-Based Correlated Loss Sampling loss set) - a simulated parametric loss set based on Cholesky decomposition.
- Improved the parametric distribution object model to include interfaces for stricter type definitions.

1.23
- Removed the Obsolete Inuring Terms from ELTLossSets. Inuring terms are now modelled by applying an AggXL layer to the loss set, then using it as the source to a nested layer.
- Added Nth event argument to ILW layers, and fixed/improved documentation around this layer type.
- Added is_optimization_enabled helper property to OPTIONS responses object.

1.22
- Adds an optional CancellationToken parameter to PollingOptions, which anything that takes PollingOptions should respect and monitor for cancellation.
- Updated the API.PollUntilReady helper function, as well as the IStoredAPIResource_WithStatus PollUntilReady extension method to monitor the cancellation token if supplied.
- Restored functionality to the AsyncRequestMonitor by making use of the existing polling methods.
- Gave the AsyncRequestMonitor the ability to poll either by monitoring RetryAfter responses, or by monitoring the status of a supported resource.

1.21
- OptimizationViews now implement the new IStoredAPIResource_WithStatus interface, following a change on the server. They are now polled using their status instead of 503 responses on the results.
- Added the ability to request only certain object properties using the "API.Parameters.Fields" request parameters. This speeds up status polling.
- Renamed the "WaitForStatusToBeReady" extension method from the previous commit to "PollUntilReady" to be consistent with existing RetryAfter based polling method available in the API namespace.
- Added the "Queued" TaskStatus enum value which is used in some cases and is a special distinction of "Processing" indicating that the resource has not yet begun processing, but will.

1.20
- Add the ability to set the data_file property to commit an existing file against a new resource.
- New polling options parameters changed from double (seconds) to integer (milliseconds) parameters to improve consistency with other timeouts in .NET.
- IStoredAPIResource_WithStatus interface added to describe resources that have a status indicating their validation progress.
- WaitForStatusToBeReady extension method added which will poll resources of the above type (includes resources with data and AnalysisProfiles).
- Exponential back-off added to existing RetryAfter polling method and the above status polling method.

1.19
- CoMetrics requests now support setting the component reporting period.

1.18
- Enhanced the copy constructors of classes that derive from `SimulationOptions` to include (as optional arguments) all parameters that cannot be copied from the base object.

1.17
- Sped up reference deserializer
- Added NotSaveableAttribute to indicate layer types that can be inlined but not persisted to the layers collection.
- Renamed `IsDefinedFast` to `IsAttributeDefinedFast` in the reflection utilities library, to reduce ambiguity.

1.16
- Support for probabilities and thresholds requested using exponential notation.

1.15
- ReportingPeriod parameter added to metrics requests. You can now specify a begin and/or end DateTime to get filter distributions by date.
- Fixed PollUntilReady and all blocking metrics requests not respecting the MaxPollTotalTime (since 1.13)

1.14
- Modified BufferedBytesFromStreamProducer to allow users to limit the number of bytes read from the source stream.

1.13
- API types can now be modified on the fly with property expressions.
 - Example: CatXL layer = someCatXL.ShallowCopy().Change(l ()=> l.participation, 0.25).Post();
- New metrics options classes added, which bundle common request options (filter, perspective, etc.)
 - TailMetrics, CoMetrics, ExceedanceProbabilities, etc. requests now support options objects as parameters.
- Old metrics methods are now marked Obsolete, and will be removed at the next major version.

1.11
- Removed LossNetOfOccurrenceTerms as an input and output perspective.
- Added bindings for the FixedRateCurrencyConverter structure.

1.10
- Warning: Minor Backwards Incompatible Changes
- Simplified code hierarchy in preparation for open sourcing.
- Modified some models to fall under different namespaces.
- Improvements and bug-fixes to documentation after the recent switch to support .NET40

1.9:
- Support for projects targeting either .NET framework 4.0 or 4.5
- Includes source and symbols for debugging.
- Should no longer require projects to also add Json.NET or RestSharp as dependencies.

1.8:
- Support for vectorized metrics requests (batching of probabilities / thresholds)
- No longer caches requests with resource instances - library user must implement their own caching.
- Performance enhancements due to leaner requests, caching reflection-based requests, and improved file upload streaming.
- Compatibility with new server features such as back-allocation, binary upload, and gzipping.
- Automatic handling for temporary network failures such as socket noise and interrupted SSH handshakes.

1.7:
- Now targets .NET Framework 4.5 to make use of improvements to native compression algorithms

1.6 and earlier features:
- Models for all of the resource types defined by the AnalyzeRe API
- Models for Metrics response structures and other custom API objects that appear within various resources
- Extensive error handling and debug logging capabilities via APIRequestException
- REST functionality via resource extension methods that allows:
 - Creation, modification, and retrieval of resources on the server
 - Supplying additional/custom headers and/or parameters to requests
- Additional functionality for specific resources such as:
 - LargeDataUpload functionality for resources with a data upload endpoint
 - Metrics functionality and extension methods for LayerViews and PortfolioViews
- Resource collection GET and Search capability via the API class
- A library of custom Attributes to assist with automated validation of resources and to indicate server constraints on property values.