oci-announcementsservice 2.13.0 → 2.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/THIRD_PARTY_LICENSES.txt +467 -1412
  2. package/index.d.ts +3 -0
  3. package/index.js +4 -1
  4. package/index.js.map +1 -1
  5. package/lib/announcementsubscription-waiter.d.ts +29 -0
  6. package/lib/announcementsubscription-waiter.js +65 -0
  7. package/lib/announcementsubscription-waiter.js.map +1 -0
  8. package/lib/client.d.ts +240 -61
  9. package/lib/client.js +792 -68
  10. package/lib/client.js.map +1 -1
  11. package/lib/model/announcement-subscription-collection.d.ts +26 -0
  12. package/lib/model/announcement-subscription-collection.js +61 -0
  13. package/lib/model/announcement-subscription-collection.js.map +1 -0
  14. package/lib/model/announcement-subscription-summary.d.ts +84 -0
  15. package/lib/model/announcement-subscription-summary.js +29 -0
  16. package/lib/model/announcement-subscription-summary.js.map +1 -0
  17. package/lib/model/announcement-subscription.d.ts +109 -0
  18. package/lib/model/announcement-subscription.js +69 -0
  19. package/lib/model/announcement-subscription.js.map +1 -0
  20. package/lib/model/base-announcement.d.ts +14 -0
  21. package/lib/model/base-announcement.js +5 -0
  22. package/lib/model/base-announcement.js.map +1 -1
  23. package/lib/model/change-announcement-subscription-compartment-details.d.ts +27 -0
  24. package/lib/model/change-announcement-subscription-compartment-details.js +29 -0
  25. package/lib/model/change-announcement-subscription-compartment-details.js.map +1 -0
  26. package/lib/model/create-announcement-subscription-details.d.ts +65 -0
  27. package/lib/model/create-announcement-subscription-details.js +58 -0
  28. package/lib/model/create-announcement-subscription-details.js.map +1 -0
  29. package/lib/model/create-filter-group-details.d.ts +30 -0
  30. package/lib/model/create-filter-group-details.js +61 -0
  31. package/lib/model/create-filter-group-details.js.map +1 -0
  32. package/lib/model/filter-group-details.d.ts +26 -0
  33. package/lib/model/filter-group-details.js +61 -0
  34. package/lib/model/filter-group-details.js.map +1 -0
  35. package/lib/model/filter-group.d.ts +30 -0
  36. package/lib/model/filter-group.js +61 -0
  37. package/lib/model/filter-group.js.map +1 -0
  38. package/lib/model/filter.d.ts +42 -0
  39. package/lib/model/filter.js +43 -0
  40. package/lib/model/filter.js.map +1 -0
  41. package/lib/model/index.d.ts +24 -0
  42. package/lib/model/index.js +25 -1
  43. package/lib/model/index.js.map +1 -1
  44. package/lib/model/sort-order.d.ts +23 -0
  45. package/lib/model/sort-order.js +34 -0
  46. package/lib/model/sort-order.js.map +1 -0
  47. package/lib/model/update-announcement-subscription-details.d.ts +52 -0
  48. package/lib/model/update-announcement-subscription-details.js +29 -0
  49. package/lib/model/update-announcement-subscription-details.js.map +1 -0
  50. package/lib/model/update-filter-group-details.d.ts +26 -0
  51. package/lib/model/update-filter-group-details.js +61 -0
  52. package/lib/model/update-filter-group-details.js.map +1 -0
  53. package/lib/request/change-announcement-subscription-compartment-request.d.ts +37 -0
  54. package/lib/request/change-announcement-subscription-compartment-request.js +15 -0
  55. package/lib/request/change-announcement-subscription-compartment-request.js.map +1 -0
  56. package/lib/request/create-announcement-subscription-request.d.ts +38 -0
  57. package/lib/request/create-announcement-subscription-request.js +15 -0
  58. package/lib/request/create-announcement-subscription-request.js.map +1 -0
  59. package/lib/request/create-announcements-preference-request.d.ts +1 -1
  60. package/lib/request/create-filter-group-request.d.ts +46 -0
  61. package/lib/request/create-filter-group-request.js +15 -0
  62. package/lib/request/create-filter-group-request.js.map +1 -0
  63. package/lib/request/delete-announcement-subscription-request.d.ts +32 -0
  64. package/lib/request/delete-announcement-subscription-request.js +15 -0
  65. package/lib/request/delete-announcement-subscription-request.js.map +1 -0
  66. package/lib/request/delete-filter-group-request.d.ts +36 -0
  67. package/lib/request/delete-filter-group-request.js +15 -0
  68. package/lib/request/delete-filter-group-request.js.map +1 -0
  69. package/lib/request/get-announcement-request.d.ts +1 -1
  70. package/lib/request/get-announcement-subscription-request.d.ts +28 -0
  71. package/lib/request/get-announcement-subscription-request.js +15 -0
  72. package/lib/request/get-announcement-subscription-request.js.map +1 -0
  73. package/lib/request/get-announcement-user-status-request.d.ts +1 -1
  74. package/lib/request/get-announcements-preference-request.d.ts +1 -1
  75. package/lib/request/index.d.ts +18 -0
  76. package/lib/request/index.js +3 -1
  77. package/lib/request/index.js.map +1 -1
  78. package/lib/request/list-announcement-subscriptions-request.d.ts +65 -0
  79. package/lib/request/list-announcement-subscriptions-request.js +24 -0
  80. package/lib/request/list-announcement-subscriptions-request.js.map +1 -0
  81. package/lib/request/list-announcements-preferences-request.d.ts +2 -3
  82. package/lib/request/list-announcements-request.d.ts +22 -3
  83. package/lib/request/list-announcements-request.js +5 -0
  84. package/lib/request/list-announcements-request.js.map +1 -1
  85. package/lib/request/update-announcement-subscription-request.d.ts +37 -0
  86. package/lib/request/update-announcement-subscription-request.js +15 -0
  87. package/lib/request/update-announcement-subscription-request.js.map +1 -0
  88. package/lib/request/update-announcement-user-status-request.d.ts +1 -1
  89. package/lib/request/update-announcements-preference-request.d.ts +1 -1
  90. package/lib/request/update-filter-group-request.d.ts +41 -0
  91. package/lib/request/update-filter-group-request.js +15 -0
  92. package/lib/request/update-filter-group-request.js.map +1 -0
  93. package/lib/response/change-announcement-subscription-compartment-response.d.ts +25 -0
  94. package/lib/response/change-announcement-subscription-compartment-response.js +15 -0
  95. package/lib/response/change-announcement-subscription-compartment-response.js.map +1 -0
  96. package/lib/response/create-announcement-subscription-response.d.ts +30 -0
  97. package/lib/response/create-announcement-subscription-response.js +15 -0
  98. package/lib/response/create-announcement-subscription-response.js.map +1 -0
  99. package/lib/response/create-announcements-preference-response.d.ts +3 -0
  100. package/lib/response/create-filter-group-response.d.ts +30 -0
  101. package/lib/response/create-filter-group-response.js +15 -0
  102. package/lib/response/create-filter-group-response.js.map +1 -0
  103. package/lib/response/delete-announcement-subscription-response.d.ts +20 -0
  104. package/lib/response/delete-announcement-subscription-response.js +15 -0
  105. package/lib/response/delete-announcement-subscription-response.js.map +1 -0
  106. package/lib/response/delete-filter-group-response.d.ts +25 -0
  107. package/lib/response/delete-filter-group-response.js +15 -0
  108. package/lib/response/delete-filter-group-response.js.map +1 -0
  109. package/lib/response/get-announcement-response.d.ts +8 -1
  110. package/lib/response/get-announcement-subscription-response.d.ts +30 -0
  111. package/lib/response/get-announcement-subscription-response.js +15 -0
  112. package/lib/response/get-announcement-subscription-response.js.map +1 -0
  113. package/lib/response/get-announcement-user-status-response.d.ts +8 -1
  114. package/lib/response/get-announcements-preference-response.d.ts +7 -0
  115. package/lib/response/index.d.ts +18 -0
  116. package/lib/response/list-announcement-subscriptions-response.d.ts +32 -0
  117. package/lib/response/list-announcement-subscriptions-response.js +15 -0
  118. package/lib/response/list-announcement-subscriptions-response.js.map +1 -0
  119. package/lib/response/list-announcements-preferences-response.d.ts +5 -0
  120. package/lib/response/list-announcements-response.d.ts +13 -2
  121. package/lib/response/update-announcement-subscription-response.d.ts +30 -0
  122. package/lib/response/update-announcement-subscription-response.js +15 -0
  123. package/lib/response/update-announcement-subscription-response.js.map +1 -0
  124. package/lib/response/update-announcement-user-status-response.d.ts +9 -1
  125. package/lib/response/update-announcements-preference-response.d.ts +3 -0
  126. package/lib/response/update-filter-group-response.d.ts +30 -0
  127. package/lib/response/update-filter-group-response.js +15 -0
  128. package/lib/response/update-filter-group-response.js.map +1 -0
  129. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -14,8 +14,11 @@ import * as requests from "./lib/request";
