oci-audit 2.76.1 → 2.77.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.
package/lib/client.d.ts CHANGED
@@ -76,7 +76,7 @@ export declare class AuditClient {
76
76
  * @param GetConfigurationRequest
77
77
  * @return GetConfigurationResponse
78
78
  * @throws OciError when an error occurs
79
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/GetConfiguration.ts.html |here} to see how to use GetConfiguration API.
79
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/GetConfiguration.ts.html |here} to see how to use GetConfiguration API.
80
80
  */
81
81
  getConfiguration(getConfigurationRequest: requests.GetConfigurationRequest): Promise<responses.GetConfigurationResponse>;
82
82
  /**
@@ -87,7 +87,7 @@ export declare class AuditClient {
87
87
  * @param ListEventsRequest
88
88
  * @return ListEventsResponse
89
89
  * @throws OciError when an error occurs
90
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/ListEvents.ts.html |here} to see how to use ListEvents API.
90
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/ListEvents.ts.html |here} to see how to use ListEvents API.
91
91
  */
92
92
  listEvents(listEventsRequest: requests.ListEventsRequest): Promise<responses.ListEventsResponse>;
93
93
  /**
@@ -128,7 +128,7 @@ export declare class AuditClient {
128
128
  * @param UpdateConfigurationRequest
129
129
  * @return UpdateConfigurationResponse
130
130
  * @throws OciError when an error occurs
131
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfiguration API.
131
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfiguration API.
132
132
  */
133
133
  updateConfiguration(updateConfigurationRequest: requests.UpdateConfigurationRequest): Promise<responses.UpdateConfigurationResponse>;
134
134
  }
package/lib/client.js CHANGED
@@ -170,7 +170,7 @@ class AuditClient {
170
170
  * @param GetConfigurationRequest
171
171
  * @return GetConfigurationResponse
172
172
  * @throws OciError when an error occurs
173
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/GetConfiguration.ts.html |here} to see how to use GetConfiguration API.
173
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/GetConfiguration.ts.html |here} to see how to use GetConfiguration API.
174
174
  */
