oci-usageapi 2.74.0 → 2.76.0

package/lib/client.d.ts

@@ -87,7 +87,7 @@ export declare class UsageapiClient {
      * @param CreateCustomTableRequest
      * @return CreateCustomTableResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/CreateCustomTable.ts.html |here} to see how to use CreateCustomTable API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/CreateCustomTable.ts.html |here} to see how to use CreateCustomTable API.
      */
     createCustomTable(createCustomTableRequest: requests.CreateCustomTableRequest): Promise<responses.CreateCustomTableResponse>;
     /**
@@ -97,7 +97,7 @@ export declare class UsageapiClient {
      * @param CreateQueryRequest
      * @return CreateQueryResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/CreateQuery.ts.html |here} to see how to use CreateQuery API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/CreateQuery.ts.html |here} to see how to use CreateQuery API.
      */
     createQuery(createQueryRequest: requests.CreateQueryRequest): Promise<responses.CreateQueryResponse>;
     /**
@@ -107,9 +107,19 @@ export declare class UsageapiClient {
      * @param CreateScheduleRequest
      * @return CreateScheduleResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/CreateSchedule.ts.html |here} to see how to use CreateSchedule API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/CreateSchedule.ts.html |here} to see how to use CreateSchedule API.
      */
     createSchedule(createScheduleRequest: requests.CreateScheduleRequest): Promise<responses.CreateScheduleResponse>;
+    /**
+     * Returns the created usage carbon emissions query.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateUsageCarbonEmissionsQueryRequest
+     * @return CreateUsageCarbonEmissionsQueryResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/CreateUsageCarbonEmissionsQuery.ts.html |here} to see how to use CreateUsageCarbonEmissionsQuery API.
+     */
+    createUsageCarbonEmissionsQuery(createUsageCarbonEmissionsQueryRequest: requests.CreateUsageCarbonEmissionsQueryRequest): Promise<responses.CreateUsageCarbonEmissionsQueryResponse>;
     /**
      * Delete a saved custom table by the OCID.
      *
@@ -117,7 +127,7 @@ export declare class UsageapiClient {
      * @param DeleteCustomTableRequest
      * @return DeleteCustomTableResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/DeleteCustomTable.ts.html |here} to see how to use DeleteCustomTable API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/DeleteCustomTable.ts.html |here} to see how to use DeleteCustomTable API.
      */
     deleteCustomTable(deleteCustomTableRequest: requests.DeleteCustomTableRequest): Promise<responses.DeleteCustomTableResponse>;
     /**
@@ -127,7 +137,7 @@ export declare class UsageapiClient {
      * @param DeleteQueryRequest
      * @return DeleteQueryResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/DeleteQuery.ts.html |here} to see how to use DeleteQuery API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/DeleteQuery.ts.html |here} to see how to use DeleteQuery API.
      */
     deleteQuery(deleteQueryRequest: requests.DeleteQueryRequest): Promise<responses.DeleteQueryResponse>;
     /**
@@ -137,9 +147,19 @@ export declare class UsageapiClient {
      * @param DeleteScheduleRequest
      * @return DeleteScheduleResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/DeleteSchedule.ts.html |here} to see how to use DeleteSchedule API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/DeleteSchedule.ts.html |here} to see how to use DeleteSchedule API.
      */
     deleteSchedule(deleteScheduleRequest: requests.DeleteScheduleRequest): Promise<responses.DeleteScheduleResponse>;
+    /**
+     * Delete a usage carbon emissions saved query by the OCID.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteUsageCarbonEmissionsQueryRequest
+     * @return DeleteUsageCarbonEmissionsQueryResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/DeleteUsageCarbonEmissionsQuery.ts.html |here} to see how to use DeleteUsageCarbonEmissionsQuery API.
+     */
+    deleteUsageCarbonEmissionsQuery(deleteUsageCarbonEmissionsQueryRequest: requests.DeleteUsageCarbonEmissionsQueryRequest): Promise<responses.DeleteUsageCarbonEmissionsQueryResponse>;
     /**
      * Returns the saved custom table.
      *
@@ -147,7 +167,7 @@ export declare class UsageapiClient {
      * @param GetCustomTableRequest
      * @return GetCustomTableResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/GetCustomTable.ts.html |here} to see how to use GetCustomTable API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/GetCustomTable.ts.html |here} to see how to use GetCustomTable API.
      */
     getCustomTable(getCustomTableRequest: requests.GetCustomTableRequest): Promise<responses.GetCustomTableResponse>;
     /**
@@ -157,7 +177,7 @@ export declare class UsageapiClient {
      * @param GetQueryRequest
      * @return GetQueryResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/GetQuery.ts.html |here} to see how to use GetQuery API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/GetQuery.ts.html |here} to see how to use GetQuery API.
      */
     getQuery(getQueryRequest: requests.GetQueryRequest): Promise<responses.GetQueryResponse>;
     /**
@@ -167,7 +187,7 @@ export declare class UsageapiClient {
      * @param GetScheduleRequest
      * @return GetScheduleResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/GetSchedule.ts.html |here} to see how to use GetSchedule API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/GetSchedule.ts.html |here} to see how to use GetSchedule API.
      */
     getSchedule(getScheduleRequest: requests.GetScheduleRequest): Promise<responses.GetScheduleResponse>;
     /**
@@ -177,9 +197,19 @@ export declare class UsageapiClient {
      * @param GetScheduledRunRequest
      * @return GetScheduledRunResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/GetScheduledRun.ts.html |here} to see how to use GetScheduledRun API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/GetScheduledRun.ts.html |here} to see how to use GetScheduledRun API.
      */
     getScheduledRun(getScheduledRunRequest: requests.GetScheduledRunRequest): Promise<responses.GetScheduledRunResponse>;
