combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

View the Project on GitHub insidepetroleum/combocurve-client-csharp

ComboCurve.Api.Api.ExportsV2Api

All URIs are relative to https://api.combocurve.com

Method HTTP request Description
GetV2ExportsEconMonthlyStatus GET /v2/exports/econ-monthly/{jobId} Get economic monthly export job status
GetV2ExportsEconOneLinersStatus GET /v2/exports/econ-one-liners/{jobId} Get economic one-liners export job status
GetV2ExportsForecastParametersStatus GET /v2/exports/forecast-parameters/{jobId} Get forecast parameters export job status
GetV2ExportsForecastVolumesStatus GET /v2/exports/forecast-volumes/{jobId} Get forecast volumes export job status
PostV2ExportsEconMonthly POST /v2/exports/econ-monthly Trigger an economic monthly export job
PostV2ExportsEconOneLiners POST /v2/exports/econ-one-liners Trigger an economic one-liners export job
PostV2ExportsForecastParameters POST /v2/exports/forecast-parameters Trigger a forecast parameters export job
PostV2ExportsForecastVolumes POST /v2/exports/forecast-volumes Trigger a forecast volumes export job

GetV2ExportsEconMonthlyStatus

EconMonthlyExportV2StatusResponse GetV2ExportsEconMonthlyStatus (string jobId, int? expirationHours = null)

