oci-ospgateway 2.62.3 → 2.64.0

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2023, Oracle and/or its affiliates.  All rights reserved.
 
 This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0.  See below for license terms.  You may choose either license.
 
@@ -70,10 +70,10 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
 
 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-            • You must give any other recipients of the Work or Derivative Works a copy of this License; and
-            • You must cause any modified files to carry prominent notices stating that You changed the files; and
-            • You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
-            • If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+            - You must give any other recipients of the Work or Derivative Works a copy of this License; and
+            - You must cause any modified files to carry prominent notices stating that You changed the files; and
+            - You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+            - If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
@@ -86,4 +86,4 @@ You may add Your own copyright statement to Your modifications and may provide a
 
 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
 
-END OF TERMS AND CONDITIONS
+END OF TERMS AND CONDITIONS

package/index.d.ts

@@ -17,5 +17,7 @@ import * as client from "./lib/client";
 export { models };
 export { requests };
 export { responses };
+export import AddressRuleServiceClient = client.AddressRuleServiceClient;
+export import AddressServiceClient = client.AddressServiceClient;
 export import InvoiceServiceClient = client.InvoiceServiceClient;
 export import SubscriptionServiceClient = client.SubscriptionServiceClient;

package/index.js

@@ -31,7 +31,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionServiceClient = exports.InvoiceServiceClient = exports.responses = exports.requests = exports.models = void 0;
+exports.SubscriptionServiceClient = exports.InvoiceServiceClient = exports.AddressServiceClient = exports.AddressRuleServiceClient = exports.responses = exports.requests = exports.models = void 0;
 const requests = __importStar(require("./lib/request"));
 exports.requests = requests;
 const models = __importStar(require("./lib/model"));
@@ -39,6 +39,8 @@ exports.models = models;
 const responses = __importStar(require("./lib/response"));
 exports.responses = responses;
 const client = __importStar(require("./lib/client"));
+exports.AddressRuleServiceClient = client.AddressRuleServiceClient;
+exports.AddressServiceClient = client.AddressServiceClient;
 exports.InvoiceServiceClient = client.InvoiceServiceClient;
 exports.SubscriptionServiceClient = client.SubscriptionServiceClient;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/ospgateway/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AACnD,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/ospgateway/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,wBAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,QAAA,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AACnD,QAAA,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AACnD,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC"}

package/lib/client.d.ts

@@ -13,6 +13,137 @@
 import common = require("oci-common");
 import * as requests from "./request";
 import * as responses from "./response";