14
14
  import * as models from "./lib/model";
15
15
  import * as responses from "./lib/response";
16
16
  import * as client from "./lib/client";
17
+ import * as announcementsubscription_waiter from "./lib/announcementsubscription-waiter";
17
18
  export { models };
18
19
  export { requests };
19
20
  export { responses };
20
21
  export import AnnouncementClient = client.AnnouncementClient;
22
+ export import AnnouncementSubscriptionClient = client.AnnouncementSubscriptionClient;
23
+ export import AnnouncementSubscriptionWaiter = announcementsubscription_waiter.AnnouncementSubscriptionWaiter;
21
24
  export import AnnouncementsPreferencesClient = client.AnnouncementsPreferencesClient;
package/index.js CHANGED
@@ -31,7 +31,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
31
31
  return result;
32
32
  };
33
33
  Object.defineProperty(exports, "__esModule", { value: true });
34
- exports.AnnouncementsPreferencesClient = exports.AnnouncementClient = exports.responses = exports.requests = exports.models = void 0;
34
+ exports.AnnouncementsPreferencesClient = exports.AnnouncementSubscriptionWaiter = exports.AnnouncementSubscriptionClient = exports.AnnouncementClient = exports.responses = exports.requests = exports.models = void 0;
35
35
  const requests = __importStar(require("./lib/request"));
