oci-limitsincrease 2.126.1

package/lib/client.d.ts

@@ -0,0 +1,236 @@
+/**
+ * Limits Increase API
+ * Use the Limits Increase API to work with limit increase requests.
+For more information, see
+[Working with Limit Increase Requests](https://docs.oracle.com/iaas/Content/General/service-limits/requests.htm).
+
+ * OpenAPI spec version: 20251101
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2026, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { LimitsIncreaseWaiter } from "./limitsincrease-waiter";
+declare const Breaker: any;
+export declare enum LimitsIncreaseApiKeys {
+}
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+export declare class LimitsIncreaseClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": LimitsIncreaseWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    protected _authProvider: common.AuthenticationDetailsProvider | undefined;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Determines whether realm specific endpoint should be used or not.
+     * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Creates a new LimitsIncreaseWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): LimitsIncreaseWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): LimitsIncreaseWaiter;
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Close the provider if possible which in turn shuts down any associated circuit breaker
+     */
+    closeProvider(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
+    /**
+     * Withdraws the specified item from the limit increase request.
+     * For more information, see
+     * [Withdrawing an Item from a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/withdraw-item-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelLimitsIncreaseItemRequestRequest
+     * @return CancelLimitsIncreaseItemRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/CancelLimitsIncreaseItemRequest.ts.html |here} to see how to use CancelLimitsIncreaseItemRequest API.
+     */
+    cancelLimitsIncreaseItemRequest(cancelLimitsIncreaseItemRequestRequest: requests.CancelLimitsIncreaseItemRequestRequest): Promise<responses.CancelLimitsIncreaseItemRequestResponse>;
+    /**
+     * Withdraws the specified limit increase request.
+     * For more information, see
+     * [Withdrawing a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/withdraw-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelLimitsIncreaseRequestRequest
+     * @return CancelLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/CancelLimitsIncreaseRequest.ts.html |here} to see how to use CancelLimitsIncreaseRequest API.
+     */
+    cancelLimitsIncreaseRequest(cancelLimitsIncreaseRequestRequest: requests.CancelLimitsIncreaseRequestRequest): Promise<responses.CancelLimitsIncreaseRequestResponse>;
+    /**
+     * Creates a limit increase request in the specified compartment.
+     * For more information, see
+     * [Creating a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/create-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateLimitsIncreaseRequestRequest
+     * @return CreateLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/CreateLimitsIncreaseRequest.ts.html |here} to see how to use CreateLimitsIncreaseRequest API.
+     */
+    createLimitsIncreaseRequest(createLimitsIncreaseRequestRequest: requests.CreateLimitsIncreaseRequestRequest): Promise<responses.CreateLimitsIncreaseRequestResponse>;
+    /**
+     * Deletes the specified limit increase request.
+     * For more information, see
+     * [Deleting a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/delete-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteLimitsIncreaseRequestRequest
+     * @return DeleteLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/DeleteLimitsIncreaseRequest.ts.html |here} to see how to use DeleteLimitsIncreaseRequest API.
+     */
+    deleteLimitsIncreaseRequest(deleteLimitsIncreaseRequestRequest: requests.DeleteLimitsIncreaseRequestRequest): Promise<responses.DeleteLimitsIncreaseRequestResponse>;
+    /**
+     * Gets the specified item from the limit increase request.
+     * For more information, see
+     * [Getting Details for a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/get-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetLimitsIncreaseItemRequestRequest
+     * @return GetLimitsIncreaseItemRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/GetLimitsIncreaseItemRequest.ts.html |here} to see how to use GetLimitsIncreaseItemRequest API.
+     */
+    getLimitsIncreaseItemRequest(getLimitsIncreaseItemRequestRequest: requests.GetLimitsIncreaseItemRequestRequest): Promise<responses.GetLimitsIncreaseItemRequestResponse>;
+    /**
+     * Gets the specified limit increase request.
+     * For more information, see
+     * [Getting Details for a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/get-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetLimitsIncreaseRequestRequest
+     * @return GetLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/GetLimitsIncreaseRequest.ts.html |here} to see how to use GetLimitsIncreaseRequest API.
+     */
+    getLimitsIncreaseRequest(getLimitsIncreaseRequestRequest: requests.GetLimitsIncreaseRequestRequest): Promise<responses.GetLimitsIncreaseRequestResponse>;
+    /**
+     * Lists items in the specified limit increase request.
+     * For more information, see
+     * [Getting Details for a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/get-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListLimitsIncreaseItemRequestsRequest
+     * @return ListLimitsIncreaseItemRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/ListLimitsIncreaseItemRequests.ts.html |here} to see how to use ListLimitsIncreaseItemRequests API.
+     */
+    listLimitsIncreaseItemRequests(listLimitsIncreaseItemRequestsRequest: requests.ListLimitsIncreaseItemRequestsRequest): Promise<responses.ListLimitsIncreaseItemRequestsResponse>;
+    /**
+     * Gets the fields for the specified service and limit name.
+     * Service name is required if limit name is provided.
+     * If limit name is not provided, returns all questions for the specified service.
+     * If service name is not provided, returns all available questions.
+     * For more information, see
+     * [Creating a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/create-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListLimitsIncreaseQuestionsRequest
+     * @return ListLimitsIncreaseQuestionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/ListLimitsIncreaseQuestions.ts.html |here} to see how to use ListLimitsIncreaseQuestions API.
+     */
+    listLimitsIncreaseQuestions(listLimitsIncreaseQuestionsRequest: requests.ListLimitsIncreaseQuestionsRequest): Promise<responses.ListLimitsIncreaseQuestionsResponse>;
+    /**
+     * Lists limit increase requests in the specified compartment.
+     * For more information, see
+     * [Listing Limit Increase Requests](https://docs.oracle.com/iaas/Content/General/service-limits/list-requests.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListLimitsIncreaseRequestsRequest
+     * @return ListLimitsIncreaseRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/ListLimitsIncreaseRequests.ts.html |here} to see how to use ListLimitsIncreaseRequests API.
+     */
+    listLimitsIncreaseRequests(listLimitsIncreaseRequestsRequest: requests.ListLimitsIncreaseRequestsRequest): Promise<responses.ListLimitsIncreaseRequestsResponse>;
+    /**
+     * Adds one or more comments to the specified limit increase request.
+     * For more information, see
+     * [Adding Comments to a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/comment-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param PatchLimitsIncreaseRequestRequest
+     * @return PatchLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/PatchLimitsIncreaseRequest.ts.html |here} to see how to use PatchLimitsIncreaseRequest API.
+     */
+    patchLimitsIncreaseRequest(patchLimitsIncreaseRequestRequest: requests.PatchLimitsIncreaseRequestRequest): Promise<responses.PatchLimitsIncreaseRequestResponse>;
+    /**
+     * Updates the limit increase request.
+     * For more information, see
+     * [Updating a Limit Increase Request](https://docs.oracle.com/iaas/Content/General/service-limits/update-request.htm).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateLimitsIncreaseRequestRequest
+     * @return UpdateLimitsIncreaseRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/limitsincrease/UpdateLimitsIncreaseRequest.ts.html |here} to see how to use UpdateLimitsIncreaseRequest API.
+     */
+    updateLimitsIncreaseRequest(updateLimitsIncreaseRequestRequest: requests.UpdateLimitsIncreaseRequestRequest): Promise<responses.UpdateLimitsIncreaseRequestResponse>;
+}
+export {};