+export declare enum AddressRuleServiceApiKeys {
+}
+/**
+ * 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 AddressRuleServiceClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    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;
+    /**
+     * 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).
+     * 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);
+    /**
+     * Get the address rule for the compartment based on the country code
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetAddressRuleRequest
+     * @return GetAddressRuleResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/GetAddressRule.ts.html |here} to see how to use GetAddressRule API.
+     */
+    getAddressRule(getAddressRuleRequest: requests.GetAddressRuleRequest): Promise<responses.GetAddressRuleResponse>;
+}
+export declare enum AddressServiceApiKeys {
+}
+/**
+ * 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 AddressServiceClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    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;
+    /**
+     * 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).
+     * 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);
+    /**
+     * Get the address by id for the compartment
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetAddressRequest
+     * @return GetAddressResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/GetAddress.ts.html |here} to see how to use GetAddress API.
+     */
+    getAddress(getAddressRequest: requests.GetAddressRequest): Promise<responses.GetAddressResponse>;
+    /**
+     * Verify address
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param VerifyAddressRequest
+     * @return VerifyAddressResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/VerifyAddress.ts.html |here} to see how to use VerifyAddress API.
+     */
+    verifyAddress(verifyAddressRequest: requests.VerifyAddressRequest): Promise<responses.VerifyAddressResponse>;
+}
 export declare enum InvoiceServiceApiKeys {
 }
 /**
@@ -66,47 +197,47 @@ export declare class InvoiceServiceClient {
     set regionId(regionId: string);
     /**
      * Returns an invoice in pdf format
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DownloadPdfContentRequest
      * @return DownloadPdfContentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/DownloadPdfContent.ts.html |here} to see how to use DownloadPdfContent API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/DownloadPdfContent.ts.html |here} to see how to use DownloadPdfContent API.
      */
     downloadPdfContent(downloadPdfContentRequest: requests.DownloadPdfContentRequest): Promise<responses.DownloadPdfContentResponse>;
     /**
      * Returns an invoice by invoice id
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetInvoiceRequest
      * @return GetInvoiceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/GetInvoice.ts.html |here} to see how to use GetInvoice API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/GetInvoice.ts.html |here} to see how to use GetInvoice API.
      */
     getInvoice(getInvoiceRequest: requests.GetInvoiceRequest): Promise<responses.GetInvoiceResponse>;
     /**
      * Returns the invoice product list by invoice id
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListInvoiceLinesRequest
      * @return ListInvoiceLinesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/ListInvoiceLines.ts.html |here} to see how to use ListInvoiceLines API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/ListInvoiceLines.ts.html |here} to see how to use ListInvoiceLines API.
      */
     listInvoiceLines(listInvoiceLinesRequest: requests.ListInvoiceLinesRequest): Promise<responses.ListInvoiceLinesResponse>;
     /**
      * Returns a list of invoices
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListInvoicesRequest
      * @return ListInvoicesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/ListInvoices.ts.html |here} to see how to use ListInvoices API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/ListInvoices.ts.html |here} to see how to use ListInvoices API.
      */
     listInvoices(listInvoicesRequest: requests.ListInvoicesRequest): Promise<responses.ListInvoicesResponse>;
     /**
      * Pay an invoice
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param PayInvoiceRequest
      * @return PayInvoiceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/PayInvoice.ts.html |here} to see how to use PayInvoice API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/PayInvoice.ts.html |here} to see how to use PayInvoice API.
      */
     payInvoice(payInvoiceRequest: requests.PayInvoiceRequest): Promise<responses.PayInvoiceResponse>;
 }
@@ -163,47 +294,47 @@ export declare class SubscriptionServiceClient {
     set regionId(regionId: string);
     /**
      * PSD2 authorization for subscription payment
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param AuthorizeSubscriptionPaymentRequest
      * @return AuthorizeSubscriptionPaymentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/AuthorizeSubscriptionPayment.ts.html |here} to see how to use AuthorizeSubscriptionPayment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/AuthorizeSubscriptionPayment.ts.html |here} to see how to use AuthorizeSubscriptionPayment API.
      */
     authorizeSubscriptionPayment(authorizeSubscriptionPaymentRequest: requests.AuthorizeSubscriptionPaymentRequest): Promise<responses.AuthorizeSubscriptionPaymentResponse>;
     /**
      * Get the subscription plan.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetSubscriptionRequest
      * @return GetSubscriptionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/GetSubscription.ts.html |here} to see how to use GetSubscription API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/GetSubscription.ts.html |here} to see how to use GetSubscription API.
      */
     getSubscription(getSubscriptionRequest: requests.GetSubscriptionRequest): Promise<responses.GetSubscriptionResponse>;
     /**
      * Get the subscription data for the compartment
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.62.3/ospgateway/ListSubscriptions.ts.html |here} to see how to use ListSubscriptions API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/ListSubscriptions.ts.html |here} to see how to use ListSubscriptions API.
      */
     listSubscriptions(listSubscriptionsRequest: requests.ListSubscriptionsRequest): Promise<responses.ListSubscriptionsResponse>;
     /**
      * Pay a subscription
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param PaySubscriptionRequest
      * @return PaySubscriptionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/PaySubscription.ts.html |here} to see how to use PaySubscription API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/PaySubscription.ts.html |here} to see how to use PaySubscription API.
      */
     paySubscription(paySubscriptionRequest: requests.PaySubscriptionRequest): Promise<responses.PaySubscriptionResponse>;
     /**
      * Update plan of the subscription.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param UpdateSubscriptionRequest
      * @return UpdateSubscriptionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/ospgateway/UpdateSubscription.ts.html |here} to see how to use UpdateSubscription API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.64.0/ospgateway/UpdateSubscription.ts.html |here} to see how to use UpdateSubscription API.
      */
     updateSubscription(updateSubscriptionRequest: requests.UpdateSubscriptionRequest): Promise<responses.UpdateSubscriptionResponse>;
 }