36
36
  exports.requests = requests;
37
37
  const models = __importStar(require("./lib/model"));
@@ -39,6 +39,9 @@ exports.models = models;
39
39
  const responses = __importStar(require("./lib/response"));
40
40
  exports.responses = responses;
41
41
  const client = __importStar(require("./lib/client"));
42
+ const announcementsubscription_waiter = __importStar(require("./lib/announcementsubscription-waiter"));
42
43
  exports.AnnouncementClient = client.AnnouncementClient;
44
+ exports.AnnouncementSubscriptionClient = client.AnnouncementSubscriptionClient;
45
+ exports.AnnouncementSubscriptionWaiter = announcementsubscription_waiter.AnnouncementSubscriptionWaiter;
43
46
  exports.AnnouncementsPreferencesClient = client.AnnouncementsPreferencesClient;
44
47
  //# sourceMappingURL=index.js.map
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/announcementsservice/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,8BAA8B,GAAG,MAAM,CAAC,8BAA8B,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/announcementsservice/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,uGAAyF;AAK3E,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,8BAA8B,GAAG,MAAM,CAAC,8BAA8B,CAAC;AACvE,QAAA,8BAA8B,GAAG,+BAA+B,CAAC,8BAA8B,CAAC;AAChG,QAAA,8BAA8B,GAAG,MAAM,CAAC,8BAA8B,CAAC"}
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Announcements Service API
3
+ * Manage Oracle Cloud Infrastructure console announcements.
4
+ * OpenAPI spec version: 0.0.1
5
+ *
6
+ *
7
+ * NOTE: This class is auto generated by OracleSDKGenerator.
8
+ * Do not edit the class manually.
9
+ *
10
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
11
+ * 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.
12
+ */
13
+ import * as serviceRequests from "./request";
14
+ import * as serviceResponses from "./response";
15
+ import * as models from "./model";
16
+ import { AnnouncementSubscriptionClient } from "./client";
17
+ export declare class AnnouncementSubscriptionWaiter {
18
+ private client;
19
+ private readonly config?;
20
+ constructor(client: AnnouncementSubscriptionClient, config?: Partial<import("oci-common/lib/waiter").WaiterConfigurationDetails> | undefined);
21
+ /**
22
+ * Waits forAnnouncementSubscription till it reaches any of the provided states
23
+ *
24
+ * @param request the request to send
25
+ * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
26
+ * @return response returns GetAnnouncementSubscriptionResponse | null (null in case of 404 response)
27
+ */
28
+ forAnnouncementSubscription(request: serviceRequests.GetAnnouncementSubscriptionRequest, ...targetStates: models.AnnouncementSubscription.LifecycleState[]): Promise<serviceResponses.GetAnnouncementSubscriptionResponse | null>;
29
+ }
@@ -0,0 +1,65 @@
1
+ "use strict";
2
+ /**
3
+ * Announcements Service API
4
+ * Manage Oracle Cloud Infrastructure console announcements.
5
+ * OpenAPI spec version: 0.0.1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OracleSDKGenerator.
9
+ * Do not edit the class manually.
10
+ *
11
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
12
+ * 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.
13
+ */
14
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
15
+ if (k2 === undefined) k2 = k;
16
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
17
+ }) : (function(o, m, k, k2) {
18
+ if (k2 === undefined) k2 = k;
19
+ o[k2] = m[k];
20
+ }));
21
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
22
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
23
+ }) : function(o, v) {
24
+ o["default"] = v;
25
+ });
26
+ var __importStar = (this && this.__importStar) || function (mod) {
27
+ if (mod && mod.__esModule) return mod;
28
+ var result = {};
29
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
30
+ __setModuleDefault(result, mod);
31
+ return result;
32
+ };
33
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
34
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
35
+ return new (P || (P = Promise))(function (resolve, reject) {
36
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
37
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
38
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
39
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
40
+ });
41
+ };
42
+ Object.defineProperty(exports, "__esModule", { value: true });
43
+ exports.AnnouncementSubscriptionWaiter = void 0;
44
+ const models = __importStar(require("./model"));
45
+ const oci_common_1 = require("oci-common");
46
+ class AnnouncementSubscriptionWaiter {
47
+ constructor(client, config) {
48
+ this.client = client;
49
+ this.config = config;
50
+ }
51
+ /**
52
+ * Waits forAnnouncementSubscription till it reaches any of the provided states
53
+ *
54
+ * @param request the request to send
55
+ * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
56
+ * @return response returns GetAnnouncementSubscriptionResponse | null (null in case of 404 response)
57
+ */
58
+ forAnnouncementSubscription(request, ...targetStates) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ return oci_common_1.genericTerminalConditionWaiter(this.config, () => this.client.getAnnouncementSubscription(request), response => targetStates.includes(response.announcementSubscription.lifecycleState), targetStates.includes(models.AnnouncementSubscription.LifecycleState.Deleted));
61
+ });
62
+ }
63
+ }
64
+ exports.AnnouncementSubscriptionWaiter = AnnouncementSubscriptionWaiter;
65
+ //# sourceMappingURL=announcementsubscription-waiter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"announcementsubscription-waiter.js","sourceRoot":"","sources":["../../../../lib/announcementsservice/lib/announcementsubscription-waiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,gDAAkC;AAElC,2CAAgG;AAEhG,MAAa,8BAA8B;IACzC,YACU,MAAsC,EAC7B,MAA4B;QADrC,WAAM,GAAN,MAAM,CAAgC;QAC7B,WAAM,GAAN,MAAM,CAAsB;IAC5C,CAAC;IAEJ;;;;;;OAMG;IACU,2BAA2B,CACtC,OAA2D,EAC3D,GAAG,YAA8D;;YAEjE,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,OAAO,CAAC,EACtD,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,wBAAwB,CAAC,cAAe,CAAC,EACpF,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,wBAAwB,CAAC,cAAc,CAAC,OAAO,CAAC,CAC9E,CAAC;QACJ,CAAC;KAAA;CACF;AAxBD,wEAwBC"}
package/lib/client.d.ts CHANGED
@@ -14,6 +14,7 @@ import common = require("oci-common");
14
14
  import * as requests from "./request";