+    /**
+     * Returns the usage carbon emissions saved query.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetUsageCarbonEmissionsQueryRequest
+     * @return GetUsageCarbonEmissionsQueryResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/GetUsageCarbonEmissionsQuery.ts.html |here} to see how to use GetUsageCarbonEmissionsQuery API.
+     */
+    getUsageCarbonEmissionsQuery(getUsageCarbonEmissionsQueryRequest: requests.GetUsageCarbonEmissionsQueryRequest): Promise<responses.GetUsageCarbonEmissionsQueryResponse>;
     /**
      * Returns the saved custom table list.
      *
@@ -187,7 +217,7 @@ export declare class UsageapiClient {
      * @param ListCustomTablesRequest
      * @return ListCustomTablesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/ListCustomTables.ts.html |here} to see how to use ListCustomTables API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/ListCustomTables.ts.html |here} to see how to use ListCustomTables API.
      */
     listCustomTables(listCustomTablesRequest: requests.ListCustomTablesRequest): Promise<responses.ListCustomTablesResponse>;
     /**
@@ -197,7 +227,7 @@ export declare class UsageapiClient {
      * @param ListQueriesRequest
      * @return ListQueriesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/ListQueries.ts.html |here} to see how to use ListQueries API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/ListQueries.ts.html |here} to see how to use ListQueries API.
      */
     listQueries(listQueriesRequest: requests.ListQueriesRequest): Promise<responses.ListQueriesResponse>;
     /**
@@ -207,7 +237,7 @@ export declare class UsageapiClient {
      * @param ListScheduledRunsRequest
      * @return ListScheduledRunsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/ListScheduledRuns.ts.html |here} to see how to use ListScheduledRuns API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/ListScheduledRuns.ts.html |here} to see how to use ListScheduledRuns API.
      */
     listScheduledRuns(listScheduledRunsRequest: requests.ListScheduledRunsRequest): Promise<responses.ListScheduledRunsResponse>;
     /**
@@ -217,9 +247,39 @@ export declare class UsageapiClient {
      * @param ListSchedulesRequest
      * @return ListSchedulesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/ListSchedules.ts.html |here} to see how to use ListSchedules API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/ListSchedules.ts.html |here} to see how to use ListSchedules API.
      */
     listSchedules(listSchedulesRequest: requests.ListSchedulesRequest): Promise<responses.ListSchedulesResponse>;