175
175
  getConfiguration(getConfigurationRequest) {
176
176
  return __awaiter(this, void 0, void 0, function* () {
@@ -223,7 +223,7 @@ class AuditClient {
223
223
  * @param ListEventsRequest
224
224
  * @return ListEventsResponse
225
225
  * @throws OciError when an error occurs
226
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/ListEvents.ts.html |here} to see how to use ListEvents API.
226
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/ListEvents.ts.html |here} to see how to use ListEvents API.
227
227
  */
228
228
  listEvents(listEventsRequest) {
229
229
  return __awaiter(this, void 0, void 0, function* () {
@@ -329,7 +329,7 @@ class AuditClient {
329
329
  * @param UpdateConfigurationRequest
330
330
  * @return UpdateConfigurationResponse
331
331
  * @throws OciError when an error occurs
332
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfiguration API.
332
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfiguration API.
333
333
  */
334
334
  updateConfiguration(updateConfigurationRequest) {
335
335
  return __awaiter(this, void 0, void 0, function* () {
@@ -24,10 +24,10 @@ export interface AuditEvent {
24
24
  * The type of event that happened.
25
25
  * <p>
26
26
  The service that produces the event can also add, remove, or change the meaning of a field.
27
- * A service implementing these type changes would publish a new version of an `eventType` and
28
- * revise the `eventTypeVersion` field.
27
+ * A service implementing these type changes would publish a new version of an {@code eventType} and
28
+ * revise the {@code eventTypeVersion} field.
29
29
  * <p>
30
- Example: `com.oraclecloud.ComputeApi.GetInstance`
30
+ Example: {@code com.oraclecloud.ComputeApi.GetInstance}
31
31
  *
32
32
  */
33
33
  "eventType": string;
@@ -38,22 +38,22 @@ export interface AuditEvent {
38
38
  * <p>
39
39
  Audit uses version 0.1 specification of the CloudEvents event envelope.
40
40
  * <p>
41
- Example: `0.1`
41
+ Example: {@code 0.1}
42
42
  *
43
43
  */
44
44
  "cloudEventsVersion": string;
45
45
  /**
46
46
  * The version of the event type. This version applies to the payload of the event, not the envelope.
47
- * Use `cloudEventsVersion` to determine the version of the envelope.
47
+ * Use {@code cloudEventsVersion} to determine the version of the envelope.
48
48
  * <p>
49
- Example: `2.0`
49
+ Example: {@code 2.0}
50
50
  *
51
51
  */
52
52
  "eventTypeVersion": string;
53
53
  /**
54
54
  * The source of the event.
55
55
  * <p>
56
- Example: `ComputeApi`
56
+ Example: {@code ComputeApi}
57
57
  *
58
58
  */
59
59
  "source": string;
@@ -65,14 +65,14 @@ export interface AuditEvent {
65
65
  /**
66
66
  * The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
67
67
  * <p>
68
- Example: `2019-09-18T00:10:59.252Z`
68
+ Example: {@code 2019-09-18T00:10:59.252Z}
69
69
  *
70
70
  */
71
71
  "eventTime": Date;
72
72
  /**
73
- * The content type of the data contained in `data`.
73
+ * The content type of the data contained in {@code data}.
74
74
  * <p>
75
- Example: `application/json`
75
+ Example: {@code application/json}
76
76
  *
77
77
  */
78
78
  "contentType": string;
@@ -23,7 +23,7 @@ export interface Configuration {
23
23
  /**
24
24
  * The retention period setting, specified in days. The minimum is 90, the maximum 365.
25
25
  * <p>
26
- Example: `90`
26
+ Example: {@code 90}
27
27
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
28
28
  */
29
29
  "retentionPeriodDays"?: number;
@@ -16,7 +16,7 @@ For more information, see [Overview of Audit](/iaas/Content/Audit/Concepts/audit
16
16
  */
17
17
  import * as model from "../model";
18
18
  /**
19
- * The payload of the event. Information within `data` comes from the resource emitting the event.
19
+ * The payload of the event. Information within {@code data} comes from the resource emitting the event.
20
20
  *
21
21
  */
22
22
  export interface Data {
@@ -30,7 +30,7 @@ export interface Data {
30
30
  /**
31
31
  * Name of the API operation that generated this event.
32
32
  * <p>
33
- Example: `GetInstance`
33
+ Example: {@code GetInstance}
34
34
  *
35
35
  */
36
36
  "eventName"?: string;
@@ -45,7 +45,7 @@ export interface Data {
45
45
  * This value can change, but the service logs the value that appeared at the time of the audit
46
46
  * event.
47
47
  * <p>
48
- Example: `CompartmentA`
48
+ Example: {@code CompartmentA}
49
49
  *
50
50
  */
51
51
  "compartmentName"?: string;
@@ -70,7 +70,7 @@ export interface Data {
70
70
  * type, or namespace. Exists for cross-compatibility only. For more information,
71
71
  * see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
72
72
  * <p>
73
- Example: `{\"Department\": \"Finance\"}`
73
+ Example: {@code {\"Department\": \"Finance\"}}
74
74
  *
75
75
  */
76
76
  "freeformTags"?: {
@@ -80,7 +80,7 @@ export interface Data {
80
80
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
81
81
  * information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
82
82
  * <p>
83
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
83
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
84
84
  *
85
85
  */
86
86
  "definedTags"?: {
@@ -20,9 +20,9 @@ For more information, see [Overview of Audit](/iaas/Content/Audit/Concepts/audit
20
20
  */
21
21
  export interface Identity {
22
22
  /**
23
- * The name of the user or service. This value is the friendly name associated with `principalId`.
23
+ * The name of the user or service. This value is the friendly name associated with {@code principalId}.
24
24
  * <p>
25
- Example: `ExampleName`
25
+ Example: {@code ExampleName}
26
26
  *
27
27
  */
28
28
  "principalName"?: string;
@@ -34,12 +34,12 @@ export interface Identity {
34
34
  /**
35
35
  * The type of authentication used.
36
36
  * <p>
37
- Example: `natv`
37
+ Example: {@code natv}
38
38
  *
39
39
  */
40
40
  "authType"?: string;
41
41
  /**
42
- * The name of the user or service. This value is the friendly name associated with `callerId`.
42
+ * The name of the user or service. This value is the friendly name associated with {@code callerId}.
43
43
  *
44
44
  */
45
45
  "callerName"?: string;
@@ -57,7 +57,7 @@ export interface Identity {
57
57
  /**
58
58
  * The IP address of the source of the request.
59
59
  * <p>
60
- Example: `172.24.80.88`
60
+ Example: {@code 172.24.80.88}
61
61
  *
62
62
  */
63
63
  "ipAddress"?: string;
@@ -70,7 +70,7 @@ export interface Identity {
70
70
  /**
71
71
  * The user agent of the client that made the request.
72
72
  * <p>
73
- Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)`
73
+ Example: {@code Jersey/2.23 (HttpUrlConnection 1.8.0_212)}
74
74
  *
75
75
  */
76
76
  "userAgent"?: string;
@@ -27,14 +27,14 @@ export interface Request {
27
27
  /**
28
28
  * The full path of the API request.
29
29
  * <p>
30
- Example: `/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>`
30
+ Example: {@code /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>}
31
31
  *
32
32
  */
33
33
  "path"?: string;
34
34
  /**
35
35
  * The HTTP method of the request.
36
36
  * <p>
37
- Example: `GET`
37
+ Example: {@code GET}
38
38
  *
39
39
  */
40
40
  "action"?: string;
@@ -22,7 +22,7 @@ export interface Response {
22
22
  /**
23
23
  * The status code of the response.
24
24
  * <p>
25
- Example: `200`
25
+ Example: {@code 200}
26
26
  *
27
27
  */
28
28
  "status"?: string;
@@ -30,7 +30,7 @@ export interface Response {
30
30
  * The time of the response to the audited request, expressed in
31
31
  * [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
32
32
  * <p>
33
- Example: `2019-09-18T00:10:59.278Z`
33
+ Example: {@code 2019-09-18T00:10:59.278Z}
34
34
  *
35
35
  */
36
36
  "responseTime"?: Date;
@@ -22,7 +22,7 @@ export interface StateChange {
22
22
  /**
23
23
  * Provides the previous state of fields that may have changed during an operation. To determine
24
24
  * how the current operation changed a resource, compare the information in this attribute to
25
- * `current`.
25
+ * {@code current}.
26
26
  *
27
27
  */
28
28
  "previous"?: {
@@ -31,7 +31,7 @@ export interface StateChange {
31
31
  /**
32
32
  * Provides the current state of fields that may have changed during an operation. To determine
33
33
  * how the current operation changed a resource, compare the information in this attribute to
34
- * `previous`.
34
+ * {@code previous}.
35
35
  *
36
36
  */
37
37
  "current"?: {
@@ -23,7 +23,7 @@ export interface UpdateConfigurationDetails {
23
23
  /**
24
24
  * The retention period setting, specified in days. The minimum is 90, the maximum 365.
25
25
  * <p>
26
- Example: `90`
26
+ Example: {@code 90}
27
27
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
28
28
  */
29
29
  "retentionPeriodDays": number;
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/GetConfiguration.ts.html |here} to see how to use GetConfigurationRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/GetConfiguration.ts.html |here} to see how to use GetConfigurationRequest.
16
16
  */
17
17
  export interface GetConfigurationRequest extends common.BaseRequest {
18
18
  /**
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/ListEvents.ts.html |here} to see how to use ListEventsRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/ListEvents.ts.html |here} to see how to use ListEventsRequest.
16
16
  */
17
17
  export interface ListEventsRequest extends common.BaseRequest {
18
18
  /**
@@ -23,10 +23,10 @@ export interface ListEventsRequest extends common.BaseRequest {
23
23
  * Returns events that were processed at or after this start date and time, expressed in
24
24
  * [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
25
25
  * <p>
26
- For example, a start value of `2017-01-15T11:30:00Z` will retrieve a list of all events processed
26
+ For example, a start value of {@code 2017-01-15T11:30:00Z} will retrieve a list of all events processed
27
27
  * since 30 minutes after the 11th hour of January 15, 2017, in Coordinated Universal Time (UTC).
28
28
  * You can specify a value with granularity to the minute. Seconds (and milliseconds, if included) must
29
- * be set to `0`.
29
+ * be set to {@code 0}.
30
30
  *
31
31
  */
32
32
  "startTime": Date;
@@ -34,16 +34,16 @@ export interface ListEventsRequest extends common.BaseRequest {
34
34
  * Returns events that were processed before this end date and time, expressed in
35
35
  * [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
36
36
  * <p>
37
- For example, a start value of `2017-01-01T00:00:00Z` and an end value of `2017-01-02T00:00:00Z`
37
+ For example, a start value of {@code 2017-01-01T00:00:00Z} and an end value of {@code 2017-01-02T00:00:00Z}
38
38
  * will retrieve a list of all events processed on January 1, 2017. Similarly, a start value of
39
- * `2017-01-01T00:00:00Z` and an end value of `2017-02-01T00:00:00Z` will result in a list of all
39
+ * {@code 2017-01-01T00:00:00Z} and an end value of {@code 2017-02-01T00:00:00Z} will result in a list of all
40
40
  * events processed between January 1, 2017 and January 31, 2017. You can specify a value with
41
- * granularity to the minute. Seconds (and milliseconds, if included) must be set to `0`.
41
+ * granularity to the minute. Seconds (and milliseconds, if included) must be set to {@code 0}.
42
42
  *
43
43
  */
44
44
  "endTime": Date;
45
45
  /**
46
- * For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.
46
+ * For list pagination. The value of the {@code opc-next-page} response header from the previous \"List\" call.
47
47
  * For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
48
48
  *
49
49
  */
@@ -13,7 +13,7 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfigurationRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/audit/UpdateConfiguration.ts.html |here} to see how to use UpdateConfigurationRequest.
17
17
  */
18
18
  export interface UpdateConfigurationRequest extends common.BaseRequest {
19
19
  /**
@@ -14,7 +14,7 @@ import * as model from "../model";
14
14
  export interface ListEventsResponse {
15
15
  /**
16
16
  * For pagination of a list of audit events. When this header appears in the response,
17
- * it means you received a partial list and there are more results. Include this value as the `page`
17
+ * it means you received a partial list and there are more results. Include this value as the {@code page}
18
18
  * parameter for the subsequent ListEvents request to get the next batch of events. For important
19
19
  * details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
20
20
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oci-audit",
3
- "version": "2.76.1",
3
+ "version": "2.77.0",
4
4
  "description": "OCI NodeJS client for Audit Service",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,8 +15,8 @@
15
15
  },
16
16
  "license": "(UPL-1.0 OR Apache-2.0)",
17
17
  "dependencies": {
18
- "oci-common": "2.76.1",
19
- "oci-workrequests": "2.76.1"
18
+ "oci-common": "2.77.0",
19
+ "oci-workrequests": "2.77.0"
20
20
  },
21
21
  "publishConfig": {
22
22
  "registry": "https://registry.npmjs.org"