15
15
  import * as model from "./model";
16
16
  import * as responses from "./response";
17
+ import { AnnouncementSubscriptionWaiter } from "./announcementsubscription-waiter";
17
18
  export declare enum AnnouncementApiKeys {
18
19
  }
19
20
  /**
@@ -54,45 +55,215 @@ export declare class AnnouncementClient {
54
55
  */
55
56
  set regionId(regionId: string);
56
57
  /**
57
- * Gets the details of a specific announcement.
58
- *
59
- * This operation does not retry by default if the user has not defined a retry configuration.
60
- * @param GetAnnouncementRequest
61
- * @return GetAnnouncementResponse
62
- * @throws OciError when an error occurs
63
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/GetAnnouncement.ts.html |here} to see how to use GetAnnouncement API.
64
- */
58
+ * Gets the details of a specific announcement.
59
+ * <p>
60
+ 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.
61
+ *
62
+ * This operation does not retry by default if the user has not defined a retry configuration.
63
+ * @param GetAnnouncementRequest
64
+ * @return GetAnnouncementResponse
65
+ * @throws OciError when an error occurs
66
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/GetAnnouncement.ts.html |here} to see how to use GetAnnouncement API.
67
+ */
65
68
  getAnnouncement(getAnnouncementRequest: requests.GetAnnouncementRequest): Promise<responses.GetAnnouncementResponse>;