+    /**
+     * Returns the usage carbon emissions saved query list.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListUsageCarbonEmissionsQueriesRequest
+     * @return ListUsageCarbonEmissionsQueriesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/ListUsageCarbonEmissionsQueries.ts.html |here} to see how to use ListUsageCarbonEmissionsQueries API.
+     */
+    listUsageCarbonEmissionsQueries(listUsageCarbonEmissionsQueriesRequest: requests.ListUsageCarbonEmissionsQueriesRequest): Promise<responses.ListUsageCarbonEmissionsQueriesResponse>;
+    /**
+     * Returns the average carbon emissions summary by SKU.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param RequestAverageCarbonEmissionRequest
+     * @return RequestAverageCarbonEmissionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestAverageCarbonEmission.ts.html |here} to see how to use RequestAverageCarbonEmission API.
+     */
+    requestAverageCarbonEmission(requestAverageCarbonEmissionRequest: requests.RequestAverageCarbonEmissionRequest): Promise<responses.RequestAverageCarbonEmissionResponse>;
+    /**
+     * Returns the clean energy usage summary by region.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param RequestCleanEnergyUsageRequest
+     * @return RequestCleanEnergyUsageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestCleanEnergyUsage.ts.html |here} to see how to use RequestCleanEnergyUsage API.
+     */
+    requestCleanEnergyUsage(requestCleanEnergyUsageRequest: requests.RequestCleanEnergyUsageRequest): Promise<responses.RequestCleanEnergyUsageResponse>;
     /**
      * Returns the configurations list for the UI drop-down list.
      *
@@ -227,7 +287,7 @@ export declare class UsageapiClient {
      * @param RequestSummarizedConfigurationsRequest
      * @return RequestSummarizedConfigurationsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/RequestSummarizedConfigurations.ts.html |here} to see how to use RequestSummarizedConfigurations API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestSummarizedConfigurations.ts.html |here} to see how to use RequestSummarizedConfigurations API.
      */
     requestSummarizedConfigurations(requestSummarizedConfigurationsRequest: requests.RequestSummarizedConfigurationsRequest): Promise<responses.RequestSummarizedConfigurationsResponse>;
     /**
@@ -237,9 +297,29 @@ export declare class UsageapiClient {
      * @param RequestSummarizedUsagesRequest
      * @return RequestSummarizedUsagesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/RequestSummarizedUsages.ts.html |here} to see how to use RequestSummarizedUsages API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestSummarizedUsages.ts.html |here} to see how to use RequestSummarizedUsages API.
      */
     requestSummarizedUsages(requestSummarizedUsagesRequest: requests.RequestSummarizedUsagesRequest): Promise<responses.RequestSummarizedUsagesResponse>;
+    /**
+     * Returns the configuration list for the UI drop-down list of carbon emission console.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param RequestUsageCarbonEmissionConfigRequest
+     * @return RequestUsageCarbonEmissionConfigResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestUsageCarbonEmissionConfig.ts.html |here} to see how to use RequestUsageCarbonEmissionConfig API.
+     */
+    requestUsageCarbonEmissionConfig(requestUsageCarbonEmissionConfigRequest: requests.RequestUsageCarbonEmissionConfigRequest): Promise<responses.RequestUsageCarbonEmissionConfigResponse>;
+    /**
+     * Returns usage carbon emission for the given account.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param RequestUsageCarbonEmissionsRequest
+     * @return RequestUsageCarbonEmissionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/RequestUsageCarbonEmissions.ts.html |here} to see how to use RequestUsageCarbonEmissions API.
+     */
+    requestUsageCarbonEmissions(requestUsageCarbonEmissionsRequest: requests.RequestUsageCarbonEmissionsRequest): Promise<responses.RequestUsageCarbonEmissionsResponse>;
     /**
      * Update a saved custom table by table id.
      *
@@ -247,7 +327,7 @@ export declare class UsageapiClient {
      * @param UpdateCustomTableRequest
      * @return UpdateCustomTableResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/UpdateCustomTable.ts.html |here} to see how to use UpdateCustomTable API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/UpdateCustomTable.ts.html |here} to see how to use UpdateCustomTable API.
      */
     updateCustomTable(updateCustomTableRequest: requests.UpdateCustomTableRequest): Promise<responses.UpdateCustomTableResponse>;
     /**
@@ -257,7 +337,7 @@ export declare class UsageapiClient {
      * @param UpdateQueryRequest
      * @return UpdateQueryResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/UpdateQuery.ts.html |here} to see how to use UpdateQuery API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/UpdateQuery.ts.html |here} to see how to use UpdateQuery API.
      */
     updateQuery(updateQueryRequest: requests.UpdateQueryRequest): Promise<responses.UpdateQueryResponse>;
     /**
@@ -267,7 +347,17 @@ export declare class UsageapiClient {
      * @param UpdateScheduleRequest
      * @return UpdateScheduleResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.74.0/usageapi/UpdateSchedule.ts.html |here} to see how to use UpdateSchedule API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/UpdateSchedule.ts.html |here} to see how to use UpdateSchedule API.
      */
     updateSchedule(updateScheduleRequest: requests.UpdateScheduleRequest): Promise<responses.UpdateScheduleResponse>;
+    /**
+     * Update a usage carbon emissions saved query by the OCID.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateUsageCarbonEmissionsQueryRequest
+     * @return UpdateUsageCarbonEmissionsQueryResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/usageapi/UpdateUsageCarbonEmissionsQuery.ts.html |here} to see how to use UpdateUsageCarbonEmissionsQuery API.
+     */
+    updateUsageCarbonEmissionsQuery(updateUsageCarbonEmissionsQueryRequest: requests.UpdateUsageCarbonEmissionsQueryRequest): Promise<responses.UpdateUsageCarbonEmissionsQueryResponse>;
 }