/** * Announcements Service API * Manage Oracle Cloud Infrastructure console announcements. * OpenAPI spec version: 0.0.1 * * * 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 model from "./model"; import * as responses from "./response"; import { AnnouncementSubscriptionWaiter } from "./announcementsubscription-waiter"; declare const Breaker: any; export declare enum AnnouncementApiKeys { } /** * 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 AnnouncementClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; 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); /** * 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; /** * Gets the details of a specific announcement. *
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param GetAnnouncementRequest
* @return GetAnnouncementResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/GetAnnouncement.ts.html |here} to see how to use GetAnnouncement API.
*/
getAnnouncement(getAnnouncementRequest: requests.GetAnnouncementRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param GetAnnouncementUserStatusRequest
* @return GetAnnouncementUserStatusResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/GetAnnouncementUserStatus.ts.html |here} to see how to use GetAnnouncementUserStatus API.
*/
getAnnouncementUserStatus(getAnnouncementUserStatusRequest: requests.GetAnnouncementUserStatusRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param ListAnnouncementsRequest
* @return ListAnnouncementsResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/ListAnnouncements.ts.html |here} to see how to use ListAnnouncements API.
*/
listAnnouncements(listAnnouncementsRequest: requests.ListAnnouncementsRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param UpdateAnnouncementUserStatusRequest
* @return UpdateAnnouncementUserStatusResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/UpdateAnnouncementUserStatus.ts.html |here} to see how to use UpdateAnnouncementUserStatus API.
*/
updateAnnouncementUserStatus(updateAnnouncementUserStatusRequest: requests.UpdateAnnouncementUserStatusRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param ChangeAnnouncementSubscriptionCompartmentRequest
* @return ChangeAnnouncementSubscriptionCompartmentResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/ChangeAnnouncementSubscriptionCompartment.ts.html |here} to see how to use ChangeAnnouncementSubscriptionCompartment API.
*/
changeAnnouncementSubscriptionCompartment(changeAnnouncementSubscriptionCompartmentRequest: requests.ChangeAnnouncementSubscriptionCompartmentRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param CreateAnnouncementSubscriptionRequest
* @return CreateAnnouncementSubscriptionResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/CreateAnnouncementSubscription.ts.html |here} to see how to use CreateAnnouncementSubscription API.
*/
createAnnouncementSubscription(createAnnouncementSubscriptionRequest: requests.CreateAnnouncementSubscriptionRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param CreateFilterGroupRequest
* @return CreateFilterGroupResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/CreateFilterGroup.ts.html |here} to see how to use CreateFilterGroup API.
*/
createFilterGroup(createFilterGroupRequest: requests.CreateFilterGroupRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param DeleteAnnouncementSubscriptionRequest
* @return DeleteAnnouncementSubscriptionResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/DeleteAnnouncementSubscription.ts.html |here} to see how to use DeleteAnnouncementSubscription API.
*/
deleteAnnouncementSubscription(deleteAnnouncementSubscriptionRequest: requests.DeleteAnnouncementSubscriptionRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param DeleteFilterGroupRequest
* @return DeleteFilterGroupResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/DeleteFilterGroup.ts.html |here} to see how to use DeleteFilterGroup API.
*/
deleteFilterGroup(deleteFilterGroupRequest: requests.DeleteFilterGroupRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param GetAnnouncementSubscriptionRequest
* @return GetAnnouncementSubscriptionResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/GetAnnouncementSubscription.ts.html |here} to see how to use GetAnnouncementSubscription API.
*/
getAnnouncementSubscription(getAnnouncementSubscriptionRequest: requests.GetAnnouncementSubscriptionRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param ListAnnouncementSubscriptionsRequest
* @return ListAnnouncementSubscriptionsResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/ListAnnouncementSubscriptions.ts.html |here} to see how to use ListAnnouncementSubscriptions API.
*/
listAnnouncementSubscriptions(listAnnouncementSubscriptionsRequest: requests.ListAnnouncementSubscriptionsRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param UpdateAnnouncementSubscriptionRequest
* @return UpdateAnnouncementSubscriptionResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/UpdateAnnouncementSubscription.ts.html |here} to see how to use UpdateAnnouncementSubscription API.
*/
updateAnnouncementSubscription(updateAnnouncementSubscriptionRequest: requests.UpdateAnnouncementSubscriptionRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param UpdateFilterGroupRequest
* @return UpdateFilterGroupResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/UpdateFilterGroup.ts.html |here} to see how to use UpdateFilterGroup API.
*/
updateFilterGroup(updateFilterGroupRequest: requests.UpdateFilterGroupRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param CreateAnnouncementsPreferenceRequest
* @return CreateAnnouncementsPreferenceResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/CreateAnnouncementsPreference.ts.html |here} to see how to use CreateAnnouncementsPreference API.
*/
createAnnouncementsPreference(createAnnouncementsPreferenceRequest: requests.CreateAnnouncementsPreferenceRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param GetAnnouncementsPreferenceRequest
* @return GetAnnouncementsPreferenceResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/GetAnnouncementsPreference.ts.html |here} to see how to use GetAnnouncementsPreference API.
*/
getAnnouncementsPreference(getAnnouncementsPreferenceRequest: requests.GetAnnouncementsPreferenceRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param ListAnnouncementsPreferencesRequest
* @return ListAnnouncementsPreferencesResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/ListAnnouncementsPreferences.ts.html |here} to see how to use ListAnnouncementsPreferences API.
*/
listAnnouncementsPreferences(listAnnouncementsPreferencesRequest: requests.ListAnnouncementsPreferencesRequest): Promise
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
*
* This operation does not retry by default if the user has not defined a retry configuration.
* @param UpdateAnnouncementsPreferenceRequest
* @return UpdateAnnouncementsPreferenceResponse
* @throws OciError when an error occurs
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/announcementsservice/UpdateAnnouncementsPreference.ts.html |here} to see how to use UpdateAnnouncementsPreference API.
*/
updateAnnouncementsPreference(updateAnnouncementsPreferenceRequest: requests.UpdateAnnouncementsPreferenceRequest): Promise