66
69
  /**
67
- * Gets information about whether a specific announcement was acknowledged by a user.
70
+ * Gets information about whether a specific announcement was acknowledged by a user.
71
+ * <p>
72
+ 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.
73
+ *
74
+ * This operation does not retry by default if the user has not defined a retry configuration.
75
+ * @param GetAnnouncementUserStatusRequest
76
+ * @return GetAnnouncementUserStatusResponse
77
+ * @throws OciError when an error occurs
78
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/GetAnnouncementUserStatus.ts.html |here} to see how to use GetAnnouncementUserStatus API.
79
+ */
80
+ getAnnouncementUserStatus(getAnnouncementUserStatusRequest: requests.GetAnnouncementUserStatusRequest): Promise<responses.GetAnnouncementUserStatusResponse>;
81
+ /**
82
+ * Gets a list of announcements for the current tenancy.
83
+ * <p>
84
+ 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.
85
+ *
86
+ * This operation does not retry by default if the user has not defined a retry configuration.
87
+ * @param ListAnnouncementsRequest
88
+ * @return ListAnnouncementsResponse
89
+ * @throws OciError when an error occurs
90
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/ListAnnouncements.ts.html |here} to see how to use ListAnnouncements API.
91
+ */
92
+ listAnnouncements(listAnnouncementsRequest: requests.ListAnnouncementsRequest): Promise<responses.ListAnnouncementsResponse>;
93
+ /**
94
+ * Updates the status of the specified announcement with regard to whether it has been marked as read.
95
+ * <p>
96
+ 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.
97
+ *
98
+ * This operation does not retry by default if the user has not defined a retry configuration.
99
+ * @param UpdateAnnouncementUserStatusRequest
100
+ * @return UpdateAnnouncementUserStatusResponse
101
+ * @throws OciError when an error occurs
102
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/UpdateAnnouncementUserStatus.ts.html |here} to see how to use UpdateAnnouncementUserStatus API.
103
+ */
104
+ updateAnnouncementUserStatus(updateAnnouncementUserStatusRequest: requests.UpdateAnnouncementUserStatusRequest): Promise<responses.UpdateAnnouncementUserStatusResponse>;
105
+ }
106
+ export declare enum AnnouncementSubscriptionApiKeys {
107
+ }
108
+ /**
109
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
110
+ */
111
+ export declare class AnnouncementSubscriptionClient {
112
+ protected static serviceEndpointTemplate: string;
113
+ protected static endpointServiceName: string;
114
+ protected "_endpoint": string;
115
+ protected "_defaultHeaders": any;
116
+ protected "_waiters": AnnouncementSubscriptionWaiter;
117
+ protected "_clientConfiguration": common.ClientConfiguration;
118
+ protected _circuitBreaker: null;
119
+ protected _httpClient: common.HttpClient;
120
+ constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
121
+ /**
122
+ * Get the endpoint that is being used to call (ex, https://www.example.com).
123
+ */
124
+ get endpoint(): string;
125
+ /**
126
+ * Sets the endpoint to call (ex, https://www.example.com).
127
+ * @param endpoint The endpoint of the service.
128
+ */
129
+ set endpoint(endpoint: string);
130
+ get logger(): import("oci-common/lib/log").Logger;
131
+ /**
132
+ * Sets the region to call (ex, Region.US_PHOENIX_1).
133
+ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
134
+ * @param region The region of the service.
135
+ */
136
+ set region(region: common.Region);
137
+ /**
138
+ * Sets the regionId to call (ex, 'us-phoenix-1').
68
139
  *
69
- * This operation does not retry by default if the user has not defined a retry configuration.
70
- * @param GetAnnouncementUserStatusRequest
71
- * @return GetAnnouncementUserStatusResponse
72
- * @throws OciError when an error occurs
73
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/GetAnnouncementUserStatus.ts.html |here} to see how to use GetAnnouncementUserStatus API.
140
+ * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
141
+ * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
142
+ * and then call {@link #endpoint(String) endpoint}.
143
+ * @param regionId The public region ID.
74
144
  */
75
- getAnnouncementUserStatus(getAnnouncementUserStatusRequest: requests.GetAnnouncementUserStatusRequest): Promise<responses.GetAnnouncementUserStatusResponse>;
145
+ set regionId(regionId: string);
76
146
  /**
77
- * Gets a list of announcements for the current tenancy.
147
+ * Creates a new AnnouncementSubscriptionWaiter for resources for this service.
78
148
  *
79
- * This operation does not retry by default if the user has not defined a retry configuration.
80
- * @param ListAnnouncementsRequest
81
- * @return ListAnnouncementsResponse
82
- * @throws OciError when an error occurs
83
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/ListAnnouncements.ts.html |here} to see how to use ListAnnouncements API.
149
+ * @param config The waiter configuration for termination and delay strategy
150
+ * @return The service waiters.
84
151
  */
85
- listAnnouncements(listAnnouncementsRequest: requests.ListAnnouncementsRequest): Promise<responses.ListAnnouncementsResponse>;
152
+ createWaiters(config?: common.WaiterConfiguration): AnnouncementSubscriptionWaiter;
86
153
  /**
87
- * Updates the status of the specified announcement with regard to whether it has been marked as read.
154
+ * Gets the waiters available for resources for this service.
88
155
  *
89
- * This operation does not retry by default if the user has not defined a retry configuration.
90
- * @param UpdateAnnouncementUserStatusRequest
91
- * @return UpdateAnnouncementUserStatusResponse
92
- * @throws OciError when an error occurs
93
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/UpdateAnnouncementUserStatus.ts.html |here} to see how to use UpdateAnnouncementUserStatus API.
156
+ * @return The service waiters.
94
157
  */
95
- updateAnnouncementUserStatus(updateAnnouncementUserStatusRequest: requests.UpdateAnnouncementUserStatusRequest): Promise<responses.UpdateAnnouncementUserStatusResponse>;
158
+ getWaiters(): AnnouncementSubscriptionWaiter;
159
+ /**
160
+ * Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.
161
+ * <p>
162
+ 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.
163
+ *
164
+ * This operation does not retry by default if the user has not defined a retry configuration.
165
+ * @param ChangeAnnouncementSubscriptionCompartmentRequest
166
+ * @return ChangeAnnouncementSubscriptionCompartmentResponse
167
+ * @throws OciError when an error occurs
168
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/ChangeAnnouncementSubscriptionCompartment.ts.html |here} to see how to use ChangeAnnouncementSubscriptionCompartment API.
169
+ */
170
+ changeAnnouncementSubscriptionCompartment(changeAnnouncementSubscriptionCompartmentRequest: requests.ChangeAnnouncementSubscriptionCompartmentRequest): Promise<responses.ChangeAnnouncementSubscriptionCompartmentResponse>;
171
+ /**
172
+ * Creates a new announcement subscription.
173
+ * <p>
174
+ 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.
175
+ *
176
+ * This operation does not retry by default if the user has not defined a retry configuration.
177
+ * @param CreateAnnouncementSubscriptionRequest
178
+ * @return CreateAnnouncementSubscriptionResponse
179
+ * @throws OciError when an error occurs
180
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/CreateAnnouncementSubscription.ts.html |here} to see how to use CreateAnnouncementSubscription API.
181
+ */
182
+ createAnnouncementSubscription(createAnnouncementSubscriptionRequest: requests.CreateAnnouncementSubscriptionRequest): Promise<responses.CreateAnnouncementSubscriptionResponse>;
183
+ /**
184
+ * Creates a new filter group in the specified announcement subscription.
185
+ * <p>
186
+ 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.
187
+ *
188
+ * This operation does not retry by default if the user has not defined a retry configuration.
189
+ * @param CreateFilterGroupRequest
190
+ * @return CreateFilterGroupResponse
191
+ * @throws OciError when an error occurs
192
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/CreateFilterGroup.ts.html |here} to see how to use CreateFilterGroup API.
193
+ */
194
+ createFilterGroup(createFilterGroupRequest: requests.CreateFilterGroupRequest): Promise<responses.CreateFilterGroupResponse>;
195
+ /**
196
+ * Deletes the specified announcement subscription.
197
+ * <p>
198
+ 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.
199
+ *
200
+ * This operation does not retry by default if the user has not defined a retry configuration.
201
+ * @param DeleteAnnouncementSubscriptionRequest
202
+ * @return DeleteAnnouncementSubscriptionResponse
203
+ * @throws OciError when an error occurs
204
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/DeleteAnnouncementSubscription.ts.html |here} to see how to use DeleteAnnouncementSubscription API.
205
+ */
206
+ deleteAnnouncementSubscription(deleteAnnouncementSubscriptionRequest: requests.DeleteAnnouncementSubscriptionRequest): Promise<responses.DeleteAnnouncementSubscriptionResponse>;
207
+ /**
208
+ * Deletes a filter group in the specified announcement subscription.
209
+ * <p>
210
+ 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.
211
+ *
212
+ * This operation does not retry by default if the user has not defined a retry configuration.
213
+ * @param DeleteFilterGroupRequest
214
+ * @return DeleteFilterGroupResponse
215
+ * @throws OciError when an error occurs
216
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/DeleteFilterGroup.ts.html |here} to see how to use DeleteFilterGroup API.
217
+ */
218
+ deleteFilterGroup(deleteFilterGroupRequest: requests.DeleteFilterGroupRequest): Promise<responses.DeleteFilterGroupResponse>;
219
+ /**
220
+ * Gets the specified announcement subscription.
221
+ * <p>
222
+ 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.
223
+ *
224
+ * This operation does not retry by default if the user has not defined a retry configuration.
225
+ * @param GetAnnouncementSubscriptionRequest
226
+ * @return GetAnnouncementSubscriptionResponse
227
+ * @throws OciError when an error occurs
228
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/GetAnnouncementSubscription.ts.html |here} to see how to use GetAnnouncementSubscription API.
229
+ */
230
+ getAnnouncementSubscription(getAnnouncementSubscriptionRequest: requests.GetAnnouncementSubscriptionRequest): Promise<responses.GetAnnouncementSubscriptionResponse>;
231
+ /**
232
+ * Gets a list of all announcement subscriptions in the specified compartment.
233
+ * <p>
234
+ 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.
235
+ *
236
+ * This operation does not retry by default if the user has not defined a retry configuration.
237
+ * @param ListAnnouncementSubscriptionsRequest
238
+ * @return ListAnnouncementSubscriptionsResponse
239
+ * @throws OciError when an error occurs
240
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/ListAnnouncementSubscriptions.ts.html |here} to see how to use ListAnnouncementSubscriptions API.
241
+ */
242
+ listAnnouncementSubscriptions(listAnnouncementSubscriptionsRequest: requests.ListAnnouncementSubscriptionsRequest): Promise<responses.ListAnnouncementSubscriptionsResponse>;
243
+ /**
244
+ * Updates the specified announcement subscription.
245
+ * <p>
246
+ 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.
247
+ *
248
+ * This operation does not retry by default if the user has not defined a retry configuration.
249
+ * @param UpdateAnnouncementSubscriptionRequest
250
+ * @return UpdateAnnouncementSubscriptionResponse
251
+ * @throws OciError when an error occurs
252
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/UpdateAnnouncementSubscription.ts.html |here} to see how to use UpdateAnnouncementSubscription API.
253
+ */
254
+ updateAnnouncementSubscription(updateAnnouncementSubscriptionRequest: requests.UpdateAnnouncementSubscriptionRequest): Promise<responses.UpdateAnnouncementSubscriptionResponse>;
255
+ /**
256
+ * Updates a filter group in the specified announcement subscription.
257
+ * <p>
258
+ 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.
259
+ *
260
+ * This operation does not retry by default if the user has not defined a retry configuration.
261
+ * @param UpdateFilterGroupRequest
262
+ * @return UpdateFilterGroupResponse
263
+ * @throws OciError when an error occurs
264
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/UpdateFilterGroup.ts.html |here} to see how to use UpdateFilterGroup API.
265
+ */
266
+ updateFilterGroup(updateFilterGroupRequest: requests.UpdateFilterGroupRequest): Promise<responses.UpdateFilterGroupResponse>;
96
267
  }
