oci-apigateway 2.25.0 → 2.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +6 -0
- package/index.js +7 -1
- package/index.js.map +1 -1
- package/lib/client.d.ts +287 -61
- package/lib/client.js +1302 -222
- package/lib/client.js.map +1 -1
- package/lib/model/api-specification-request-policies.d.ts +1 -0
- package/lib/model/api-specification-request-policies.js +5 -1
- package/lib/model/api-specification-request-policies.js.map +1 -1
- package/lib/model/api-specification-route-backend.js +2 -2
- package/lib/model/api-specification-route-backend.js.map +1 -1
- package/lib/model/authentication-policy.js +2 -2
- package/lib/model/authentication-policy.js.map +1 -1
- package/lib/model/ca-bundle.js +2 -2
- package/lib/model/ca-bundle.js.map +1 -1
- package/lib/model/change-subscriber-compartment-details.d.ts +30 -0
- package/lib/model/change-subscriber-compartment-details.js +32 -0
- package/lib/model/change-subscriber-compartment-details.js.map +1 -0
- package/lib/model/change-usage-plan-compartment-details.d.ts +30 -0
- package/lib/model/change-usage-plan-compartment-details.js +32 -0
- package/lib/model/change-usage-plan-compartment-details.js.map +1 -0
- package/lib/model/client-summary.d.ts +28 -0
- package/lib/model/client-summary.js +32 -0
- package/lib/model/client-summary.js.map +1 -0
- package/lib/model/client.d.ts +32 -0
- package/lib/model/client.js +32 -0
- package/lib/model/client.js.map +1 -0
- package/lib/model/content-validation.js +2 -2
- package/lib/model/content-validation.js.map +1 -1
- package/lib/model/create-deployment-details.d.ts +1 -1
- package/lib/model/create-subscriber-details.d.ts +73 -0
- package/lib/model/create-subscriber-details.js +64 -0
- package/lib/model/create-subscriber-details.js.map +1 -0
- package/lib/model/create-usage-plan-details.d.ts +68 -0
- package/lib/model/create-usage-plan-details.js +64 -0
- package/lib/model/create-usage-plan-details.js.map +1 -0
- package/lib/model/deployment.d.ts +1 -1
- package/lib/model/entitlement-summary.d.ts +39 -0
- package/lib/model/entitlement-summary.js +60 -0
- package/lib/model/entitlement-summary.js.map +1 -0
- package/lib/model/entitlement-target.d.ts +31 -0
- package/lib/model/entitlement-target.js +32 -0
- package/lib/model/entitlement-target.js.map +1 -0
- package/lib/model/entitlement.d.ts +44 -0
- package/lib/model/entitlement.js +70 -0
- package/lib/model/entitlement.js.map +1 -0
- package/lib/model/index.d.ts +40 -0
- package/lib/model/index.js +43 -3
- package/lib/model/index.js.map +1 -1
- package/lib/model/public-key-set.js +2 -2
- package/lib/model/public-key-set.js.map +1 -1
- package/lib/model/quota.d.ts +78 -0
- package/lib/model/quota.js +64 -0
- package/lib/model/quota.js.map +1 -0
- package/lib/model/rate-limit.d.ts +44 -0
- package/lib/model/rate-limit.js +41 -0
- package/lib/model/rate-limit.js.map +1 -0
- package/lib/model/response-cache-details.js +2 -2
- package/lib/model/response-cache-details.js.map +1 -1
- package/lib/model/response-cache-lookup-policy.js +2 -2
- package/lib/model/response-cache-lookup-policy.js.map +1 -1
- package/lib/model/response-cache-store-policy.js +2 -2
- package/lib/model/response-cache-store-policy.js.map +1 -1
- package/lib/model/route-authorization-policy.js +2 -2
- package/lib/model/route-authorization-policy.js.map +1 -1
- package/lib/model/static-public-key.js +2 -2
- package/lib/model/static-public-key.js.map +1 -1
- package/lib/model/subscriber-collection.d.ts +29 -0
- package/lib/model/subscriber-collection.js +64 -0
- package/lib/model/subscriber-collection.js.map +1 -0
- package/lib/model/subscriber-summary.d.ts +97 -0
- package/lib/model/subscriber-summary.js +64 -0
- package/lib/model/subscriber-summary.js.map +1 -0
- package/lib/model/subscriber.d.ts +111 -0
- package/lib/model/subscriber.js +78 -0
- package/lib/model/subscriber.js.map +1 -0
- package/lib/model/update-subscriber-details.d.ts +67 -0
- package/lib/model/update-subscriber-details.js +64 -0
- package/lib/model/update-subscriber-details.js.map +1 -0
- package/lib/model/update-usage-plan-details.d.ts +62 -0
- package/lib/model/update-usage-plan-details.js +64 -0
- package/lib/model/update-usage-plan-details.js.map +1 -0
- package/lib/model/usage-plan-collection.d.ts +29 -0
- package/lib/model/usage-plan-collection.js +64 -0
- package/lib/model/usage-plan-collection.js.map +1 -0
- package/lib/model/usage-plan-summary.d.ts +92 -0
- package/lib/model/usage-plan-summary.js +64 -0
- package/lib/model/usage-plan-summary.js.map +1 -0
- package/lib/model/usage-plan.d.ts +106 -0
- package/lib/model/usage-plan.js +78 -0
- package/lib/model/usage-plan.js.map +1 -0
- package/lib/model/usage-plans-policy.d.ts +34 -0
- package/lib/model/usage-plans-policy.js +32 -0
- package/lib/model/usage-plans-policy.js.map +1 -0
- package/lib/model/work-request.d.ts +6 -0
- package/lib/model/work-request.js +6 -0
- package/lib/model/work-request.js.map +1 -1
- package/lib/request/cancel-work-request-request.d.ts +1 -1
- package/lib/request/change-api-compartment-request.d.ts +1 -1
- package/lib/request/change-certificate-compartment-request.d.ts +1 -1
- package/lib/request/change-deployment-compartment-request.d.ts +1 -1
- package/lib/request/change-gateway-compartment-request.d.ts +1 -1
- package/lib/request/change-subscriber-compartment-request.d.ts +49 -0
- package/lib/request/change-subscriber-compartment-request.js +15 -0
- package/lib/request/change-subscriber-compartment-request.js.map +1 -0
- package/lib/request/change-usage-plan-compartment-request.d.ts +49 -0
- package/lib/request/change-usage-plan-compartment-request.js +15 -0
- package/lib/request/change-usage-plan-compartment-request.js.map +1 -0
- package/lib/request/create-api-request.d.ts +1 -1
- package/lib/request/create-certificate-request.d.ts +1 -1
- package/lib/request/create-deployment-request.d.ts +1 -1
- package/lib/request/create-gateway-request.d.ts +1 -1
- package/lib/request/create-sdk-request.d.ts +1 -1
- package/lib/request/create-subscriber-request.d.ts +36 -0
- package/lib/request/create-subscriber-request.js +15 -0
- package/lib/request/create-subscriber-request.js.map +1 -0
- package/lib/request/create-usage-plan-request.d.ts +36 -0
- package/lib/request/create-usage-plan-request.js +15 -0
- package/lib/request/create-usage-plan-request.js.map +1 -0
- package/lib/request/delete-api-request.d.ts +1 -1
- package/lib/request/delete-certificate-request.d.ts +1 -1
- package/lib/request/delete-deployment-request.d.ts +1 -1
- package/lib/request/delete-gateway-request.d.ts +1 -1
- package/lib/request/delete-sdk-request.d.ts +1 -1
- package/lib/request/delete-subscriber-request.d.ts +35 -0
- package/lib/request/delete-subscriber-request.js +15 -0
- package/lib/request/delete-subscriber-request.js.map +1 -0
- package/lib/request/delete-usage-plan-request.d.ts +35 -0
- package/lib/request/delete-usage-plan-request.js +15 -0
- package/lib/request/delete-usage-plan-request.js.map +1 -0
- package/lib/request/get-api-content-request.d.ts +1 -1
- package/lib/request/get-api-deployment-specification-request.d.ts +1 -1
- package/lib/request/get-api-request.d.ts +1 -1
- package/lib/request/get-api-validations-request.d.ts +1 -1
- package/lib/request/get-certificate-request.d.ts +1 -1
- package/lib/request/get-deployment-request.d.ts +1 -1
- package/lib/request/get-gateway-request.d.ts +1 -1
- package/lib/request/get-sdk-request.d.ts +1 -1
- package/lib/request/get-subscriber-request.d.ts +26 -0
- package/lib/request/get-subscriber-request.js +15 -0
- package/lib/request/get-subscriber-request.js.map +1 -0
- package/lib/request/get-usage-plan-request.d.ts +26 -0
- package/lib/request/get-usage-plan-request.js +15 -0
- package/lib/request/get-usage-plan-request.js.map +1 -0
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/index.d.ts +24 -0
- package/lib/request/index.js +5 -1
- package/lib/request/index.js.map +1 -1
- package/lib/request/list-apis-request.d.ts +1 -1
- package/lib/request/list-certificates-request.d.ts +1 -1
- package/lib/request/list-deployments-request.d.ts +1 -1
- package/lib/request/list-gateways-request.d.ts +1 -1
- package/lib/request/list-sdk-language-types-request.d.ts +1 -1
- package/lib/request/list-sdks-request.d.ts +1 -1
- package/lib/request/list-subscribers-request.d.ts +69 -0
- package/lib/request/list-subscribers-request.js +29 -0
- package/lib/request/list-subscribers-request.js.map +1 -0
- package/lib/request/list-usage-plans-request.d.ts +69 -0
- package/lib/request/list-usage-plans-request.js +29 -0
- package/lib/request/list-usage-plans-request.js.map +1 -0
- package/lib/request/list-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/update-api-request.d.ts +1 -1
- package/lib/request/update-certificate-request.d.ts +1 -1
- package/lib/request/update-deployment-request.d.ts +1 -1
- package/lib/request/update-gateway-request.d.ts +1 -1
- package/lib/request/update-sdk-request.d.ts +1 -1
- package/lib/request/update-subscriber-request.d.ts +40 -0
- package/lib/request/update-subscriber-request.js +15 -0
- package/lib/request/update-subscriber-request.js.map +1 -0
- package/lib/request/update-usage-plan-request.d.ts +40 -0
- package/lib/request/update-usage-plan-request.js +15 -0
- package/lib/request/update-usage-plan-request.js.map +1 -0
- package/lib/response/change-subscriber-compartment-response.d.ts +29 -0
- package/lib/response/change-subscriber-compartment-response.js +15 -0
- package/lib/response/change-subscriber-compartment-response.js.map +1 -0
- package/lib/response/change-usage-plan-compartment-response.d.ts +29 -0
- package/lib/response/change-usage-plan-compartment-response.js +15 -0
- package/lib/response/change-usage-plan-compartment-response.js.map +1 -0
- package/lib/response/create-subscriber-response.d.ts +44 -0
- package/lib/response/create-subscriber-response.js +15 -0
- package/lib/response/create-subscriber-response.js.map +1 -0
- package/lib/response/create-usage-plan-response.d.ts +44 -0
- package/lib/response/create-usage-plan-response.js +15 -0
- package/lib/response/create-usage-plan-response.js.map +1 -0
- package/lib/response/delete-subscriber-response.d.ts +29 -0
- package/lib/response/delete-subscriber-response.js +15 -0
- package/lib/response/delete-subscriber-response.js.map +1 -0
- package/lib/response/delete-usage-plan-response.d.ts +29 -0
- package/lib/response/delete-usage-plan-response.js +15 -0
- package/lib/response/delete-usage-plan-response.js.map +1 -0
- package/lib/response/get-subscriber-response.d.ts +31 -0
- package/lib/response/get-subscriber-response.js +15 -0
- package/lib/response/get-subscriber-response.js.map +1 -0
- package/lib/response/get-usage-plan-response.d.ts +31 -0
- package/lib/response/get-usage-plan-response.js +15 -0
- package/lib/response/get-usage-plan-response.js.map +1 -0
- package/lib/response/index.d.ts +24 -0
- package/lib/response/list-subscribers-response.d.ts +42 -0
- package/lib/response/list-subscribers-response.js +15 -0
- package/lib/response/list-subscribers-response.js.map +1 -0
- package/lib/response/list-usage-plans-response.d.ts +42 -0
- package/lib/response/list-usage-plans-response.js +15 -0
- package/lib/response/list-usage-plans-response.js.map +1 -0
- package/lib/response/update-subscriber-response.d.ts +29 -0
- package/lib/response/update-subscriber-response.js +15 -0
- package/lib/response/update-subscriber-response.js.map +1 -0
- package/lib/response/update-usage-plan-response.d.ts +29 -0
- package/lib/response/update-usage-plan-response.js +15 -0
- package/lib/response/update-usage-plan-response.js.map +1 -0
- package/lib/subscribers-waiter.d.ts +32 -0
- package/lib/subscribers-waiter.js +68 -0
- package/lib/subscribers-waiter.js.map +1 -0
- package/lib/usageplans-waiter.d.ts +32 -0
- package/lib/usageplans-waiter.js +68 -0
- package/lib/usageplans-waiter.js.map +1 -0
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -19,6 +19,8 @@ import * as responses from "./response";
|
|
|
19
19
|
import { ApiGatewayWaiter } from "./apigateway-waiter";
|
|
20
20
|
import { DeploymentWaiter } from "./deployment-waiter";
|
|
21
21
|
import { GatewayWaiter } from "./gateway-waiter";
|
|
22
|
+
import { SubscribersWaiter } from "./subscribers-waiter";
|
|
23
|
+
import { UsagePlansWaiter } from "./usageplans-waiter";
|
|
22
24
|
import { WorkRequestsWaiter } from "./workrequests-waiter";
|
|
23
25
|
export declare enum ApiGatewayApiKeys {
|
|
24
26
|
}
|
|
@@ -34,6 +36,7 @@ export declare class ApiGatewayClient {
|
|
|
34
36
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
35
37
|
protected _circuitBreaker: null;
|
|
36
38
|
protected _httpOptions: any;
|
|
39
|
+
targetService: string;
|
|
37
40
|
protected _httpClient: common.HttpClient;
|
|
38
41
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
39
42
|
/**
|
|
@@ -80,7 +83,7 @@ export declare class ApiGatewayClient {
|
|
|
80
83
|
* @param ChangeApiCompartmentRequest
|
|
81
84
|
* @return ChangeApiCompartmentResponse
|
|
82
85
|
* @throws OciError when an error occurs
|
|
83
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
86
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeApiCompartment.ts.html |here} to see how to use ChangeApiCompartment API.
|
|
84
87
|
*/
|
|
85
88
|
changeApiCompartment(changeApiCompartmentRequest: requests.ChangeApiCompartmentRequest): Promise<responses.ChangeApiCompartmentResponse>;
|
|
86
89
|
/**
|
|
@@ -89,36 +92,36 @@ export declare class ApiGatewayClient {
|
|
|
89
92
|
* @param ChangeCertificateCompartmentRequest
|
|
90
93
|
* @return ChangeCertificateCompartmentResponse
|
|
91
94
|
* @throws OciError when an error occurs
|
|
92
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
95
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeCertificateCompartment.ts.html |here} to see how to use ChangeCertificateCompartment API.
|
|
93
96
|
*/
|
|
94
97
|
changeCertificateCompartment(changeCertificateCompartmentRequest: requests.ChangeCertificateCompartmentRequest): Promise<responses.ChangeCertificateCompartmentResponse>;
|
|
95
98
|
/**
|
|
96
99
|
* Creates a new API.
|
|
97
100
|
*
|
|
98
|
-
* This operation
|
|
101
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
99
102
|
* @param CreateApiRequest
|
|
100
103
|
* @return CreateApiResponse
|
|
101
104
|
* @throws OciError when an error occurs
|
|
102
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
105
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateApi.ts.html |here} to see how to use CreateApi API.
|
|
103
106
|
*/
|
|
104
107
|
createApi(createApiRequest: requests.CreateApiRequest): Promise<responses.CreateApiResponse>;
|
|
105
108
|
/**
|
|
106
109
|
* Creates a new Certificate.
|
|
107
110
|
*
|
|
108
|
-
* This operation
|
|
111
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
109
112
|
* @param CreateCertificateRequest
|
|
110
113
|
* @return CreateCertificateResponse
|
|
111
114
|
* @throws OciError when an error occurs
|
|
112
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
115
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateCertificate.ts.html |here} to see how to use CreateCertificate API.
|
|
113
116
|
*/
|
|
114
117
|
createCertificate(createCertificateRequest: requests.CreateCertificateRequest): Promise<responses.CreateCertificateResponse>;
|
|
115
118
|
/**
|
|
116
119
|
* Creates a new SDK.
|
|
117
|
-
* This operation
|
|
120
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
118
121
|
* @param CreateSdkRequest
|
|
119
122
|
* @return CreateSdkResponse
|
|
120
123
|
* @throws OciError when an error occurs
|
|
121
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
124
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateSdk.ts.html |here} to see how to use CreateSdk API.
|
|
122
125
|
*/
|
|
123
126
|
createSdk(createSdkRequest: requests.CreateSdkRequest): Promise<responses.CreateSdkResponse>;
|
|
124
127
|
/**
|
|
@@ -127,7 +130,7 @@ export declare class ApiGatewayClient {
|
|
|
127
130
|
* @param DeleteApiRequest
|
|
128
131
|
* @return DeleteApiResponse
|
|
129
132
|
* @throws OciError when an error occurs
|
|
130
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
133
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteApi.ts.html |here} to see how to use DeleteApi API.
|
|
131
134
|
*/
|
|
132
135
|
deleteApi(deleteApiRequest: requests.DeleteApiRequest): Promise<responses.DeleteApiResponse>;
|
|
133
136
|
/**
|
|
@@ -136,7 +139,7 @@ export declare class ApiGatewayClient {
|
|
|
136
139
|
* @param DeleteCertificateRequest
|
|
137
140
|
* @return DeleteCertificateResponse
|
|
138
141
|
* @throws OciError when an error occurs
|
|
139
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
142
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteCertificate.ts.html |here} to see how to use DeleteCertificate API.
|
|
140
143
|
*/
|
|
141
144
|
deleteCertificate(deleteCertificateRequest: requests.DeleteCertificateRequest): Promise<responses.DeleteCertificateResponse>;
|
|
142
145
|
/**
|
|
@@ -145,99 +148,99 @@ export declare class ApiGatewayClient {
|
|
|
145
148
|
* @param DeleteSdkRequest
|
|
146
149
|
* @return DeleteSdkResponse
|
|
147
150
|
* @throws OciError when an error occurs
|
|
148
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
151
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteSdk.ts.html |here} to see how to use DeleteSdk API.
|
|
149
152
|
*/
|
|
150
153
|
deleteSdk(deleteSdkRequest: requests.DeleteSdkRequest): Promise<responses.DeleteSdkResponse>;
|
|
151
154
|
/**
|
|
152
155
|
* Gets an API by identifier.
|
|
153
|
-
* This operation
|
|
156
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
154
157
|
* @param GetApiRequest
|
|
155
158
|
* @return GetApiResponse
|
|
156
159
|
* @throws OciError when an error occurs
|
|
157
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
160
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetApi.ts.html |here} to see how to use GetApi API.
|
|
158
161
|
*/
|
|
159
162
|
getApi(getApiRequest: requests.GetApiRequest): Promise<responses.GetApiResponse>;
|
|
160
163
|
/**
|
|
161
164
|
* Get the raw API content.
|
|
162
|
-
* This operation
|
|
165
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
163
166
|
* @param GetApiContentRequest
|
|
164
167
|
* @return GetApiContentResponse
|
|
165
168
|
* @throws OciError when an error occurs
|
|
166
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
169
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetApiContent.ts.html |here} to see how to use GetApiContent API.
|
|
167
170
|
*/
|
|
168
171
|
getApiContent(getApiContentRequest: requests.GetApiContentRequest): Promise<responses.GetApiContentResponse>;
|
|
169
172
|
/**
|
|
170
173
|
* Gets an API Deployment specification by identifier.
|
|
171
|
-
* This operation
|
|
174
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
172
175
|
* @param GetApiDeploymentSpecificationRequest
|
|
173
176
|
* @return GetApiDeploymentSpecificationResponse
|
|
174
177
|
* @throws OciError when an error occurs
|
|
175
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
178
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetApiDeploymentSpecification.ts.html |here} to see how to use GetApiDeploymentSpecification API.
|
|
176
179
|
*/
|
|
177
180
|
getApiDeploymentSpecification(getApiDeploymentSpecificationRequest: requests.GetApiDeploymentSpecificationRequest): Promise<responses.GetApiDeploymentSpecificationResponse>;
|
|
178
181
|
/**
|
|
179
182
|
* Gets the API validation results.
|
|
180
|
-
* This operation
|
|
183
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
181
184
|
* @param GetApiValidationsRequest
|
|
182
185
|
* @return GetApiValidationsResponse
|
|
183
186
|
* @throws OciError when an error occurs
|
|
184
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
187
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetApiValidations.ts.html |here} to see how to use GetApiValidations API.
|
|
185
188
|
*/
|
|
186
189
|
getApiValidations(getApiValidationsRequest: requests.GetApiValidationsRequest): Promise<responses.GetApiValidationsResponse>;
|
|
187
190
|
/**
|
|
188
191
|
* Gets a certificate by identifier.
|
|
189
|
-
* This operation
|
|
192
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
190
193
|
* @param GetCertificateRequest
|
|
191
194
|
* @return GetCertificateResponse
|
|
192
195
|
* @throws OciError when an error occurs
|
|
193
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
196
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetCertificate.ts.html |here} to see how to use GetCertificate API.
|
|
194
197
|
*/
|
|
195
198
|
getCertificate(getCertificateRequest: requests.GetCertificateRequest): Promise<responses.GetCertificateResponse>;
|
|
196
199
|
/**
|
|
197
200
|
* Return object store downloadable URL and metadata.
|
|
198
|
-
* This operation
|
|
201
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
199
202
|
* @param GetSdkRequest
|
|
200
203
|
* @return GetSdkResponse
|
|
201
204
|
* @throws OciError when an error occurs
|
|
202
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
205
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetSdk.ts.html |here} to see how to use GetSdk API.
|
|
203
206
|
*/
|
|
204
207
|
getSdk(getSdkRequest: requests.GetSdkRequest): Promise<responses.GetSdkResponse>;
|
|
205
208
|
/**
|
|
206
209
|
* Returns a list of APIs.
|
|
207
210
|
*
|
|
208
|
-
* This operation
|
|
211
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
209
212
|
* @param ListApisRequest
|
|
210
213
|
* @return ListApisResponse
|
|
211
214
|
* @throws OciError when an error occurs
|
|
212
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
215
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListApis.ts.html |here} to see how to use ListApis API.
|
|
213
216
|
*/
|
|
214
217
|
listApis(listApisRequest: requests.ListApisRequest): Promise<responses.ListApisResponse>;
|
|
215
218
|
/**
|
|
216
219
|
* Returns a list of certificates.
|
|
217
220
|
*
|
|
218
|
-
* This operation
|
|
221
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
219
222
|
* @param ListCertificatesRequest
|
|
220
223
|
* @return ListCertificatesResponse
|
|
221
224
|
* @throws OciError when an error occurs
|
|
222
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
225
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListCertificates.ts.html |here} to see how to use ListCertificates API.
|
|
223
226
|
*/
|
|
224
227
|
listCertificates(listCertificatesRequest: requests.ListCertificatesRequest): Promise<responses.ListCertificatesResponse>;
|
|
225
228
|
/**
|
|
226
229
|
* Lists programming languages in which SDK can be generated.
|
|
227
|
-
* This operation
|
|
230
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
228
231
|
* @param ListSdkLanguageTypesRequest
|
|
229
232
|
* @return ListSdkLanguageTypesResponse
|
|
230
233
|
* @throws OciError when an error occurs
|
|
231
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
234
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListSdkLanguageTypes.ts.html |here} to see how to use ListSdkLanguageTypes API.
|
|
232
235
|
*/
|
|
233
236
|
listSdkLanguageTypes(listSdkLanguageTypesRequest: requests.ListSdkLanguageTypesRequest): Promise<responses.ListSdkLanguageTypesResponse>;
|
|
234
237
|
/**
|
|
235
238
|
* Returns list of generated SDKs.
|
|
236
|
-
* This operation
|
|
239
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
237
240
|
* @param ListSdksRequest
|
|
238
241
|
* @return ListSdksResponse
|
|
239
242
|
* @throws OciError when an error occurs
|
|
240
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
243
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListSdks.ts.html |here} to see how to use ListSdks API.
|
|
241
244
|
*/
|
|
242
245
|
listSdks(listSdksRequest: requests.ListSdksRequest): Promise<responses.ListSdksResponse>;
|
|
243
246
|
/**
|
|
@@ -246,7 +249,7 @@ export declare class ApiGatewayClient {
|
|
|
246
249
|
* @param UpdateApiRequest
|
|
247
250
|
* @return UpdateApiResponse
|
|
248
251
|
* @throws OciError when an error occurs
|
|
249
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
252
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateApi.ts.html |here} to see how to use UpdateApi API.
|
|
250
253
|
*/
|
|
251
254
|
updateApi(updateApiRequest: requests.UpdateApiRequest): Promise<responses.UpdateApiResponse>;
|
|
252
255
|
/**
|
|
@@ -255,7 +258,7 @@ export declare class ApiGatewayClient {
|
|
|
255
258
|
* @param UpdateCertificateRequest
|
|
256
259
|
* @return UpdateCertificateResponse
|
|
257
260
|
* @throws OciError when an error occurs
|
|
258
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
261
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateCertificate.ts.html |here} to see how to use UpdateCertificate API.
|
|
259
262
|
*/
|
|
260
263
|
updateCertificate(updateCertificateRequest: requests.UpdateCertificateRequest): Promise<responses.UpdateCertificateResponse>;
|
|
261
264
|
/**
|
|
@@ -264,7 +267,7 @@ export declare class ApiGatewayClient {
|
|
|
264
267
|
* @param UpdateSdkRequest
|
|
265
268
|
* @return UpdateSdkResponse
|
|
266
269
|
* @throws OciError when an error occurs
|
|
267
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
270
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateSdk.ts.html |here} to see how to use UpdateSdk API.
|
|
268
271
|
*/
|
|
269
272
|
updateSdk(updateSdkRequest: requests.UpdateSdkRequest): Promise<responses.UpdateSdkResponse>;
|
|
270
273
|
}
|
|
@@ -282,6 +285,7 @@ export declare class DeploymentClient {
|
|
|
282
285
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
283
286
|
protected _circuitBreaker: null;
|
|
284
287
|
protected _httpOptions: any;
|
|
288
|
+
targetService: string;
|
|
285
289
|
protected _httpClient: common.HttpClient;
|
|
286
290
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
287
291
|
/**
|
|
@@ -328,17 +332,17 @@ export declare class DeploymentClient {
|
|
|
328
332
|
* @param ChangeDeploymentCompartmentRequest
|
|
329
333
|
* @return ChangeDeploymentCompartmentResponse
|
|
330
334
|
* @throws OciError when an error occurs
|
|
331
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
335
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeDeploymentCompartment.ts.html |here} to see how to use ChangeDeploymentCompartment API.
|
|
332
336
|
*/
|
|
333
337
|
changeDeploymentCompartment(changeDeploymentCompartmentRequest: requests.ChangeDeploymentCompartmentRequest): Promise<responses.ChangeDeploymentCompartmentResponse>;
|
|
334
338
|
/**
|
|
335
339
|
* Creates a new deployment.
|
|
336
340
|
*
|
|
337
|
-
* This operation
|
|
341
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
338
342
|
* @param CreateDeploymentRequest
|
|
339
343
|
* @return CreateDeploymentResponse
|
|
340
344
|
* @throws OciError when an error occurs
|
|
341
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
345
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateDeployment.ts.html |here} to see how to use CreateDeployment API.
|
|
342
346
|
*/
|
|
343
347
|
createDeployment(createDeploymentRequest: requests.CreateDeploymentRequest): Promise<responses.CreateDeploymentResponse>;
|
|
344
348
|
/**
|
|
@@ -347,26 +351,26 @@ export declare class DeploymentClient {
|
|
|
347
351
|
* @param DeleteDeploymentRequest
|
|
348
352
|
* @return DeleteDeploymentResponse
|
|
349
353
|
* @throws OciError when an error occurs
|
|
350
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
354
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteDeployment.ts.html |here} to see how to use DeleteDeployment API.
|
|
351
355
|
*/
|
|
352
356
|
deleteDeployment(deleteDeploymentRequest: requests.DeleteDeploymentRequest): Promise<responses.DeleteDeploymentResponse>;
|
|
353
357
|
/**
|
|
354
358
|
* Gets a deployment by identifier.
|
|
355
|
-
* This operation
|
|
359
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
356
360
|
* @param GetDeploymentRequest
|
|
357
361
|
* @return GetDeploymentResponse
|
|
358
362
|
* @throws OciError when an error occurs
|
|
359
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
363
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetDeployment.ts.html |here} to see how to use GetDeployment API.
|
|
360
364
|
*/
|
|
361
365
|
getDeployment(getDeploymentRequest: requests.GetDeploymentRequest): Promise<responses.GetDeploymentResponse>;
|
|
362
366
|
/**
|
|
363
367
|
* Returns a list of deployments.
|
|
364
368
|
*
|
|
365
|
-
* This operation
|
|
369
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
366
370
|
* @param ListDeploymentsRequest
|
|
367
371
|
* @return ListDeploymentsResponse
|
|
368
372
|
* @throws OciError when an error occurs
|
|
369
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
373
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListDeployments.ts.html |here} to see how to use ListDeployments API.
|
|
370
374
|
*/
|
|
371
375
|
listDeployments(listDeploymentsRequest: requests.ListDeploymentsRequest): Promise<responses.ListDeploymentsResponse>;
|
|
372
376
|
/**
|
|
@@ -375,7 +379,7 @@ export declare class DeploymentClient {
|
|
|
375
379
|
* @param UpdateDeploymentRequest
|
|
376
380
|
* @return UpdateDeploymentResponse
|
|
377
381
|
* @throws OciError when an error occurs
|
|
378
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
382
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateDeployment.ts.html |here} to see how to use UpdateDeployment API.
|
|
379
383
|
*/
|
|
380
384
|
updateDeployment(updateDeploymentRequest: requests.UpdateDeploymentRequest): Promise<responses.UpdateDeploymentResponse>;
|
|
381
385
|
}
|
|
@@ -393,6 +397,7 @@ export declare class GatewayClient {
|
|
|
393
397
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
394
398
|
protected _circuitBreaker: null;
|
|
395
399
|
protected _httpOptions: any;
|
|
400
|
+
targetService: string;
|
|
396
401
|
protected _httpClient: common.HttpClient;
|
|
397
402
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
398
403
|
/**
|
|
@@ -439,17 +444,17 @@ export declare class GatewayClient {
|
|
|
439
444
|
* @param ChangeGatewayCompartmentRequest
|
|
440
445
|
* @return ChangeGatewayCompartmentResponse
|
|
441
446
|
* @throws OciError when an error occurs
|
|
442
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
447
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeGatewayCompartment.ts.html |here} to see how to use ChangeGatewayCompartment API.
|
|
443
448
|
*/
|
|
444
449
|
changeGatewayCompartment(changeGatewayCompartmentRequest: requests.ChangeGatewayCompartmentRequest): Promise<responses.ChangeGatewayCompartmentResponse>;
|
|
445
450
|
/**
|
|
446
451
|
* Creates a new gateway.
|
|
447
452
|
*
|
|
448
|
-
* This operation
|
|
453
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
449
454
|
* @param CreateGatewayRequest
|
|
450
455
|
* @return CreateGatewayResponse
|
|
451
456
|
* @throws OciError when an error occurs
|
|
452
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
457
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateGateway.ts.html |here} to see how to use CreateGateway API.
|
|
453
458
|
*/
|
|
454
459
|
createGateway(createGatewayRequest: requests.CreateGatewayRequest): Promise<responses.CreateGatewayResponse>;
|
|
455
460
|
/**
|
|
@@ -458,26 +463,26 @@ export declare class GatewayClient {
|
|
|
458
463
|
* @param DeleteGatewayRequest
|
|
459
464
|
* @return DeleteGatewayResponse
|
|
460
465
|
* @throws OciError when an error occurs
|
|
461
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
466
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteGateway.ts.html |here} to see how to use DeleteGateway API.
|
|
462
467
|
*/
|
|
463
468
|
deleteGateway(deleteGatewayRequest: requests.DeleteGatewayRequest): Promise<responses.DeleteGatewayResponse>;
|
|
464
469
|
/**
|
|
465
470
|
* Gets a gateway by identifier.
|
|
466
|
-
* This operation
|
|
471
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
467
472
|
* @param GetGatewayRequest
|
|
468
473
|
* @return GetGatewayResponse
|
|
469
474
|
* @throws OciError when an error occurs
|
|
470
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
475
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetGateway.ts.html |here} to see how to use GetGateway API.
|
|
471
476
|
*/
|
|
472
477
|
getGateway(getGatewayRequest: requests.GetGatewayRequest): Promise<responses.GetGatewayResponse>;
|
|
473
478
|
/**
|
|
474
479
|
* Returns a list of gateways.
|
|
475
480
|
*
|
|
476
|
-
* This operation
|
|
481
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
477
482
|
* @param ListGatewaysRequest
|
|
478
483
|
* @return ListGatewaysResponse
|
|
479
484
|
* @throws OciError when an error occurs
|
|
480
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
485
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListGateways.ts.html |here} to see how to use ListGateways API.
|
|
481
486
|
*/
|
|
482
487
|
listGateways(listGatewaysRequest: requests.ListGatewaysRequest): Promise<responses.ListGatewaysResponse>;
|
|
483
488
|
/**
|
|
@@ -486,10 +491,230 @@ export declare class GatewayClient {
|
|
|
486
491
|
* @param UpdateGatewayRequest
|
|
487
492
|
* @return UpdateGatewayResponse
|
|
488
493
|
* @throws OciError when an error occurs
|
|
489
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
494
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateGateway.ts.html |here} to see how to use UpdateGateway API.
|
|
490
495
|
*/
|
|
491
496
|
updateGateway(updateGatewayRequest: requests.UpdateGatewayRequest): Promise<responses.UpdateGatewayResponse>;
|
|
492
497
|
}
|
|
498
|
+
export declare enum SubscribersApiKeys {
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
502
|
+
*/
|
|
503
|
+
export declare class SubscribersClient {
|
|
504
|
+
protected static serviceEndpointTemplate: string;
|
|
505
|
+
protected static endpointServiceName: string;
|
|
506
|
+
protected "_endpoint": string;
|
|
507
|
+
protected "_defaultHeaders": any;
|
|
508
|
+
protected "_waiters": SubscribersWaiter;
|
|
509
|
+
protected "_clientConfiguration": common.ClientConfiguration;
|
|
510
|
+
protected _circuitBreaker: null;
|
|
511
|
+
protected _httpOptions: any;
|
|
512
|
+
targetService: string;
|
|
513
|
+
protected _httpClient: common.HttpClient;
|
|
514
|
+
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
515
|
+
/**
|
|
516
|
+
* Get the endpoint that is being used to call (ex, https://www.example.com).
|
|
517
|
+
*/
|
|
518
|
+
get endpoint(): string;
|
|
519
|
+
/**
|
|
520
|
+
* Sets the endpoint to call (ex, https://www.example.com).
|
|
521
|
+
* @param endpoint The endpoint of the service.
|
|
522
|
+
*/
|
|
523
|
+
set endpoint(endpoint: string);
|
|
524
|
+
get logger(): import("oci-common/lib/log").Logger;
|
|
525
|
+
/**
|
|
526
|
+
* Sets the region to call (ex, Region.US_PHOENIX_1).
|
|
527
|
+
* Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
|
|
528
|
+
* @param region The region of the service.
|
|
529
|
+
*/
|
|
530
|
+
set region(region: common.Region);
|
|
531
|
+
/**
|
|
532
|
+
* Sets the regionId to call (ex, 'us-phoenix-1').
|
|
533
|
+
*
|
|
534
|
+
* Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
|
|
535
|
+
* If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
|
|
536
|
+
* and then call {@link #endpoint(String) endpoint}.
|
|
537
|
+
* @param regionId The public region ID.
|
|
538
|
+
*/
|
|
539
|
+
set regionId(regionId: string);
|
|
540
|
+
/**
|
|
541
|
+
* Creates a new SubscribersWaiter for resources for this service.
|
|
542
|
+
*
|
|
543
|
+
* @param config The waiter configuration for termination and delay strategy
|
|
544
|
+
* @return The service waiters.
|
|
545
|
+
*/
|
|
546
|
+
createWaiters(config?: common.WaiterConfiguration): SubscribersWaiter;
|
|
547
|
+
/**
|
|
548
|
+
* Gets the waiters available for resources for this service.
|
|
549
|
+
*
|
|
550
|
+
* @return The service waiters.
|
|
551
|
+
*/
|
|
552
|
+
getWaiters(): SubscribersWaiter;
|
|
553
|
+
/**
|
|
554
|
+
* Changes the subscriber compartment.
|
|
555
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
556
|
+
* @param ChangeSubscriberCompartmentRequest
|
|
557
|
+
* @return ChangeSubscriberCompartmentResponse
|
|
558
|
+
* @throws OciError when an error occurs
|
|
559
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeSubscriberCompartment.ts.html |here} to see how to use ChangeSubscriberCompartment API.
|
|
560
|
+
*/
|
|
561
|
+
changeSubscriberCompartment(changeSubscriberCompartmentRequest: requests.ChangeSubscriberCompartmentRequest): Promise<responses.ChangeSubscriberCompartmentResponse>;
|
|
562
|
+
/**
|
|
563
|
+
* Creates a new subscriber.
|
|
564
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
565
|
+
* @param CreateSubscriberRequest
|
|
566
|
+
* @return CreateSubscriberResponse
|
|
567
|
+
* @throws OciError when an error occurs
|
|
568
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateSubscriber.ts.html |here} to see how to use CreateSubscriber API.
|
|
569
|
+
*/
|
|
570
|
+
createSubscriber(createSubscriberRequest: requests.CreateSubscriberRequest): Promise<responses.CreateSubscriberResponse>;
|
|
571
|
+
/**
|
|
572
|
+
* Deletes the subscriber with the given identifier.
|
|
573
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
574
|
+
* @param DeleteSubscriberRequest
|
|
575
|
+
* @return DeleteSubscriberResponse
|
|
576
|
+
* @throws OciError when an error occurs
|
|
577
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteSubscriber.ts.html |here} to see how to use DeleteSubscriber API.
|
|
578
|
+
*/
|
|
579
|
+
deleteSubscriber(deleteSubscriberRequest: requests.DeleteSubscriberRequest): Promise<responses.DeleteSubscriberResponse>;
|
|
580
|
+
/**
|
|
581
|
+
* Gets a subscriber by identifier.
|
|
582
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
583
|
+
* @param GetSubscriberRequest
|
|
584
|
+
* @return GetSubscriberResponse
|
|
585
|
+
* @throws OciError when an error occurs
|
|
586
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetSubscriber.ts.html |here} to see how to use GetSubscriber API.
|
|
587
|
+
*/
|
|
588
|
+
getSubscriber(getSubscriberRequest: requests.GetSubscriberRequest): Promise<responses.GetSubscriberResponse>;
|
|
589
|
+
/**
|
|
590
|
+
* Returns a list of subscribers.
|
|
591
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
592
|
+
* @param ListSubscribersRequest
|
|
593
|
+
* @return ListSubscribersResponse
|
|
594
|
+
* @throws OciError when an error occurs
|
|
595
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListSubscribers.ts.html |here} to see how to use ListSubscribers API.
|
|
596
|
+
*/
|
|
597
|
+
listSubscribers(listSubscribersRequest: requests.ListSubscribersRequest): Promise<responses.ListSubscribersResponse>;
|
|
598
|
+
/**
|
|
599
|
+
* Updates the subscriber with the given identifier.
|
|
600
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
601
|
+
* @param UpdateSubscriberRequest
|
|
602
|
+
* @return UpdateSubscriberResponse
|
|
603
|
+
* @throws OciError when an error occurs
|
|
604
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateSubscriber.ts.html |here} to see how to use UpdateSubscriber API.
|
|
605
|
+
*/
|
|
606
|
+
updateSubscriber(updateSubscriberRequest: requests.UpdateSubscriberRequest): Promise<responses.UpdateSubscriberResponse>;
|
|
607
|
+
}
|
|
608
|
+
export declare enum UsagePlansApiKeys {
|
|
609
|
+
}
|
|
610
|
+
/**
|
|
611
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
612
|
+
*/
|
|
613
|
+
export declare class UsagePlansClient {
|
|
614
|
+
protected static serviceEndpointTemplate: string;
|
|
615
|
+
protected static endpointServiceName: string;
|
|
616
|
+
protected "_endpoint": string;
|
|
617
|
+
protected "_defaultHeaders": any;
|
|
618
|
+
protected "_waiters": UsagePlansWaiter;
|
|
619
|
+
protected "_clientConfiguration": common.ClientConfiguration;
|
|
620
|
+
protected _circuitBreaker: null;
|
|
621
|
+
protected _httpOptions: any;
|
|
622
|
+
targetService: string;
|
|
623
|
+
protected _httpClient: common.HttpClient;
|
|
624
|
+
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
625
|
+
/**
|
|
626
|
+
* Get the endpoint that is being used to call (ex, https://www.example.com).
|
|
627
|
+
*/
|
|
628
|
+
get endpoint(): string;
|
|
629
|
+
/**
|
|
630
|
+
* Sets the endpoint to call (ex, https://www.example.com).
|
|
631
|
+
* @param endpoint The endpoint of the service.
|
|
632
|
+
*/
|
|
633
|
+
set endpoint(endpoint: string);
|
|
634
|
+
get logger(): import("oci-common/lib/log").Logger;
|
|
635
|
+
/**
|
|
636
|
+
* Sets the region to call (ex, Region.US_PHOENIX_1).
|
|
637
|
+
* Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
|
|
638
|
+
* @param region The region of the service.
|
|
639
|
+
*/
|
|
640
|
+
set region(region: common.Region);
|
|
641
|
+
/**
|
|
642
|
+
* Sets the regionId to call (ex, 'us-phoenix-1').
|
|
643
|
+
*
|
|
644
|
+
* Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
|
|
645
|
+
* If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
|
|
646
|
+
* and then call {@link #endpoint(String) endpoint}.
|
|
647
|
+
* @param regionId The public region ID.
|
|
648
|
+
*/
|
|
649
|
+
set regionId(regionId: string);
|
|
650
|
+
/**
|
|
651
|
+
* Creates a new UsagePlansWaiter for resources for this service.
|
|
652
|
+
*
|
|
653
|
+
* @param config The waiter configuration for termination and delay strategy
|
|
654
|
+
* @return The service waiters.
|
|
655
|
+
*/
|
|
656
|
+
createWaiters(config?: common.WaiterConfiguration): UsagePlansWaiter;
|
|
657
|
+
/**
|
|
658
|
+
* Gets the waiters available for resources for this service.
|
|
659
|
+
*
|
|
660
|
+
* @return The service waiters.
|
|
661
|
+
*/
|
|
662
|
+
getWaiters(): UsagePlansWaiter;
|
|
663
|
+
/**
|
|
664
|
+
* Changes the usage plan compartment.
|
|
665
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
666
|
+
* @param ChangeUsagePlanCompartmentRequest
|
|
667
|
+
* @return ChangeUsagePlanCompartmentResponse
|
|
668
|
+
* @throws OciError when an error occurs
|
|
669
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ChangeUsagePlanCompartment.ts.html |here} to see how to use ChangeUsagePlanCompartment API.
|
|
670
|
+
*/
|
|
671
|
+
changeUsagePlanCompartment(changeUsagePlanCompartmentRequest: requests.ChangeUsagePlanCompartmentRequest): Promise<responses.ChangeUsagePlanCompartmentResponse>;
|
|
672
|
+
/**
|
|
673
|
+
* Creates a new usage plan.
|
|
674
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
675
|
+
* @param CreateUsagePlanRequest
|
|
676
|
+
* @return CreateUsagePlanResponse
|
|
677
|
+
* @throws OciError when an error occurs
|
|
678
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CreateUsagePlan.ts.html |here} to see how to use CreateUsagePlan API.
|
|
679
|
+
*/
|
|
680
|
+
createUsagePlan(createUsagePlanRequest: requests.CreateUsagePlanRequest): Promise<responses.CreateUsagePlanResponse>;
|
|
681
|
+
/**
|
|
682
|
+
* Deletes the usage plan with the given identifier.
|
|
683
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
684
|
+
* @param DeleteUsagePlanRequest
|
|
685
|
+
* @return DeleteUsagePlanResponse
|
|
686
|
+
* @throws OciError when an error occurs
|
|
687
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/DeleteUsagePlan.ts.html |here} to see how to use DeleteUsagePlan API.
|
|
688
|
+
*/
|
|
689
|
+
deleteUsagePlan(deleteUsagePlanRequest: requests.DeleteUsagePlanRequest): Promise<responses.DeleteUsagePlanResponse>;
|
|
690
|
+
/**
|
|
691
|
+
* Gets a usage plan by identifier.
|
|
692
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
693
|
+
* @param GetUsagePlanRequest
|
|
694
|
+
* @return GetUsagePlanResponse
|
|
695
|
+
* @throws OciError when an error occurs
|
|
696
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetUsagePlan.ts.html |here} to see how to use GetUsagePlan API.
|
|
697
|
+
*/
|
|
698
|
+
getUsagePlan(getUsagePlanRequest: requests.GetUsagePlanRequest): Promise<responses.GetUsagePlanResponse>;
|
|
699
|
+
/**
|
|
700
|
+
* Returns a list of usage plans.
|
|
701
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
702
|
+
* @param ListUsagePlansRequest
|
|
703
|
+
* @return ListUsagePlansResponse
|
|
704
|
+
* @throws OciError when an error occurs
|
|
705
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListUsagePlans.ts.html |here} to see how to use ListUsagePlans API.
|
|
706
|
+
*/
|
|
707
|
+
listUsagePlans(listUsagePlansRequest: requests.ListUsagePlansRequest): Promise<responses.ListUsagePlansResponse>;
|
|
708
|
+
/**
|
|
709
|
+
* Updates the usage plan with the given identifier.
|
|
710
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
711
|
+
* @param UpdateUsagePlanRequest
|
|
712
|
+
* @return UpdateUsagePlanResponse
|
|
713
|
+
* @throws OciError when an error occurs
|
|
714
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/UpdateUsagePlan.ts.html |here} to see how to use UpdateUsagePlan API.
|
|
715
|
+
*/
|
|
716
|
+
updateUsagePlan(updateUsagePlanRequest: requests.UpdateUsagePlanRequest): Promise<responses.UpdateUsagePlanResponse>;
|
|
717
|
+
}
|
|
493
718
|
export declare enum WorkRequestsApiKeys {
|
|
494
719
|
}
|
|
495
720
|
/**
|
|
@@ -504,6 +729,7 @@ export declare class WorkRequestsClient {
|
|
|
504
729
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
505
730
|
protected _circuitBreaker: null;
|
|
506
731
|
protected _httpOptions: any;
|
|
732
|
+
targetService: string;
|
|
507
733
|
protected _httpClient: common.HttpClient;
|
|
508
734
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
509
735
|
/**
|
|
@@ -550,46 +776,46 @@ export declare class WorkRequestsClient {
|
|
|
550
776
|
* @param CancelWorkRequestRequest
|
|
551
777
|
* @return CancelWorkRequestResponse
|
|
552
778
|
* @throws OciError when an error occurs
|
|
553
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
779
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
|
|
554
780
|
*/
|
|
555
781
|
cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
|
|
556
782
|
/**
|
|
557
783
|
* Gets the status of the work request with the given identifier.
|
|
558
|
-
* This operation
|
|
784
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
559
785
|
* @param GetWorkRequestRequest
|
|
560
786
|
* @return GetWorkRequestResponse
|
|
561
787
|
* @throws OciError when an error occurs
|
|
562
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
788
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
563
789
|
*/
|
|
564
790
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
565
791
|
/**
|
|
566
792
|
* Returns a (paginated) list of errors for a given work request.
|
|
567
793
|
*
|
|
568
|
-
* This operation
|
|
794
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
569
795
|
* @param ListWorkRequestErrorsRequest
|
|
570
796
|
* @return ListWorkRequestErrorsResponse
|
|
571
797
|
* @throws OciError when an error occurs
|
|
572
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
798
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
|
|
573
799
|
*/
|
|
574
800
|
listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
|
|
575
801
|
/**
|
|
576
802
|
* Returns a (paginated) list of logs for a given work request.
|
|
577
803
|
*
|
|
578
|
-
* This operation
|
|
804
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
579
805
|
* @param ListWorkRequestLogsRequest
|
|
580
806
|
* @return ListWorkRequestLogsResponse
|
|
581
807
|
* @throws OciError when an error occurs
|
|
582
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
808
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
|
|
583
809
|
*/
|
|
584
810
|
listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
|
|
585
811
|
/**
|
|
586
812
|
* Lists the work requests in a compartment.
|
|
587
813
|
*
|
|
588
|
-
* This operation
|
|
814
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
589
815
|
* @param ListWorkRequestsRequest
|
|
590
816
|
* @return ListWorkRequestsResponse
|
|
591
817
|
* @throws OciError when an error occurs
|
|
592
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
818
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/apigateway/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
593
819
|
*/
|
|
594
820
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
595
821
|
}
|