C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe Namespace Reference

Namespaces

namespace  Analyses
 
namespace  APIResourceView
 
namespace  APITypes
 
namespace  Attributes
 
namespace  Authentication
 
namespace  Distributions
 
namespace  ExchangeRates
 
namespace  Fees
 
namespace  JsonConverters
 
namespace  LargeDataUpload
 
namespace  Layers
 
namespace  LossFilters
 
namespace  LossSets
 
namespace  Metrics
 
namespace  Optimization
 
namespace  Properties
 
namespace  Rest
 
namespace  Utilities
 

Classes

class  Agent
 Represents a DataAgent instance. More...
 
class  AnalysisProfile
 A configuration of resources used to simulate a layer or portfolio. More...
 
class  API
 API methods / requests made available to the user. More...
 
class  APIRequestException
 A custom exception class that includes the RestSharp.IRestResponse that generated the exception, and the detailed ServerError returned, if available. More...
 
class  APIResource
 Base class used by all resources. More...
 
class  APIType
 Base class used by all types and resources. More...
 
class  CollectionResponse
 Implements the reference entity interface, with support for resolving references using lazy loading. More...
 
class  CollectionResponseMeta
 The metadata associated with a collection get response. More...
 
class  DataFile
 Represents a file that has been uploaded to the server, usually in conjunction with some other resource to which the data in this file pertains. More...
 
class  Distribution
 Abstract representation of a distribution, used for parametric loss sets. More...
 
class  EventCatalog
 Representation of an event catalog. The event catalog may cover multiple region/perils, but it is suggested that event catalogs cover disjoint set of events. More...
 
class  ExtensionMethods
 Provides the REST request methods available to data endpoints. More...
 
interface  IAPIResource
 Interface for Base class used by all resources. More...
 
interface  IAPIResourceView
 PortfolioView and LayerView interface. More...
 
interface  IAPIType
 Interface shared by all object types and resources returned by the Analyze Re server. More...
 
interface  ICollectionResponse
 Covariant interface for the generic collection response type. More...
 
interface  ILayer
 Abstract representation of a layer. More...
 
interface  ILayerSource
 An interface for an object that provides access to some layer instance. More...
 
interface  ILayerView
 Represents the Analysis of a Layer More...
 
interface  IReference
 Base interface for all reference entities. More...
 
class  LargeDataUpload_ExtensionMethods
 LargeDataUpload extension methods for LargeDataSubResource classes More...
 
class  Layer
 Abstract representation of a layer. This resource type cannot be instantiated instead derived resource types should be used for instantiation. More...
 
class  LayerView
 Represents the Analysis of a Layer More...
 
class  LayerViews
 LayerView factory class. More...
 
class  LossFilter
 A predicate that determines whether a loss should be included in the perspective or not. More...
 
class  LossSet
 Base class for all LossSet sub-types. A LossSet is a resource that generates sample (trial) losses which can be used to simulate a losses to a layer. More...
 
class  MonetaryUnit
 Representation of a monetary value with a currency. More...
 
class  NotWaitingException
 Thrown when a request requires additional time to complete, but it exceeds the time we are willing to wait. More...
 
class  Perspective
 The loss perspective determines what factors to include when computing a distribution. More...
 
class  PollingOptions
 Determines the behaviour of the API when automatically retrying a request whose result is not yet ready for retrieval. More...
 
class  Portfolio
 Representation of a portfolio. More...
 
class  PortfolioView
 Represents the Analysis of a Portfolio More...
 
class  ProbabilityWindow
 A probability range used to dictate the set of ordered trial losses in a loss distribution that should be selected during a metrics request. Includes additional features for defining probability windows in different way, as well as implementing the IEquatable interface so that these instances can be used as Dictionary Keys. More...
 
class  Reference
 Implements the reference entity interface, with support for resolving references using lazy loading. More...
 
class  Simulation
 Representation of a simulation of a set of trials each representing an event occurrence sequence. More...
 
class  StaticPortfolio
 Representation of a portfolio. More...
 
class  StaticSimulation
 A pre-simulated representation of a Simulation (SimGrid). More...
 
class  TaskStatusExtensions
 Extension methods for TaskStatus enum values. More...
 

Enumerations

enum  RecordType {
  RecordType.Loss = 1 << 0, RecordType.SlidingScaleCommission = 1 << 1, RecordType.NoClaimsBonus = 1 << 2, RecordType.FixedExpense = 1 << 3,
  RecordType.ProportionalExpense = 1 << 4, RecordType.ProfitCommission = 1 << 5
}
 The type of occurrence. More...
 
enum  TaskStatus {
  TaskStatus.Unknown = 0, TaskStatus.Awaiting_Upload, TaskStatus.Uploading, TaskStatus.Queued,
  TaskStatus.Processing, TaskStatus.Success, TaskStatus.Failed, TaskStatus.BadRequest
}
 The status of a data upload which may be in progress. More...
 

Enumeration Type Documentation

enum AnalyzeRe.RecordType
strong

The type of occurrence.

Enumerator
Loss 

Event loss

SlidingScaleCommission 

Sliding Scale Commission fees

NoClaimsBonus 

No Claims Bonus fees

FixedExpense 

Fixed Expense fees

ProportionalExpense 

Proportional Expense fees

ProfitCommission 

Profit Commission fees

Definition at line 9 of file RecordType.cs.

enum AnalyzeRe.TaskStatus
strong

The status of a data upload which may be in progress.

Enumerator
Unknown 

Cannot determine the status of this data endpoint.

Awaiting_Upload 

No data upload has been initiated. Ready for upload.

Uploading 

Data upload has been initiated, but not yet committed.

Queued 

Data has already been uploaded and is queued for processing.

Processing 

Data has already been uploaded and is being processed.

Success 

Data has already been uploaded and successfully processed.

Failed 

Data has already been uploaded but failed processing.

BadRequest 

Indicates that an invalid request was sent, and so the resource cannot be processed.

Definition at line 8 of file TaskStatus.cs.