97
268
  export declare enum AnnouncementsPreferencesApiKeys {
98
269
  }
@@ -134,34 +305,40 @@ export declare class AnnouncementsPreferencesClient {
134
305
  */
135
306
  set regionId(regionId: string);
136
307
  /**
137
- * Creates a request that specifies preferences for the tenancy regarding receiving announcements by email.
138
- *
139
- * This operation does not retry by default if the user has not defined a retry configuration.
140
- * @param CreateAnnouncementsPreferenceRequest
141
- * @return CreateAnnouncementsPreferenceResponse
142
- * @throws OciError when an error occurs
143
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/CreateAnnouncementsPreference.ts.html |here} to see how to use CreateAnnouncementsPreference API.
144
- */
308
+ * Creates a request that specifies preferences for the tenancy regarding receiving announcements by email.
309
+ * <p>
310
+ 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.
311
+ *
312
+ * This operation does not retry by default if the user has not defined a retry configuration.
313
+ * @param CreateAnnouncementsPreferenceRequest
314
+ * @return CreateAnnouncementsPreferenceResponse
315
+ * @throws OciError when an error occurs
316
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/CreateAnnouncementsPreference.ts.html |here} to see how to use CreateAnnouncementsPreference API.
317
+ */
145
318
  createAnnouncementsPreference(createAnnouncementsPreferenceRequest: requests.CreateAnnouncementsPreferenceRequest): Promise<responses.CreateAnnouncementsPreferenceResponse>;
