oci-lockbox 2.84.0 → 2.85.0

package/lib/client.d.ts

@@ -88,222 +88,235 @@ export declare class LockboxClient {
      * Shutdown the circuit breaker used by the client when it is no longer needed
      */
     shutdownCircuitBreaker(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
     /**
      * Cancels the work request with the given ID.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CancelWorkRequestRequest
      * @return CancelWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
      */
     cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
     /**
      * Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ChangeApprovalTemplateCompartmentRequest
      * @return ChangeApprovalTemplateCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ChangeApprovalTemplateCompartment.ts.html |here} to see how to use ChangeApprovalTemplateCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ChangeApprovalTemplateCompartment.ts.html |here} to see how to use ChangeApprovalTemplateCompartment API.
      */
     changeApprovalTemplateCompartment(changeApprovalTemplateCompartmentRequest: requests.ChangeApprovalTemplateCompartmentRequest): Promise<responses.ChangeApprovalTemplateCompartmentResponse>;
     /**
      * Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ChangeLockboxCompartmentRequest
      * @return ChangeLockboxCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ChangeLockboxCompartment.ts.html |here} to see how to use ChangeLockboxCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ChangeLockboxCompartment.ts.html |here} to see how to use ChangeLockboxCompartment API.
      */
     changeLockboxCompartment(changeLockboxCompartmentRequest: requests.ChangeLockboxCompartmentRequest): Promise<responses.ChangeLockboxCompartmentResponse>;
     /**
      * Creates a new access request.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateAccessRequestRequest
      * @return CreateAccessRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/CreateAccessRequest.ts.html |here} to see how to use CreateAccessRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/CreateAccessRequest.ts.html |here} to see how to use CreateAccessRequest API.
      */
     createAccessRequest(createAccessRequestRequest: requests.CreateAccessRequestRequest): Promise<responses.CreateAccessRequestResponse>;
     /**
      * Creates a new approval template.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateApprovalTemplateRequest
      * @return CreateApprovalTemplateResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/CreateApprovalTemplate.ts.html |here} to see how to use CreateApprovalTemplate API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/CreateApprovalTemplate.ts.html |here} to see how to use CreateApprovalTemplate API.
      */
     createApprovalTemplate(createApprovalTemplateRequest: requests.CreateApprovalTemplateRequest): Promise<responses.CreateApprovalTemplateResponse>;
     /**
      * Creates a new Lockbox.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateLockboxRequest
      * @return CreateLockboxResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/CreateLockbox.ts.html |here} to see how to use CreateLockbox API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/CreateLockbox.ts.html |here} to see how to use CreateLockbox API.
      */
     createLockbox(createLockboxRequest: requests.CreateLockboxRequest): Promise<responses.CreateLockboxResponse>;
     /**
      * Deletes an ApprovalTemplate resource by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DeleteApprovalTemplateRequest
      * @return DeleteApprovalTemplateResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/DeleteApprovalTemplate.ts.html |here} to see how to use DeleteApprovalTemplate API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/DeleteApprovalTemplate.ts.html |here} to see how to use DeleteApprovalTemplate API.
      */
     deleteApprovalTemplate(deleteApprovalTemplateRequest: requests.DeleteApprovalTemplateRequest): Promise<responses.DeleteApprovalTemplateResponse>;
     /**
      * Deletes a Lockbox resource by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DeleteLockboxRequest
      * @return DeleteLockboxResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/DeleteLockbox.ts.html |here} to see how to use DeleteLockbox API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/DeleteLockbox.ts.html |here} to see how to use DeleteLockbox API.
      */
     deleteLockbox(deleteLockboxRequest: requests.DeleteLockboxRequest): Promise<responses.DeleteLockboxResponse>;
     /**
      * Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ExportAccessRequestsRequest
      * @return ExportAccessRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ExportAccessRequests.ts.html |here} to see how to use ExportAccessRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ExportAccessRequests.ts.html |here} to see how to use ExportAccessRequests API.
      */
     exportAccessRequests(exportAccessRequestsRequest: requests.ExportAccessRequestsRequest): Promise<responses.ExportAccessRequestsResponse>;
     /**
      * Retrieves the access credential/material associated with the access request.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetAccessMaterialsRequest
      * @return GetAccessMaterialsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/GetAccessMaterials.ts.html |here} to see how to use GetAccessMaterials API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetAccessMaterials.ts.html |here} to see how to use GetAccessMaterials API.
      */
     getAccessMaterials(getAccessMaterialsRequest: requests.GetAccessMaterialsRequest): Promise<responses.GetAccessMaterialsResponse>;
     /**
      * Retrieves an access request identified by the access request ID.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetAccessRequestRequest
      * @return GetAccessRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/GetAccessRequest.ts.html |here} to see how to use GetAccessRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetAccessRequest.ts.html |here} to see how to use GetAccessRequest API.
      */
     getAccessRequest(getAccessRequestRequest: requests.GetAccessRequestRequest): Promise<responses.GetAccessRequestResponse>;
+    /**
+     * Retrieves an access request identified by the access request ID for internal use.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetAccessRequestInternalRequest
+     * @return GetAccessRequestInternalResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetAccessRequestInternal.ts.html |here} to see how to use GetAccessRequestInternal API.
+     */
+    getAccessRequestInternal(getAccessRequestInternalRequest: requests.GetAccessRequestInternalRequest): Promise<responses.GetAccessRequestInternalResponse>;
     /**
      * Retrieves an approval template identified by the approval template ID.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetApprovalTemplateRequest
      * @return GetApprovalTemplateResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/GetApprovalTemplate.ts.html |here} to see how to use GetApprovalTemplate API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetApprovalTemplate.ts.html |here} to see how to use GetApprovalTemplate API.
      */
     getApprovalTemplate(getApprovalTemplateRequest: requests.GetApprovalTemplateRequest): Promise<responses.GetApprovalTemplateResponse>;
     /**
      * Gets a Lockbox by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetLockboxRequest
      * @return GetLockboxResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/GetLockbox.ts.html |here} to see how to use GetLockbox API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetLockbox.ts.html |here} to see how to use GetLockbox API.
      */
     getLockbox(getLockboxRequest: requests.GetLockboxRequest): Promise<responses.GetLockboxResponse>;
     /**
      * Gets details of the work request with the given ID.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetWorkRequestRequest
      * @return GetWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
      * Handle the AccessRequest
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param HandleAccessRequestRequest
      * @return HandleAccessRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/HandleAccessRequest.ts.html |here} to see how to use HandleAccessRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/HandleAccessRequest.ts.html |here} to see how to use HandleAccessRequest API.
      */
     handleAccessRequest(handleAccessRequestRequest: requests.HandleAccessRequestRequest): Promise<responses.HandleAccessRequestResponse>;
     /**
      * Retrieves a list of AccessRequestSummary objects in a compartment.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListAccessRequestsRequest
      * @return ListAccessRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListAccessRequests.ts.html |here} to see how to use ListAccessRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListAccessRequests.ts.html |here} to see how to use ListAccessRequests API.
      */
     listAccessRequests(listAccessRequestsRequest: requests.ListAccessRequestsRequest): Promise<responses.ListAccessRequestsResponse>;
     /**
      * Retrieves a list of ApprovalTemplateSummary objects in a compartment.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListApprovalTemplatesRequest
      * @return ListApprovalTemplatesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListApprovalTemplates.ts.html |here} to see how to use ListApprovalTemplates API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListApprovalTemplates.ts.html |here} to see how to use ListApprovalTemplates API.
      */
     listApprovalTemplates(listApprovalTemplatesRequest: requests.ListApprovalTemplatesRequest): Promise<responses.ListApprovalTemplatesResponse>;
     /**
      * Returns a list of Lockboxes.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListLockboxesRequest
      * @return ListLockboxesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListLockboxes.ts.html |here} to see how to use ListLockboxes API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListLockboxes.ts.html |here} to see how to use ListLockboxes API.
      */
     listLockboxes(listLockboxesRequest: requests.ListLockboxesRequest): Promise<responses.ListLockboxesResponse>;
     /**
      * Returns a (paginated) list of errors for the work request with the given ID.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListWorkRequestErrorsRequest
      * @return ListWorkRequestErrorsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
      * Returns a (paginated) list of logs for the work request with the given ID.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListWorkRequestLogsRequest
      * @return ListWorkRequestLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
      * Lists the work requests in a compartment.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListWorkRequestsRequest
      * @return ListWorkRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
      * Updates the ApprovalTemplate
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param UpdateApprovalTemplateRequest
      * @return UpdateApprovalTemplateResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/UpdateApprovalTemplate.ts.html |here} to see how to use UpdateApprovalTemplate API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/UpdateApprovalTemplate.ts.html |here} to see how to use UpdateApprovalTemplate API.
      */
     updateApprovalTemplate(updateApprovalTemplateRequest: requests.UpdateApprovalTemplateRequest): Promise<responses.UpdateApprovalTemplateResponse>;
     /**
      * Updates the Lockbox
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param UpdateLockboxRequest
      * @return UpdateLockboxResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.84.0/lockbox/UpdateLockbox.ts.html |here} to see how to use UpdateLockbox API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.85.0/lockbox/UpdateLockbox.ts.html |here} to see how to use UpdateLockbox API.
      */
     updateLockbox(updateLockboxRequest: requests.UpdateLockboxRequest): Promise<responses.UpdateLockboxResponse>;
 }