combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

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

ComboCurve.Api.Api.EconReportSettingsApi

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

Method HTTP request Description
DeleteEconReportSettingsById DELETE /v1/econ-report-settings/{id} Delete a single econ report setting by id.
GetEconReportSettings GET /v1/econ-report-settings Returns the list of econ report settings in the tenant. Econ report settings are company-shared: reads return every setting regardless of who created it. Absent `allWellsAgg` values are returned as `true`, and absent `rollUpEachLevel` values are returned as `false`.
GetEconReportSettingsById GET /v1/econ-report-settings/{id} Returns a single econ report setting by id.
HeadEconReportSettings HEAD /v1/econ-report-settings Returns metadata about the existing econ report setting documents (count and pagination links) without a body. Supports the same filters as GET.
PatchEconReportSettings PATCH /v1/econ-report-settings Bulk partial update by `name`. PATCH never inserts; no match produces a per-record 404 and multiple matches produce a collision error. Omitted `headers`, `allWellsAgg`, and `rollUpEachLevel` remain unchanged. A provided `headers` array replaces the entire ordered list.
PostEconReportSettings POST /v1/econ-report-settings Create one or more company-shared econ report settings. A single object is coerced to a one-item array and the response is always 207 Multi-Status. Names must be unique for external-API writes. Headers are ordered, limited to five, and membership-validated. Omitted `headers` becomes an empty array; omitted aggregation booleans are not persisted and use their read defaults.
PutEconReportSettings PUT /v1/econ-report-settings Bulk upsert by `name`. A single match is fully replaced, no match is inserted, and multiple matches produce a per-record collision error. Omitted `headers` becomes an empty array. Omitted aggregation booleans are removed so their read defaults apply. Duplicate names in one request are rejected.

DeleteEconReportSettingsById

void DeleteEconReportSettingsById (string id)

