oci-cims - npm Package Compare versions

Comparing version 2.57.0 to 2.58.1

lib/client.d.ts

@@ -25,2 +25,3 @@ /**
     protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean;
     protected "_endpoint": string;
@@ -32,2 +33,5 @@ protected "_defaultHeaders": any;
     targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
     protected _httpClient: common.HttpClient;
@@ -46,2 +50,8 @@ constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
     /**
+     * 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).
@@ -67,3 +77,3 @@ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateIncident.ts.html |here} to see how to use CreateIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateIncident.ts.html |here} to see how to use CreateIncident API.
      */
@@ -77,3 +87,3 @@ createIncident(createIncidentRequest: requests.CreateIncidentRequest): Promise<responses.CreateIncidentResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetIncident.ts.html |here} to see how to use GetIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetIncident.ts.html |here} to see how to use GetIncident API.
      */
@@ -87,3 +97,3 @@ getIncident(getIncidentRequest: requests.GetIncidentRequest): Promise<responses.GetIncidentResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetStatus.ts.html |here} to see how to use GetStatus API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetStatus.ts.html |here} to see how to use GetStatus API.
      */
@@ -97,3 +107,3 @@ getStatus(getStatusRequest: requests.GetStatusRequest): Promise<responses.GetStatusResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypes API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypes API.
      */
@@ -139,3 +149,3 @@ listIncidentResourceTypes(listIncidentResourceTypesRequest: requests.ListIncidentResourceTypesRequest): Promise<responses.ListIncidentResourceTypesResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidents.ts.html |here} to see how to use ListIncidents API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidents.ts.html |here} to see how to use ListIncidents API.
      */
@@ -181,3 +191,3 @@ listIncidents(listIncidentsRequest: requests.ListIncidentsRequest): Promise<responses.ListIncidentsResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncident API.
      */
@@ -191,3 +201,3 @@ updateIncident(updateIncidentRequest: requests.UpdateIncidentRequest): Promise<responses.UpdateIncidentResponse>;
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ValidateUser.ts.html |here} to see how to use ValidateUser API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ValidateUser.ts.html |here} to see how to use ValidateUser API.
      */
@@ -204,2 +214,3 @@ validateUser(validateUserRequest: requests.ValidateUserRequest): Promise<responses.ValidateUserResponse>;
     protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean;
     protected "_endpoint": string;
@@ -211,2 +222,5 @@ protected "_defaultHeaders": any;
     targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
     protected _httpClient: common.HttpClient;
@@ -225,2 +239,8 @@ constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
     /**
+     * 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).
@@ -246,5 +266,5 @@ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateUser.ts.html |here} to see how to use CreateUser API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateUser.ts.html |here} to see how to use CreateUser API.
      */
     createUser(createUserRequest: requests.CreateUserRequest): Promise<responses.CreateUserResponse>;
 }

lib/client.js

@@ -59,2 +59,3 @@ "use strict";
     constructor(params, clientConfiguration) {
+        this["_realmSpecificEndpointTemplateEnabled"] = false;
         this["_endpoint"] = "";
@@ -65,2 +66,4 @@ this["_defaultHeaders"] = {};
         this.targetService = "Incident";
+        this._regionId = "";
+        this._lastSetRegionOrRegionId = "";
         const requestSigner = params.authenticationDetailsProvider
@@ -116,2 +119,18 @@ ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
     /**
+     * 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) {
+        this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
+        if (this.logger)
+            this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
+        if (this._lastSetRegionOrRegionId === common.Region.REGION_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegion(IncidentClient.serviceEndpointTemplate, this._region, IncidentClient.endpointServiceName);
+        }
+        else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(IncidentClient.serviceEndpointTemplate, this._regionId, IncidentClient.endpointServiceName);
+        }
+    }
+    /**
      * Sets the region to call (ex, Region.US_PHOENIX_1).
@@ -122,3 +141,5 @@ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
     set region(region) {
+        this._region = region;
         this.endpoint = common.EndpointBuilder.createEndpointFromRegion(IncidentClient.serviceEndpointTemplate, region, IncidentClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_STRING;
     }
@@ -134,3 +155,5 @@ /**
     set regionId(regionId) {
+        this._regionId = regionId;
         this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(IncidentClient.serviceEndpointTemplate, regionId, IncidentClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
     }
@@ -143,3 +166,3 @@ /**
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateIncident.ts.html |here} to see how to use CreateIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateIncident.ts.html |here} to see how to use CreateIncident API.
      */
@@ -203,3 +226,3 @@ createIncident(createIncidentRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetIncident.ts.html |here} to see how to use GetIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetIncident.ts.html |here} to see how to use GetIncident API.
      */
@@ -266,3 +289,3 @@ getIncident(getIncidentRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetStatus.ts.html |here} to see how to use GetStatus API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetStatus.ts.html |here} to see how to use GetStatus API.
      */
@@ -327,3 +350,3 @@ getStatus(getStatusRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypes API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypes API.
      */
@@ -440,3 +463,3 @@ listIncidentResourceTypes(listIncidentResourceTypesRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidents.ts.html |here} to see how to use ListIncidents API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidents.ts.html |here} to see how to use ListIncidents API.
      */
