Artesian.PsModule

0.0.1

Artesian.PsModule.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>Artesian.PsModule</name>

    </assembly>

    <members>

        <member name="T:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet">

            <summary>

            Connects to the Artesian API using various authentication methods. 

            The user can choose to connect using an API key, client credentials, or on behalf of a user with an access token. 

            If no parameters are provided, the cmdlet will prompt the user to select from saved credentials in the Windows Credential Manager. 

            The selected credential will then be used to establish a connection to the Artesian API, 

            and the corresponding configuration will be stored in the session state for use by other cmdlets.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.ApiKey">

            <summary>

            API key to authenticate with the Artesian API. 

            This should be used in conjunction with the ArtesianUrl parameter to specify the base URL of the Artesian API instance to connect to.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.ArtesianUrl">

            <summary>

            Base URL of the Artesian API instance to connect to. 

            This should be used in conjunction with the ApiKey parameter to specify the API key for authentication.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.ClientId">

            <summary>

            Client ID for client credentials authentication with the Artesian API.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.ClientSecret">

            <summary>

            Client secret for client credentials authentication with the Artesian API.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.Url">

            <summary>

            Base URL of the Artesian API instance to connect to. 

            This should be used in conjunction with the ClientId and ClientSecret parameters to specify the client credentials for authentication.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.Audience">

            <summary>

            Audience for client credentials authentication with the Artesian API. 

            This is typically the URL of the API you want to access, and is used in the token request to specify the intended audience of the token.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.Domain">

            <summary>

            Domain for client credentials authentication with the Artesian API.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.AccessToken">

            <summary>

            Access token for on-behalf-of authentication with the Artesian API.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.ProcessRecord">

            <inheritdoc/>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.ConnectArtesianCmdlet.Run">

            <inheritdoc/>

        </member>

        <member name="T:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet">

            <summary>

            Retrieves curve data for a given market data entity.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet.MarketDataEntity">

            <summary>

            Market data entity for which to retrieve curve data.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet.StartRange">

            <summary>

            Start date of the range for which to retrieve curve data.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet.EndRange">

            <summary>

            End date of the range for which to retrieve curve data.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet.Granularity">

            <summary>

            Gets or sets the granularity of the curve data.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.GetArtesianCurveDataCmdlet.ProcessRecordAsync(System.Threading.CancellationToken)">

            <summary>

            This method will be called for each input object received from the pipeline; 

            if no input is received, this method is not called.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianMarketDataEntityCmdlet.ProviderName">

            <summary>

            The name of the provider for which to retrieve the market data entity. 

            This is a required parameter and can be provided through the pipeline.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.GetArtesianMarketDataEntityCmdlet.CurveName">

            <summary>

            The name of the curve for which to retrieve the market data entity. 

            This is a required parameter and can be provided through the pipeline.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.GetArtesianMarketDataEntityCmdlet.BeginProcessing">

            <inheritdoc/>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.GetArtesianMarketDataEntityCmdlet.ProcessRecord">

            <inheritdoc/>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.GetArtesianMarketDataEntityCmdlet.EndProcessing">

            <inheritdoc/>

        </member>

        <member name="T:Artesian.PsModule.Cmdlets.RemoveArtesianCurveCmdlet">

            <summary>

            Removes a curve from the Artesian platform by deleting its market data entity.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Cmdlets.RemoveArtesianCurveCmdlet.MarketDataId">

            <summary>

            The ID of the market data entity to remove. 

            This is a required parameter and can be provided through the pipeline.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Cmdlets.RemoveArtesianCurveCmdlet.ProcessRecordAsync(System.Threading.CancellationToken)">

            <inheritdoc/>

        </member>

        <member name="T:Artesian.PsModule.Helpers.ArtesianCmdlet`1">

            <summary>

            Base class for all cmdlets in the Artesian.PsModule. This class can be used to implement common functionality that should be shared across all cmdlets, such as retrieving the ArtesianServiceConfig from the session state.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Helpers.ArtesianCmdlet`1.AsList">

            <summary>

            If set, the cmdlet will return a list of curve data rows instead of a single object containing all rows. 

            This allows for easier processing in the pipeline.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Helpers.ArtesianCmdlet`1.Config">

            <summary>

            Retrieves the ArtesianServiceConfig from the session state. 

            If it is not set, an exception is thrown instructing the user to run Set-ArtesianConfig first.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Helpers.ArtesianCmdlet`1._queryService">

            <summary>

            Provides a QueryService instance that can be used to execute queries against the Artesian API. 

            The QueryService is initialized with the ArtesianServiceConfig retrieved from the session state.

            </summary>

        </member>

        <member name="P:Artesian.PsModule.Helpers.ArtesianCmdlet`1._marketDataService">

            <summary>

            Provides a MarketDataService instance that can be used to retrieve market data from the Artesian API.

            The MarketDataService is initialized with the ArtesianServiceConfig retrieved from the session state.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.ArtesianCmdlet`1.BeginProcessing">

            <summary>

            This method will be called once at the beginning of pipeline execution; 

            if no input is received, this method is not called.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.ArtesianCmdlet`1.EndProcessing">

            <summary>

            This method will be called once at the end of pipeline execution; 

            if no input is received, this method is not called.

            </summary>

        </member>

        <member name="T:Artesian.PsModule.Helpers.ArtesianAsyncCmdlet`1">

            <summary>

            Base class for async cmdlets. 

            Inherits from ArtesianCmdlet and implements ProcessRecord via AsyncHelper.RunSync calling ProcessRecordAsync.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.ArtesianAsyncCmdlet`1.ProcessRecord">

            <inheritdoc/>

        </member>

        <member name="F:Artesian.PsModule.Helpers.ArtesianAsyncCmdlet`1._cts">

            <summary>

            Cancellation token source that can be used to cancel long-running operations when the user stops the cmdlet. 

            The token is passed to the ProcessRecordAsync method, which can use it to gracefully handle cancellation.

            The StopProcessing method cancels the token, which will trigger an OperationCanceledException in any ongoing operations that are observing the token.

            Cmdlets that inherit from ArtesianCmdlet should pass this token to any async operations they perform in ProcessRecordAsync to ensure proper cancellation behavior.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.ArtesianAsyncCmdlet`1.StopProcessing">

            <summary>

            This method will be called for each input received from the pipeline to this cmdlet; 

            if no input is received, this method is not called.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.ArtesianAsyncCmdlet`1.ProcessRecordAsync(System.Threading.CancellationToken)">

            <summary>

            This method will be called for each input received from the pipeline to this cmdlet; 

            if no input is received, this method is not called.

            </summary>

            <param name="ct">A cancellation token that can be used to cancel the operation.</param>

            <returns>A task representing the asynchronous operation.</returns>

        </member>

        <member name="T:Artesian.PsModule.Helpers.SessionHelper">

            <summary>

            Helper class for managing the ArtesianServiceConfig in the PowerShell session state. 

            This allows cmdlets to access the configuration without needing to pass it as a parameter. 

            The config is stored in a session variable and can be set and retrieved using the provided methods. 

            If the config is not set when trying to retrieve it, an exception is thrown instructing the user to run Set-ArtesianConfig first.

            </summary>

        </member>

        <member name="F:Artesian.PsModule.Helpers.SessionHelper.ARTESIAN_CONFIG_VARIABLE_NAME">

            <summary>

            The name of the session variable where the ArtesianServiceConfig is stored.

            </summary>

        </member>

        <member name="M:Artesian.PsModule.Helpers.SessionHelper.SetArtesianConfig(System.Management.Automation.SessionState,Artesian.SDK.Service.ArtesianServiceConfig)">

            <summary>

            Sets the ArtesianServiceConfig in the session state. This should be called once at the beginning of the session, after authenticating with the Artesian API.

            </summary>

            <param name="sessionState">The PowerShell session state.</param>

            <param name="config">The ArtesianServiceConfig to set.</param>

        </member>

        <member name="M:Artesian.PsModule.Helpers.SessionHelper.GetArtesianConfig(System.Management.Automation.SessionState)">

            <summary>

            Retrieves the ArtesianServiceConfig from the session state. If it is not set, an exception is thrown instructing the user to run Set-ArtesianConfig first.

            </summary>

            <param name="sessionState">The PowerShell session state.</param>

            <returns>The ArtesianServiceConfig from the session state.</returns>

            <exception cref="T:System.InvalidOperationException">Thrown if the ArtesianServiceConfig is not set in the session state.</exception>

        </member>

    </members>

</doc>