oci-osubsubscription 2.12.0

package/lib/client.js

@@ -0,0 +1,681 @@
+"use strict";
+/**
+ * OneSubscription API Subscription, Commitment and and Rate Card Details
+ * Set of APIs that return the Subscription Details, Commitment and Effective Rate Card Details
+
+ * OpenAPI spec version: 20210501
+ * Contact: kuaskum_org_ww@oracle.com
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2022, 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionClient = exports.SubscriptionApiKeys = exports.RatecardClient = exports.RatecardApiKeys = exports.CommitmentClient = exports.CommitmentApiKeys = void 0;
+const common = require("oci-common");
+const model = __importStar(require("./model"));
+const oci_common_1 = require("oci-common");
+const oci_common_2 = require("oci-common");
+// ===============================================
+// This file is autogenerated - Please do not edit
+// ===============================================
+var CommitmentApiKeys;
+(function (CommitmentApiKeys) {
+})(CommitmentApiKeys = exports.CommitmentApiKeys || (exports.CommitmentApiKeys = {}));
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+class CommitmentClient {
+    constructor(params, clientConfiguration) {
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker
+                ? clientConfiguration.circuitBreaker.circuit
+                : null;
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker &&
+            common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
+            (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient =
+            params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + "/oalapp/service/onesubs/proxy/20210501";
+        if (this.logger)
+            this.logger.info(`CommitmentClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.LOG.logger;
+    }
+    /**
+     * 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(CommitmentClient.serviceEndpointTemplate, 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(CommitmentClient.serviceEndpointTemplate, regionId);
+    }
+    /**
+     * This API returns the commitment details corresponding to the id provided
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetCommitmentRequest
+     * @return GetCommitmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.0/osubsubscription/GetCommitment.ts.html |here} to see how to use GetCommitment API.
+     */
+    getCommitment(getCommitmentRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation CommitmentClient#getCommitment.");
+            const pathParams = {
+                "{commitmentId}": getCommitmentRequest.commitmentId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getCommitmentRequest.opcRequestId,
+                "x-one-gateway-subscription-id": getCommitmentRequest.xOneGatewaySubscriptionId,
+                "x-one-origin-region": getCommitmentRequest.xOneOriginRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getCommitmentRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/commitments/{commitmentId}",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "commitmentDetail",
+                    bodyModel: model.CommitmentDetail,
+                    type: "model.CommitmentDetail",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * This list API returns all commitments for a particular Subscribed Service
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListCommitmentsRequest
+     * @return ListCommitmentsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.0/osubsubscription/ListCommitments.ts.html |here} to see how to use ListCommitments API.
+     */
+    listCommitments(listCommitmentsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation CommitmentClient#listCommitments.");
+            const pathParams = {};
+            const queryParams = {
+                "subscribedServiceId": listCommitmentsRequest.subscribedServiceId,
+                "compartmentId": listCommitmentsRequest.compartmentId,
+                "limit": listCommitmentsRequest.limit,
+                "page": listCommitmentsRequest.page,
+                "sortOrder": listCommitmentsRequest.sortOrder,
+                "sortBy": listCommitmentsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listCommitmentsRequest.opcRequestId,
+                "x-one-gateway-subscription-id": listCommitmentsRequest.xOneGatewaySubscriptionId,
+                "x-one-origin-region": listCommitmentsRequest.xOneOriginRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listCommitmentsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/commitments",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "items",
+                    bodyModel: model.CommitmentSummary,
+                    type: "Array<model.CommitmentSummary>",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listCommitmentsRecordIterator function.
+     * Creates a new async iterator which will iterate over the models.CommitmentSummary objects
+     * contained in responses from the listCommitments operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllCommitments(request) {
+        return oci_common_1.paginateRecords(request, req => this.listCommitments(req));
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listCommitmentsResponseIterator function.
+     * Creates a new async iterator which will iterate over the responses received from the listCommitments operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllCommitmentsResponses(request) {
+        return oci_common_1.paginateResponses(request, req => this.listCommitments(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the models.CommitmentSummary objects
+     * contained in responses from the listCommitments operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listCommitmentsRecordIterator(request) {
+        return oci_common_1.paginateRecords(request, req => this.listCommitments(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the responses received from the listCommitments operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listCommitmentsResponseIterator(request) {
+        return oci_common_1.paginateResponses(request, req => this.listCommitments(req));
+    }
+}
+exports.CommitmentClient = CommitmentClient;
+CommitmentClient.serviceEndpointTemplate = "https://csaap-e.oracle.com";
+var RatecardApiKeys;
+(function (RatecardApiKeys) {
+})(RatecardApiKeys = exports.RatecardApiKeys || (exports.RatecardApiKeys = {}));
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+class RatecardClient {
+    constructor(params, clientConfiguration) {
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker
+                ? clientConfiguration.circuitBreaker.circuit
+                : null;
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker &&
+            common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
+            (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient =
+            params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + "/oalapp/service/onesubs/proxy/20210501";
+        if (this.logger)
+            this.logger.info(`RatecardClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.LOG.logger;
+    }
+    /**
+     * 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(RatecardClient.serviceEndpointTemplate, 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(RatecardClient.serviceEndpointTemplate, regionId);
+    }
+    /**
+     * List API that returns all ratecards for given Subscription Id and Account ID (if provided) and
+     * for a particular date range
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListRateCardsRequest
+     * @return ListRateCardsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.0/osubsubscription/ListRateCards.ts.html |here} to see how to use ListRateCards API.
+     */
+    listRateCards(listRateCardsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation RatecardClient#listRateCards.");
+            const pathParams = {};
+            const queryParams = {
+                "subscriptionId": listRateCardsRequest.subscriptionId,
+                "timeFrom": listRateCardsRequest.timeFrom,
+                "timeTo": listRateCardsRequest.timeTo,
+                "partNumber": listRateCardsRequest.partNumber,
+                "limit": listRateCardsRequest.limit,
+                "page": listRateCardsRequest.page,
+                "sortOrder": listRateCardsRequest.sortOrder,
+                "sortBy": listRateCardsRequest.sortBy,
+                "compartmentId": listRateCardsRequest.compartmentId
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listRateCardsRequest.opcRequestId,
+                "x-one-origin-region": listRateCardsRequest.xOneOriginRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listRateCardsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/ratecards",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "items",
+                    bodyModel: model.RateCardSummary,
+                    type: "Array<model.RateCardSummary>",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listRateCardsRecordIterator function.
+     * Creates a new async iterator which will iterate over the models.RateCardSummary objects
+     * contained in responses from the listRateCards operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllRateCards(request) {
+        return oci_common_1.paginateRecords(request, req => this.listRateCards(req));
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listRateCardsResponseIterator function.
+     * Creates a new async iterator which will iterate over the responses received from the listRateCards operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllRateCardsResponses(request) {
+        return oci_common_1.paginateResponses(request, req => this.listRateCards(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the models.RateCardSummary objects
+     * contained in responses from the listRateCards operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listRateCardsRecordIterator(request) {
+        return oci_common_1.paginateRecords(request, req => this.listRateCards(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the responses received from the listRateCards operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listRateCardsResponseIterator(request) {
+        return oci_common_1.paginateResponses(request, req => this.listRateCards(req));
+    }
+}
+exports.RatecardClient = RatecardClient;
+RatecardClient.serviceEndpointTemplate = "https://csaap-e.oracle.com";
+var SubscriptionApiKeys;
+(function (SubscriptionApiKeys) {
+})(SubscriptionApiKeys = exports.SubscriptionApiKeys || (exports.SubscriptionApiKeys = {}));
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+class SubscriptionClient {
+    constructor(params, clientConfiguration) {
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker
+                ? clientConfiguration.circuitBreaker.circuit
+                : null;
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker &&
+            common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
+            (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient =
+            params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + "/oalapp/service/onesubs/proxy/20210501";
+        if (this.logger)
+            this.logger.info(`SubscriptionClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.LOG.logger;
+    }
+    /**
+     * 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(SubscriptionClient.serviceEndpointTemplate, 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(SubscriptionClient.serviceEndpointTemplate, regionId);
+    }
+    /**
+     * This list API returns all subscriptions for a given plan number or subscription id or buyer email
+     * and provides additional parameters to include ratecard and commitment details.
+     * This API expects exactly one of the above mentioned parameters as input. If more than one parameters are provided the API will throw
+     * a 400 - invalid parameters exception and if no parameters are provided it will throw a 400 - missing parameter exception
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListSubscriptionsRequest
+     * @return ListSubscriptionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.0/osubsubscription/ListSubscriptions.ts.html |here} to see how to use ListSubscriptions API.
+     */
+    listSubscriptions(listSubscriptionsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation SubscriptionClient#listSubscriptions.");
+            const pathParams = {};
+            const queryParams = {
+                "compartmentId": listSubscriptionsRequest.compartmentId,
+                "planNumber": listSubscriptionsRequest.planNumber,
+                "subscriptionId": listSubscriptionsRequest.subscriptionId,
+                "buyerEmail": listSubscriptionsRequest.buyerEmail,
+                "isCommitInfoRequired": listSubscriptionsRequest.isCommitInfoRequired,
+                "limit": listSubscriptionsRequest.limit,
+                "page": listSubscriptionsRequest.page,
+                "sortOrder": listSubscriptionsRequest.sortOrder,
+                "sortBy": listSubscriptionsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listSubscriptionsRequest.opcRequestId,
+                "x-one-gateway-subscription-id": listSubscriptionsRequest.xOneGatewaySubscriptionId,
+                "x-one-origin-region": listSubscriptionsRequest.xOneOriginRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listSubscriptionsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/subscriptions",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "items",
+                    bodyModel: model.SubscriptionSummary,
+                    type: "Array<model.SubscriptionSummary>",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listSubscriptionsRecordIterator function.
+     * Creates a new async iterator which will iterate over the models.SubscriptionSummary objects
+     * contained in responses from the listSubscriptions operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllSubscriptions(request) {
+        return oci_common_1.paginateRecords(request, req => this.listSubscriptions(req));
+    }
+    /**
+     * NOTE: This function is deprecated in favor of listSubscriptionsResponseIterator function.
+     * Creates a new async iterator which will iterate over the responses received from the listSubscriptions operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllSubscriptionsResponses(request) {
+        return oci_common_1.paginateResponses(request, req => this.listSubscriptions(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the models.SubscriptionSummary objects
+     * contained in responses from the listSubscriptions operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listSubscriptionsRecordIterator(request) {
+        return oci_common_1.paginateRecords(request, req => this.listSubscriptions(req));
+    }
+    /**
+     * Creates a new async iterator which will iterate over the responses received from the listSubscriptions operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listSubscriptionsResponseIterator(request) {
+        return oci_common_1.paginateResponses(request, req => this.listSubscriptions(req));
+    }
+}
+exports.SubscriptionClient = SubscriptionClient;
+SubscriptionClient.serviceEndpointTemplate = "https://csaap-e.oracle.com";
+//# sourceMappingURL=client.js.map