Delete a single econ report setting by id.

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 DeleteEconReportSettingsByIdExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var id = "id_example";  // string | The econ report setting's id.

            try
            {
                // Delete a single econ report setting by id.
                apiInstance.DeleteEconReportSettingsById(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.DeleteEconReportSettingsById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The econ report setting's id.  

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | No Content | * X-Delete-Count - The number of records that were deleted. | | 400 | Bad Request. There is something wrong with the request data. | - | | 404 | Not Found | - |

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

GetEconReportSettings

ICollection<EconReportSetting> GetEconReportSettings (int? skip = null, int? take = null, string cursor = null, string name = null, DateTimeOffset? createdAt = null, DateTimeOffset? updatedAt = null)

Returns the list of econ report settings in the tenant. Econ report settings are company-shared: reads return every setting regardless of who created it. Absent allWellsAgg values are returned as true, and absent rollUpEachLevel values are returned as false.

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 GetEconReportSettingsExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 25) (between 1 and 200)
            var cursor = "cursor_example";  // string | used in pagination to get the next page (optional)
            var name = "name_example";  // string | Filter by exact name. (optional)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | Filter by createdAt timestamp. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | Filter by updatedAt timestamp. (optional)

            try
            {
                // Returns the list of econ report settings in the tenant. Econ report settings are company-shared: reads return every setting regardless of who created it. Absent `allWellsAgg` values are returned as `true`, and absent `rollUpEachLevel` values are returned as `false`.
                ICollection<EconReportSetting> result = apiInstance.GetEconReportSettings(skip, take, cursor, name, createdAt, updatedAt);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.GetEconReportSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 25] [between 1 and 200]
cursor string used in pagination to get the next page [optional]
name string Filter by exact name. [optional]
createdAt DateTimeOffset? Filter by createdAt timestamp. [optional]
updatedAt DateTimeOffset? Filter by updatedAt timestamp. [optional]

Return type

ICollection<EconReportSetting>

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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

GetEconReportSettingsById

EconReportSetting GetEconReportSettingsById (string id)

Returns a single econ report setting by id.

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 GetEconReportSettingsByIdExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var id = "id_example";  // string | The econ report setting's id.

            try
            {
                // Returns a single econ report setting by id.
                EconReportSetting result = apiInstance.GetEconReportSettingsById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.GetEconReportSettingsById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The econ report setting's id.  

Return type

EconReportSetting

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | - | | 400 | Bad Request. There is something wrong with the request data. | - | | 404 | Not Found | - |

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

HeadEconReportSettings

void HeadEconReportSettings (int? skip = null, int? take = null, string name = null, DateTimeOffset? createdAt = null, DateTimeOffset? updatedAt = null)

Returns metadata about the existing econ report setting documents (count and pagination links) without a body. Supports the same filters as GET.

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 HeadEconReportSettingsExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 25) (between 1 and 200)
            var name = "name_example";  // string | Filter by exact name. (optional)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | Filter by createdAt timestamp. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | Filter by updatedAt timestamp. (optional)

            try
            {
                // Returns metadata about the existing econ report setting documents (count and pagination links) without a body. Supports the same filters as GET.
                apiInstance.HeadEconReportSettings(skip, take, name, createdAt, updatedAt);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.HeadEconReportSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 25] [between 1 and 200]
name string Filter by exact name. [optional]
createdAt DateTimeOffset? Filter by createdAt timestamp. [optional]
updatedAt DateTimeOffset? Filter by updatedAt timestamp. [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * X-Query-Count - The number of records in this resource. When filters are provided only matching records are counted.
* Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | Bad Request. There is something wrong with the request data. | - |

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

PatchEconReportSettings

EconReportSettingMultiStatusResponse PatchEconReportSettings (List econReportSettings)

Bulk partial update by name. PATCH never inserts; no match produces a per-record 404 and multiple matches produce a collision error. Omitted headers, allWellsAgg, and rollUpEachLevel remain unchanged. A provided headers array replaces the entire ordered list.

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 PatchEconReportSettingsExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var econReportSettings = new List<EconReportSettingInput>(); // List<EconReportSettingInput> | A single econ report setting patch or an array of patches.

            try
            {
                // Bulk partial update by `name`. PATCH never inserts; no match produces a per-record 404 and multiple matches produce a collision error. Omitted `headers`, `allWellsAgg`, and `rollUpEachLevel` remain unchanged. A provided `headers` array replaces the entire ordered list.
                EconReportSettingMultiStatusResponse result = apiInstance.PatchEconReportSettings(econReportSettings);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.PatchEconReportSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
econReportSettings List<EconReportSettingInput> A single econ report setting patch or an array of patches. [Max number of items is 100]

Return type

EconReportSettingMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 400 | Bad Request. There is something wrong with the request data. | - |

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

PostEconReportSettings

EconReportSettingMultiStatusResponse PostEconReportSettings (List econReportSettings)

Create one or more company-shared econ report settings. A single object is coerced to a one-item array and the response is always 207 Multi-Status. Names must be unique for external-API writes. Headers are ordered, limited to five, and membership-validated. Omitted headers becomes an empty array; omitted aggregation booleans are not persisted and use their read defaults.

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 PostEconReportSettingsExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var econReportSettings = new List<EconReportSettingInput>(); // List<EconReportSettingInput> | A single econ report setting or an array of settings.

            try
            {
                // Create one or more company-shared econ report settings. A single object is coerced to a one-item array and the response is always 207 Multi-Status. Names must be unique for external-API writes. Headers are ordered, limited to five, and membership-validated. Omitted `headers` becomes an empty array; omitted aggregation booleans are not persisted and use their read defaults.
                EconReportSettingMultiStatusResponse result = apiInstance.PostEconReportSettings(econReportSettings);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.PostEconReportSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
econReportSettings List<EconReportSettingInput> A single econ report setting or an array of settings. [Max number of items is 100]

Return type

EconReportSettingMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 400 | Bad Request. There is something wrong with the request data. | - |

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

PutEconReportSettings

EconReportSettingMultiStatusResponse PutEconReportSettings (List econReportSettings)

Bulk upsert by name. A single match is fully replaced, no match is inserted, and multiple matches produce a per-record collision error. Omitted headers becomes an empty array. Omitted aggregation booleans are removed so their read defaults apply. Duplicate names in one request are rejected.

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 PutEconReportSettingsExample
    {
        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 EconReportSettingsApi(serviceAccount, apiKey);

            var econReportSettings = new List<EconReportSettingInput>(); // List<EconReportSettingInput> | A single econ report setting or an array of settings.

            try
            {
                // Bulk upsert by `name`. A single match is fully replaced, no match is inserted, and multiple matches produce a per-record collision error. Omitted `headers` becomes an empty array. Omitted aggregation booleans are removed so their read defaults apply. Duplicate names in one request are rejected.
                EconReportSettingMultiStatusResponse result = apiInstance.PutEconReportSettings(econReportSettings);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EconReportSettingsApi.PutEconReportSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
econReportSettings List<EconReportSettingInput> A single econ report setting or an array of settings. [Max number of items is 100]

Return type

EconReportSettingMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 400 | Bad Request. There is something wrong with the request data. | - |

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