146
319
  /**
147
- * Gets the current preferences of the tenancy regarding receiving announcements by email.
148
- *
149
- * This operation does not retry by default if the user has not defined a retry configuration.
150
- * @param GetAnnouncementsPreferenceRequest
151
- * @return GetAnnouncementsPreferenceResponse
152
- * @throws OciError when an error occurs
153
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/GetAnnouncementsPreference.ts.html |here} to see how to use GetAnnouncementsPreference API.
154
- */
320
+ * Gets the current preferences of the tenancy regarding receiving announcements by email.
321
+ * <p>
322
+ 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.
323
+ *
324
+ * This operation does not retry by default if the user has not defined a retry configuration.
325
+ * @param GetAnnouncementsPreferenceRequest
326
+ * @return GetAnnouncementsPreferenceResponse
327
+ * @throws OciError when an error occurs
328
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/GetAnnouncementsPreference.ts.html |here} to see how to use GetAnnouncementsPreference API.
329
+ */
155
330
  getAnnouncementsPreference(getAnnouncementsPreferenceRequest: requests.GetAnnouncementsPreferenceRequest): Promise<responses.GetAnnouncementsPreferenceResponse>;
156
331
  /**
157
- * Gets the current preferences of the tenancy regarding receiving announcements by email.
158
- *
159
- * This operation does not retry by default if the user has not defined a retry configuration.
160
- * @param ListAnnouncementsPreferencesRequest
161
- * @return ListAnnouncementsPreferencesResponse
162
- * @throws OciError when an error occurs
163
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/ListAnnouncementsPreferences.ts.html |here} to see how to use ListAnnouncementsPreferences API.
164
- */
332
+ * Gets the current preferences of the tenancy regarding receiving announcements by email.
333
+ * <p>
334
+ 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.
335
+ *
336
+ * This operation does not retry by default if the user has not defined a retry configuration.
337
+ * @param ListAnnouncementsPreferencesRequest
338
+ * @return ListAnnouncementsPreferencesResponse
339
+ * @throws OciError when an error occurs
340
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/ListAnnouncementsPreferences.ts.html |here} to see how to use ListAnnouncementsPreferences API.
341
+ */
165
342
  listAnnouncementsPreferences(listAnnouncementsPreferencesRequest: requests.ListAnnouncementsPreferencesRequest): Promise<responses.ListAnnouncementsPreferencesResponse>;
