oci-osubsubscription 2.12.0

package/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import * as requests from "./lib/request";
+import * as models from "./lib/model";
+import * as responses from "./lib/response";
+import * as client from "./lib/client";
+export { models };
+export { requests };
+export { responses };
+export import CommitmentClient = client.CommitmentClient;
+export import RatecardClient = client.RatecardClient;
+export import SubscriptionClient = client.SubscriptionClient;

package/index.js

@@ -0,0 +1,46 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionClient = exports.RatecardClient = exports.CommitmentClient = exports.responses = exports.requests = exports.models = void 0;
+const requests = __importStar(require("./lib/request"));
+exports.requests = requests;
+const models = __importStar(require("./lib/model"));
+exports.models = models;
+const responses = __importStar(require("./lib/response"));
+exports.responses = responses;
+const client = __importStar(require("./lib/client"));
+exports.CommitmentClient = client.CommitmentClient;
+exports.RatecardClient = client.RatecardClient;
+exports.SubscriptionClient = client.SubscriptionClient;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/osubsubscription/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,QAAA,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC"}

package/lib/client.d.ts

@@ -0,0 +1,274 @@
+/**
+ * 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.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as model from "./model";
+import * as responses from "./response";
+export declare enum 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.
+ */
+export declare class CommitmentClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * 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: requests.GetCommitmentRequest): Promise<responses.GetCommitmentResponse>;
+    /**
+     * 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: requests.ListCommitmentsRequest): Promise<responses.ListCommitmentsResponse>;
+    /**
+     * 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: requests.ListCommitmentsRequest): AsyncIterableIterator<model.CommitmentSummary>;
+    /**
+     * 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: requests.ListCommitmentsRequest): AsyncIterableIterator<responses.ListCommitmentsResponse>;
+    /**
+     * 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: requests.ListCommitmentsRequest): AsyncIterableIterator<model.CommitmentSummary>;
+    /**
+     * 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: requests.ListCommitmentsRequest): AsyncIterableIterator<responses.ListCommitmentsResponse>;
+}
+export declare enum 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.
+ */
+export declare class RatecardClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * 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: requests.ListRateCardsRequest): Promise<responses.ListRateCardsResponse>;
+    /**
+     * 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: requests.ListRateCardsRequest): AsyncIterableIterator<model.RateCardSummary>;
+    /**
+     * 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: requests.ListRateCardsRequest): AsyncIterableIterator<responses.ListRateCardsResponse>;
+    /**
+     * 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: requests.ListRateCardsRequest): AsyncIterableIterator<model.RateCardSummary>;
+    /**
+     * 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: requests.ListRateCardsRequest): AsyncIterableIterator<responses.ListRateCardsResponse>;
+}
+export declare enum 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.
+ */
+export declare class SubscriptionClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * 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: requests.ListSubscriptionsRequest): Promise<responses.ListSubscriptionsResponse>;
+    /**
+     * 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: requests.ListSubscriptionsRequest): AsyncIterableIterator<model.SubscriptionSummary>;
+    /**
+     * 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: requests.ListSubscriptionsRequest): AsyncIterableIterator<responses.ListSubscriptionsResponse>;
+    /**
+     * 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: requests.ListSubscriptionsRequest): AsyncIterableIterator<model.SubscriptionSummary>;
+    /**
+     * 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: requests.ListSubscriptionsRequest): AsyncIterableIterator<responses.ListSubscriptionsResponse>;
+}