@@ -553,3 +576,3 @@ listIncidents(listIncidentsRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncident API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncident API.
      */
@@ -617,3 +640,3 @@ updateIncident(updateIncidentRequest) {
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ValidateUser.ts.html |here} to see how to use ValidateUser API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ValidateUser.ts.html |here} to see how to use ValidateUser API.
      */
@@ -685,2 +708,3 @@ validateUser(validateUserRequest) {
     constructor(params, clientConfiguration) {
+        this["_realmSpecificEndpointTemplateEnabled"] = false;
         this["_endpoint"] = "";
@@ -691,2 +715,4 @@ this["_defaultHeaders"] = {};
         this.targetService = "User";
+        this._regionId = "";
+        this._lastSetRegionOrRegionId = "";
         const requestSigner = params.authenticationDetailsProvider
@@ -742,2 +768,18 @@ ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
     /**
+     * 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) {
+        this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
+        if (this.logger)
+            this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
+        if (this._lastSetRegionOrRegionId === common.Region.REGION_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegion(UserClient.serviceEndpointTemplate, this._region, UserClient.endpointServiceName);
+        }
+        else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(UserClient.serviceEndpointTemplate, this._regionId, UserClient.endpointServiceName);
+        }
+    }
+    /**
      * Sets the region to call (ex, Region.US_PHOENIX_1).
@@ -748,3 +790,5 @@ * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
     set region(region) {
+        this._region = region;
         this.endpoint = common.EndpointBuilder.createEndpointFromRegion(UserClient.serviceEndpointTemplate, region, UserClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_STRING;
     }
@@ -760,3 +804,5 @@ /**
     set regionId(regionId) {
+        this._regionId = regionId;
         this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(UserClient.serviceEndpointTemplate, regionId, UserClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
     }
@@ -769,3 +815,3 @@ /**
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateUser.ts.html |here} to see how to use CreateUser API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateUser.ts.html |here} to see how to use CreateUser API.
      */
@@ -772,0 +818,0 @@ createUser(createUserRequest) {

lib/request/create-incident-request.d.ts

@@ -16,3 +16,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateIncident.ts.html |here} to see how to use CreateIncidentRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateIncident.ts.html |here} to see how to use CreateIncidentRequest.
  */
@@ -19,0 +19,0 @@ export interface CreateIncidentRequest extends common.BaseRequest {

lib/request/create-user-request.d.ts

@@ -16,3 +16,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/CreateUser.ts.html |here} to see how to use CreateUserRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/CreateUser.ts.html |here} to see how to use CreateUserRequest.
  */
@@ -19,0 +19,0 @@ export interface CreateUserRequest extends common.BaseRequest {

lib/request/get-incident-request.d.ts

@@ -15,3 +15,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetIncident.ts.html |here} to see how to use GetIncidentRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetIncident.ts.html |here} to see how to use GetIncidentRequest.
  */
@@ -18,0 +18,0 @@ export interface GetIncidentRequest extends common.BaseRequest {

lib/request/get-status-request.d.ts

@@ -15,3 +15,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/GetStatus.ts.html |here} to see how to use GetStatusRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/GetStatus.ts.html |here} to see how to use GetStatusRequest.
  */
@@ -18,0 +18,0 @@ export interface GetStatusRequest extends common.BaseRequest {

lib/request/list-incident-resource-types-request.d.ts

@@ -16,3 +16,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypesRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidentResourceTypes.ts.html |here} to see how to use ListIncidentResourceTypesRequest.
  */
@@ -19,0 +19,0 @@ export interface ListIncidentResourceTypesRequest extends common.BaseRequest {

lib/request/list-incidents-request.d.ts

@@ -16,3 +16,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ListIncidents.ts.html |here} to see how to use ListIncidentsRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ListIncidents.ts.html |here} to see how to use ListIncidentsRequest.
  */
@@ -19,0 +19,0 @@ export interface ListIncidentsRequest extends common.BaseRequest {

lib/request/update-incident-request.d.ts

@@ -16,3 +16,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncidentRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/UpdateIncident.ts.html |here} to see how to use UpdateIncidentRequest.
  */
@@ -19,0 +19,0 @@ export interface UpdateIncidentRequest extends common.BaseRequest {

lib/request/validate-user-request.d.ts

@@ -15,3 +15,3 @@ /**
 /**
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.57.0/cims/ValidateUser.ts.html |here} to see how to use ValidateUserRequest.
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.58.1/cims/ValidateUser.ts.html |here} to see how to use ValidateUserRequest.
  */
@@ -18,0 +18,0 @@ export interface ValidateUserRequest extends common.BaseRequest {

package.json

 {
   "name": "oci-cims",
-  "version": "2.57.0",
+  "version": "2.58.1",
   "description": "OCI NodeJS client for Cims ",
@@ -18,4 +18,4 @@ "repository": {
   "dependencies": {
-    "oci-common": "2.57.0",
-    "oci-workrequests": "2.57.0"
+    "oci-common": "2.58.1",
+    "oci-workrequests": "2.58.1"
   },
@@ -22,0 +22,0 @@ "publishConfig": {

No alert changes

Improved metrics

Total package byte prevSize

423915

increased by1.45%

Lines of code

6576

increased by1.01%

Dependency changes

• + Addedoci-common@2.58.1(transitive)

• + Addedoci-workrequests@2.58.1(transitive)

• - Removedoci-common@2.57.0(transitive)

• - Removedoci-workrequests@2.57.0(transitive)

• Updatedoci-common@2.58.1

• Updatedoci-workrequests@2.58.1