166
343
  /**
167
344
  * NOTE: This function is deprecated in favor of listAnnouncementsPreferencesRecordIterator function.
@@ -196,13 +373,15 @@ export declare class AnnouncementsPreferencesClient {
196
373
  */
197
374
  listAnnouncementsPreferencesResponseIterator(request: requests.ListAnnouncementsPreferencesRequest): AsyncIterableIterator<responses.ListAnnouncementsPreferencesResponse>;
198
375
  /**
199
- * Updates the preferences of the tenancy regarding receiving announcements by email.
200
- *
201
- * This operation does not retry by default if the user has not defined a retry configuration.
202
- * @param UpdateAnnouncementsPreferenceRequest
203
- * @return UpdateAnnouncementsPreferenceResponse
204
- * @throws OciError when an error occurs
205
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.13.0/announcementsservice/UpdateAnnouncementsPreference.ts.html |here} to see how to use UpdateAnnouncementsPreference API.
206
- */
376
+ * Updates the preferences of the tenancy regarding receiving announcements by email.
377
+ * <p>
378
+ 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.
379
+ *
380
+ * This operation does not retry by default if the user has not defined a retry configuration.
381
+ * @param UpdateAnnouncementsPreferenceRequest
382
+ * @return UpdateAnnouncementsPreferenceResponse
383
+ * @throws OciError when an error occurs
384
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.16.0/announcementsservice/UpdateAnnouncementsPreference.ts.html |here} to see how to use UpdateAnnouncementsPreference API.
385
+ */
207
386
  updateAnnouncementsPreference(updateAnnouncementsPreferenceRequest: requests.UpdateAnnouncementsPreferenceRequest): Promise<responses.UpdateAnnouncementsPreferenceResponse>;
208
387
  }