Get economic monthly export job status

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetV2ExportsEconMonthlyStatusExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var jobId = "jobId_example";  // string | The unique identifier of the export job
            var expirationHours = 56;  // int? | Number of hours the signed URL will remain valid (default 24) (optional) (between 1 and 24)

            try
            {
                // Get economic monthly export job status
                EconMonthlyExportV2StatusResponse result = apiInstance.GetV2ExportsEconMonthlyStatus(jobId, expirationHours);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.GetV2ExportsEconMonthlyStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
jobId string The unique identifier of the export job  
expirationHours int? Number of hours the signed URL will remain valid (default 24) [optional] [between 1 and 24]

Return type

EconMonthlyExportV2StatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Export job status retrieved successfully | - | | 400 | Bad Request. Invalid jobId format. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 404 | Not Found. Export job not found or does not exist. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetV2ExportsEconOneLinersStatus

EconOneLinersExportV2StatusResponse GetV2ExportsEconOneLinersStatus (string jobId, int? expirationHours = null)

Get economic one-liners export job status

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetV2ExportsEconOneLinersStatusExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var jobId = "jobId_example";  // string | The unique identifier of the export job
            var expirationHours = 56;  // int? | Number of hours the signed URL will remain valid (default 24) (optional) (between 1 and 24)

            try
            {
                // Get economic one-liners export job status
                EconOneLinersExportV2StatusResponse result = apiInstance.GetV2ExportsEconOneLinersStatus(jobId, expirationHours);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.GetV2ExportsEconOneLinersStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
jobId string The unique identifier of the export job  
expirationHours int? Number of hours the signed URL will remain valid (default 24) [optional] [between 1 and 24]

Return type

EconOneLinersExportV2StatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Export job status retrieved successfully | - | | 400 | Bad Request. Invalid jobId format. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 404 | Not Found. Export job not found or does not exist. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetV2ExportsForecastParametersStatus

ForecastParametersStatusResponse GetV2ExportsForecastParametersStatus (string jobId, int? expirationHours = null)

Get forecast parameters export job status

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetV2ExportsForecastParametersStatusExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var jobId = "jobId_example";  // string | The unique identifier of the export job
            var expirationHours = 56;  // int? | Number of hours the signed URL will remain valid (default 24) (optional) (between 1 and 24)

            try
            {
                // Get forecast parameters export job status
                ForecastParametersStatusResponse result = apiInstance.GetV2ExportsForecastParametersStatus(jobId, expirationHours);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.GetV2ExportsForecastParametersStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
jobId string The unique identifier of the export job  
expirationHours int? Number of hours the signed URL will remain valid (default 24) [optional] [between 1 and 24]

Return type

ForecastParametersStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Export job status retrieved successfully | - | | 400 | Bad Request. Invalid jobId format. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 404 | Not Found. Export job not found or does not exist. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetV2ExportsForecastVolumesStatus

ForecastVolumesStatusResponse GetV2ExportsForecastVolumesStatus (string jobId, int? expirationHours = null)

Get forecast volumes export job status

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetV2ExportsForecastVolumesStatusExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var jobId = "jobId_example";  // string | The unique identifier of the export job
            var expirationHours = 56;  // int? | Number of hours the signed URL will remain valid (default 24) (optional) (between 1 and 24)

            try
            {
                // Get forecast volumes export job status
                ForecastVolumesStatusResponse result = apiInstance.GetV2ExportsForecastVolumesStatus(jobId, expirationHours);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.GetV2ExportsForecastVolumesStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
jobId string The unique identifier of the export job  
expirationHours int? Number of hours the signed URL will remain valid (default 24) [optional] [between 1 and 24]

Return type

ForecastVolumesStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | Export job status retrieved successfully | - | | 400 | Bad Request. Invalid jobId format. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 404 | Not Found. Export job not found or does not exist. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV2ExportsEconMonthly

EconMonthlyExportV2TriggerResponse PostV2ExportsEconMonthly (EconMonthlyExportV2 exportRequest)

Trigger an economic monthly export job

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostV2ExportsEconMonthlyExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var exportRequest = new EconMonthlyExportV2(); // EconMonthlyExportV2 | Economic monthly export configuration

            try
            {
                // Trigger an economic monthly export job
                EconMonthlyExportV2TriggerResponse result = apiInstance.PostV2ExportsEconMonthly(exportRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.PostV2ExportsEconMonthly: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
exportRequest EconMonthlyExportV2 Economic monthly export configuration  

Return type

EconMonthlyExportV2TriggerResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 202 | Export job successfully triggered | - | | 400 | Bad Request. Invalid request data or missing required fields. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV2ExportsEconOneLiners

EconOneLinersExportV2TriggerResponse PostV2ExportsEconOneLiners (EconOneLinersExportV2 exportRequest)

Trigger an economic one-liners export job

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostV2ExportsEconOneLinersExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var exportRequest = new EconOneLinersExportV2(); // EconOneLinersExportV2 | Economic one-liners export configuration

            try
            {
                // Trigger an economic one-liners export job
                EconOneLinersExportV2TriggerResponse result = apiInstance.PostV2ExportsEconOneLiners(exportRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.PostV2ExportsEconOneLiners: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
exportRequest EconOneLinersExportV2 Economic one-liners export configuration  

Return type

EconOneLinersExportV2TriggerResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 202 | Export job successfully triggered | - | | 400 | Bad Request. Invalid request data or missing required fields. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV2ExportsForecastParameters

ForecastParametersTriggerResponse PostV2ExportsForecastParameters (ForecastParametersExport exportRequest)

Trigger a forecast parameters export job

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostV2ExportsForecastParametersExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var exportRequest = new ForecastParametersExport(); // ForecastParametersExport | Forecast parameters export configuration

            try
            {
                // Trigger a forecast parameters export job
                ForecastParametersTriggerResponse result = apiInstance.PostV2ExportsForecastParameters(exportRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.PostV2ExportsForecastParameters: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
exportRequest ForecastParametersExport Forecast parameters export configuration  

Return type

ForecastParametersTriggerResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 202 | Export job successfully triggered | - | | 400 | Bad Request. Invalid request data or missing required fields. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 422 | Unprocessable Entity. Request validation failed. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV2ExportsForecastVolumes

ForecastVolumesTriggerResponse PostV2ExportsForecastVolumes (ForecastVolumesExport exportRequest)

Trigger a forecast volumes export job

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostV2ExportsForecastVolumesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };

            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// Or use the specific API class (Recommended)
			// var apiInstance = new ExportsV2Api(serviceAccount, apiKey);

            var exportRequest = new ForecastVolumesExport(); // ForecastVolumesExport | Forecast volumes export configuration

            try
            {
                // Trigger a forecast volumes export job
                ForecastVolumesTriggerResponse result = apiInstance.PostV2ExportsForecastVolumes(exportRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportsV2Api.PostV2ExportsForecastVolumes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
exportRequest ForecastVolumesExport Forecast volumes export configuration  

Return type

ForecastVolumesTriggerResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 202 | Export job successfully triggered | - | | 400 | Bad Request. Invalid request data or missing required fields. | - | | 401 | Unauthorized. Invalid or missing authentication. | - | | 403 | Forbidden. Insufficient permissions to access the resource. | - | | 422 | Unprocessable Entity. Request validation failed. | - | | 500 | Internal Server Error. Something went wrong on the server. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]