@fonoster/sdk 0.6.4 → 0.6.6
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/README.md +519 -454
- package/dist/node/Acls.d.ts +43 -44
- package/dist/node/Acls.js +62 -49
- package/dist/node/Agents.d.ts +44 -45
- package/dist/node/Agents.js +47 -46
- package/dist/node/ApiKeys.d.ts +29 -29
- package/dist/node/ApiKeys.js +29 -29
- package/dist/node/Applications.d.ts +39 -39
- package/dist/node/Applications.js +52 -40
- package/dist/node/Calls.d.ts +28 -29
- package/dist/node/Calls.js +32 -27
- package/dist/node/Credentials.d.ts +39 -39
- package/dist/node/Credentials.js +39 -39
- package/dist/node/Domains.d.ts +37 -37
- package/dist/node/Domains.js +37 -37
- package/dist/node/Numbers.d.ts +40 -40
- package/dist/node/Numbers.js +40 -40
- package/dist/node/Secrets.d.ts +37 -37
- package/dist/node/Secrets.js +37 -37
- package/dist/node/Trunks.d.ts +58 -52
- package/dist/node/Trunks.js +104 -70
- package/dist/node/Users.d.ts +34 -34
- package/dist/node/Users.js +34 -34
- package/dist/node/Workspaces.d.ts +55 -54
- package/dist/node/Workspaces.js +61 -54
- package/dist/node/client/jsonToObject.js +1 -1
- package/dist/node/client/makeRpcRequest.js +1 -1
- package/dist/node/client/objectToJson.d.ts +1 -1
- package/dist/node/client/objectToJson.js +12 -2
- package/dist/node/client/types/IdentityClient.d.ts +2 -2
- package/dist/node/client/utils.js +6 -3
- package/dist/node/generated/node/agents_grpc_pb.js +0 -2
- package/dist/node/generated/node/agents_pb.js +444 -24
- package/dist/node/generated/node/applications_pb.js +6 -6
- package/dist/node/generated/node/credentials_pb.js +11 -41
- package/dist/node/generated/node/domains_pb.js +30 -30
- package/dist/node/generated/node/identity_grpc_pb.js +14 -14
- package/dist/node/generated/node/identity_pb.js +37 -37
- package/dist/node/generated/node/numbers_grpc_pb.js +0 -1
- package/dist/node/generated/node/numbers_pb.js +191 -11
- package/dist/node/generated/node/trunks_grpc_pb.js +0 -2
- package/dist/node/generated/node/trunks_pb.js +526 -31
- package/dist/node/generated/web/IdentityServiceClientPb.ts +5 -5
- package/dist/node/generated/web/agents_pb.d.ts +62 -10
- package/dist/node/generated/web/agents_pb.js +444 -24
- package/dist/node/generated/web/applications_pb.js +6 -6
- package/dist/node/generated/web/credentials_pb.d.ts +0 -4
- package/dist/node/generated/web/credentials_pb.js +11 -41
- package/dist/node/generated/web/domains_pb.js +30 -30
- package/dist/node/generated/web/identity_pb.d.ts +13 -13
- package/dist/node/generated/web/identity_pb.js +37 -37
- package/dist/node/generated/web/numbers_pb.d.ts +26 -4
- package/dist/node/generated/web/numbers_pb.js +191 -11
- package/dist/node/generated/web/trunks_pb.d.ts +71 -11
- package/dist/node/generated/web/trunks_pb.js +526 -31
- package/dist/node/tsconfig.node.tsbuildinfo +1 -1
- package/dist/node/utils.d.ts +4 -3
- package/dist/node/utils.js +36 -0
- package/dist/web/fonoster.min.js +1 -1
- package/dist/web/index.esm.js +1 -1
- package/package.json +5 -4
package/dist/node/Numbers.d.ts
CHANGED
|
@@ -10,11 +10,11 @@ import { FonosterClient } from "./client/types";
|
|
|
10
10
|
* const SDK = require("@fonoster/sdk");
|
|
11
11
|
*
|
|
12
12
|
* async function main(request) {
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* const API_KEY = "your-api-key";
|
|
14
|
+
* const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
|
|
15
15
|
*
|
|
16
|
-
*
|
|
17
|
-
* const client = SDK.Client({ accessKeyId });
|
|
16
|
+
* try {
|
|
17
|
+
* const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
|
|
18
18
|
* await client.loginWithApiKey(apiKey);
|
|
19
19
|
*
|
|
20
20
|
* const numbers = new SDK.Numbers(client);
|
|
@@ -57,20 +57,20 @@ declare class Numbers {
|
|
|
57
57
|
* @param {string} request.countryIsoCode - The countryIsoCode of the Number
|
|
58
58
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Number
|
|
59
59
|
* @example
|
|
60
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
60
61
|
*
|
|
61
62
|
* const request = {
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
63
|
+
* name: "My Number",
|
|
64
|
+
* telUrl: "tel:+17853178070",
|
|
65
|
+
* city: "Asheville",
|
|
66
|
+
* country: "United States",
|
|
67
|
+
* countryIsoCode: "US"
|
|
67
68
|
* };
|
|
68
69
|
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* .catch(console.error); // an error occurred
|
|
70
|
+
* numbers
|
|
71
|
+
* .createNumber(request)
|
|
72
|
+
* .then(console.log) // successful response
|
|
73
|
+
* .catch(console.error); // an error occurred
|
|
74
74
|
*/
|
|
75
75
|
createNumber(request: CreateNumberRequest): Promise<BaseApiObject>;
|
|
76
76
|
/**
|
|
@@ -79,14 +79,14 @@ declare class Numbers {
|
|
|
79
79
|
* @param {string} ref - The reference of the Number to retrieve
|
|
80
80
|
* @return {Promise<Acl>} - The response object that contains the Number
|
|
81
81
|
* @example
|
|
82
|
-
*
|
|
83
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
84
|
-
*
|
|
85
82
|
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
86
83
|
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
84
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
85
|
+
*
|
|
86
|
+
* numbers
|
|
87
|
+
* .getNumber(ref)
|
|
88
|
+
* .then(console.log) // successful response
|
|
89
|
+
* .catch(console.error); // an error occurred
|
|
90
90
|
*/
|
|
91
91
|
getNumber(ref: string): Promise<INumber>;
|
|
92
92
|
/**
|
|
@@ -97,17 +97,17 @@ declare class Numbers {
|
|
|
97
97
|
* @param {string} request.name - The name of the Number
|
|
98
98
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Number
|
|
99
99
|
* @example
|
|
100
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
100
101
|
*
|
|
101
102
|
* const request = {
|
|
102
|
-
*
|
|
103
|
-
*
|
|
103
|
+
* ref: "00000000-0000-0000-0000-000000000000",
|
|
104
|
+
* name: "My Number"
|
|
104
105
|
* };
|
|
105
106
|
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* .catch(console.error); // an error occurred
|
|
107
|
+
* numbers
|
|
108
|
+
* .updateNumber(request)
|
|
109
|
+
* .then(console.log) // successful response
|
|
110
|
+
* .catch(console.error); // an error occurred
|
|
111
111
|
*/
|
|
112
112
|
updateNumber(request: UpdateNumberRequest): Promise<BaseApiObject>;
|
|
113
113
|
/**
|
|
@@ -118,17 +118,17 @@ declare class Numbers {
|
|
|
118
118
|
* @param {string} request.pageToken - The token to retrieve the next page of Numbers
|
|
119
119
|
* @return {Promise<ListNumbersResponse>} - The response object that contains the list of Numbers
|
|
120
120
|
* @example
|
|
121
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
121
122
|
*
|
|
122
123
|
* const request = {
|
|
123
|
-
*
|
|
124
|
-
*
|
|
124
|
+
* pageSize: 10,
|
|
125
|
+
* pageToken: "00000000-0000-0000-0000-000000000000"
|
|
125
126
|
* };
|
|
126
127
|
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* .catch(console.error); // an error occurred
|
|
128
|
+
* numbers
|
|
129
|
+
* .listNumbers(request)
|
|
130
|
+
* .then(console.log) // successful response
|
|
131
|
+
* .catch(console.error); // an error occurred
|
|
132
132
|
*/
|
|
133
133
|
listNumbers(request: ListNumbersRequest): Promise<ListNumbersResponse>;
|
|
134
134
|
/**
|
|
@@ -138,14 +138,14 @@ declare class Numbers {
|
|
|
138
138
|
* @param {string} ref - The reference of the Number to delete
|
|
139
139
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Number
|
|
140
140
|
* @example
|
|
141
|
-
*
|
|
142
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
143
|
-
*
|
|
144
141
|
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
145
142
|
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
143
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
144
|
+
*
|
|
145
|
+
* numbers
|
|
146
|
+
* .deleteNumber(ref)
|
|
147
|
+
* .then(console.log) // successful response
|
|
148
|
+
* .catch(console.error); // an error occurred
|
|
149
149
|
*/
|
|
150
150
|
deleteNumber(ref: string): Promise<BaseApiObject>;
|
|
151
151
|
}
|
package/dist/node/Numbers.js
CHANGED
|
@@ -13,11 +13,11 @@ const numbers_pb_1 = require("./generated/node/numbers_pb");
|
|
|
13
13
|
* const SDK = require("@fonoster/sdk");
|
|
14
14
|
*
|
|
15
15
|
* async function main(request) {
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* const API_KEY = "your-api-key";
|
|
17
|
+
* const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
|
|
18
18
|
*
|
|
19
|
-
*
|
|
20
|
-
* const client = SDK.Client({ accessKeyId });
|
|
19
|
+
* try {
|
|
20
|
+
* const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
|
|
21
21
|
* await client.loginWithApiKey(apiKey);
|
|
22
22
|
*
|
|
23
23
|
* const numbers = new SDK.Numbers(client);
|
|
@@ -62,20 +62,20 @@ class Numbers {
|
|
|
62
62
|
* @param {string} request.countryIsoCode - The countryIsoCode of the Number
|
|
63
63
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Number
|
|
64
64
|
* @example
|
|
65
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
65
66
|
*
|
|
66
67
|
* const request = {
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
68
|
+
* name: "My Number",
|
|
69
|
+
* telUrl: "tel:+17853178070",
|
|
70
|
+
* city: "Asheville",
|
|
71
|
+
* country: "United States",
|
|
72
|
+
* countryIsoCode: "US"
|
|
72
73
|
* };
|
|
73
74
|
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* .catch(console.error); // an error occurred
|
|
75
|
+
* numbers
|
|
76
|
+
* .createNumber(request)
|
|
77
|
+
* .then(console.log) // successful response
|
|
78
|
+
* .catch(console.error); // an error occurred
|
|
79
79
|
*/
|
|
80
80
|
async createNumber(request) {
|
|
81
81
|
const client = this.client.getNumbersClient();
|
|
@@ -92,14 +92,14 @@ class Numbers {
|
|
|
92
92
|
* @param {string} ref - The reference of the Number to retrieve
|
|
93
93
|
* @return {Promise<Acl>} - The response object that contains the Number
|
|
94
94
|
* @example
|
|
95
|
-
*
|
|
96
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
97
|
-
*
|
|
98
95
|
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
99
96
|
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
97
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
98
|
+
*
|
|
99
|
+
* numbers
|
|
100
|
+
* .getNumber(ref)
|
|
101
|
+
* .then(console.log) // successful response
|
|
102
|
+
* .catch(console.error); // an error occurred
|
|
103
103
|
*/
|
|
104
104
|
async getNumber(ref) {
|
|
105
105
|
const client = this.client.getNumbersClient();
|
|
@@ -118,17 +118,17 @@ class Numbers {
|
|
|
118
118
|
* @param {string} request.name - The name of the Number
|
|
119
119
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Number
|
|
120
120
|
* @example
|
|
121
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
121
122
|
*
|
|
122
123
|
* const request = {
|
|
123
|
-
*
|
|
124
|
-
*
|
|
124
|
+
* ref: "00000000-0000-0000-0000-000000000000",
|
|
125
|
+
* name: "My Number"
|
|
125
126
|
* };
|
|
126
127
|
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* .catch(console.error); // an error occurred
|
|
128
|
+
* numbers
|
|
129
|
+
* .updateNumber(request)
|
|
130
|
+
* .then(console.log) // successful response
|
|
131
|
+
* .catch(console.error); // an error occurred
|
|
132
132
|
*/
|
|
133
133
|
async updateNumber(request) {
|
|
134
134
|
const client = this.client.getNumbersClient();
|
|
@@ -147,17 +147,17 @@ class Numbers {
|
|
|
147
147
|
* @param {string} request.pageToken - The token to retrieve the next page of Numbers
|
|
148
148
|
* @return {Promise<ListNumbersResponse>} - The response object that contains the list of Numbers
|
|
149
149
|
* @example
|
|
150
|
+
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
150
151
|
*
|
|
151
152
|
* const request = {
|
|
152
|
-
*
|
|
153
|
-
*
|
|
153
|
+
* pageSize: 10,
|
|
154
|
+
* pageToken: "00000000-0000-0000-0000-000000000000"
|
|
154
155
|
* };
|
|
155
156
|
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
* .catch(console.error); // an error occurred
|
|
157
|
+
* numbers
|
|
158
|
+
* .listNumbers(request)
|
|
159
|
+
* .then(console.log) // successful response
|
|
160
|
+
* .catch(console.error); // an error occurred
|
|
161
161
|
*/
|
|
162
162
|
async listNumbers(request) {
|
|
163
163
|
const client = this.client.getNumbersClient();
|
|
@@ -176,14 +176,14 @@ class Numbers {
|
|
|
176
176
|
* @param {string} ref - The reference of the Number to delete
|
|
177
177
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Number
|
|
178
178
|
* @example
|
|
179
|
-
*
|
|
180
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
181
|
-
*
|
|
182
179
|
* const numbers = new SDK.Numbers(client); // Existing client object
|
|
183
180
|
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
181
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
182
|
+
*
|
|
183
|
+
* numbers
|
|
184
|
+
* .deleteNumber(ref)
|
|
185
|
+
* .then(console.log) // successful response
|
|
186
|
+
* .catch(console.error); // an error occurred
|
|
187
187
|
*/
|
|
188
188
|
async deleteNumber(ref) {
|
|
189
189
|
const applicationsClient = this.client.getNumbersClient();
|
package/dist/node/Secrets.d.ts
CHANGED
|
@@ -10,11 +10,11 @@ import { FonosterClient } from "./client/types";
|
|
|
10
10
|
* const SDK = require("@fonoster/sdk");
|
|
11
11
|
*
|
|
12
12
|
* async function main(request) {
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* const API_KEY = "your-api-key";
|
|
14
|
+
* const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
|
|
15
15
|
*
|
|
16
|
-
*
|
|
17
|
-
* const client = SDK.Client({ accessKeyId });
|
|
16
|
+
* try {
|
|
17
|
+
* const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
|
|
18
18
|
* await client.loginWithApiKey(apiKey);
|
|
19
19
|
*
|
|
20
20
|
* const secrets = new SDK.Secrets(client);
|
|
@@ -51,17 +51,17 @@ declare class Secrets {
|
|
|
51
51
|
* @param {string} request.secret - The secret of the Secret
|
|
52
52
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Secret
|
|
53
53
|
* @example
|
|
54
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
54
55
|
*
|
|
55
56
|
* const request = {
|
|
56
|
-
*
|
|
57
|
-
*
|
|
57
|
+
* name: "FRIENDLY_NAME",
|
|
58
|
+
* secret: "mysecret"
|
|
58
59
|
* };
|
|
59
60
|
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* .catch(console.error); // an error occurred
|
|
61
|
+
* secrets
|
|
62
|
+
* .createSecret(request)
|
|
63
|
+
* .then(console.log) // successful response
|
|
64
|
+
* .catch(console.error); // an error occurred
|
|
65
65
|
*/
|
|
66
66
|
createSecret(request: CreateSecretRequest): Promise<BaseApiObject>;
|
|
67
67
|
/**
|
|
@@ -70,14 +70,14 @@ declare class Secrets {
|
|
|
70
70
|
* @param {string} ref - The reference of the Secret to retrieve
|
|
71
71
|
* @return {Promise<Acl>} - The response object that contains the Secret
|
|
72
72
|
* @example
|
|
73
|
-
*
|
|
74
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
75
|
-
*
|
|
76
73
|
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
77
74
|
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
75
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
76
|
+
*
|
|
77
|
+
* secrets
|
|
78
|
+
* .getSecret(ref)
|
|
79
|
+
* .then(console.log) // successful response
|
|
80
|
+
* .catch(console.error); // an error occurred
|
|
81
81
|
*/
|
|
82
82
|
getSecret(ref: string): Promise<Secret>;
|
|
83
83
|
/**
|
|
@@ -89,17 +89,17 @@ declare class Secrets {
|
|
|
89
89
|
* @param {string} request.secret - The secret of the Secret
|
|
90
90
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Secret
|
|
91
91
|
* @example
|
|
92
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
92
93
|
*
|
|
93
94
|
* const request = {
|
|
94
|
-
*
|
|
95
|
-
*
|
|
95
|
+
* ref: "00000000-0000-0000-0000-000000000000",
|
|
96
|
+
* secret: "mysecret"
|
|
96
97
|
* };
|
|
97
98
|
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* .catch(console.error); // an error occurred
|
|
99
|
+
* secrets
|
|
100
|
+
* .updateSecret(request)
|
|
101
|
+
* .then(console.log) // successful response
|
|
102
|
+
* .catch(console.error); // an error occurred
|
|
103
103
|
*/
|
|
104
104
|
updateSecret(request: UpdateSecretRequest): Promise<BaseApiObject>;
|
|
105
105
|
/**
|
|
@@ -110,17 +110,17 @@ declare class Secrets {
|
|
|
110
110
|
* @param {string} request.pageToken - The token to retrieve the next page of Secrets
|
|
111
111
|
* @return {Promise<ListSecretsResponse>} - The response object that contains the list of Secrets
|
|
112
112
|
* @example
|
|
113
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
113
114
|
*
|
|
114
115
|
* const request = {
|
|
115
|
-
*
|
|
116
|
-
*
|
|
116
|
+
* pageSize: 10,
|
|
117
|
+
* pageToken: "00000000-0000-0000-0000-000000000000"
|
|
117
118
|
* };
|
|
118
119
|
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* .catch(console.error); // an error occurred
|
|
120
|
+
* secrets
|
|
121
|
+
* .listSecrets(request)
|
|
122
|
+
* .then(console.log) // successful response
|
|
123
|
+
* .catch(console.error); // an error occurred
|
|
124
124
|
*/
|
|
125
125
|
listSecrets(request: ListSecretsRequest): Promise<ListSecretsResponse>;
|
|
126
126
|
/**
|
|
@@ -130,14 +130,14 @@ declare class Secrets {
|
|
|
130
130
|
* @param {string} ref - The reference of the Secret to delete
|
|
131
131
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Secret
|
|
132
132
|
* @example
|
|
133
|
-
*
|
|
134
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
135
|
-
*
|
|
136
133
|
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
137
134
|
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
135
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
136
|
+
*
|
|
137
|
+
* secrets
|
|
138
|
+
* .deleteSecret(ref)
|
|
139
|
+
* .then(console.log) // successful response
|
|
140
|
+
* .catch(console.error); // an error occurred
|
|
141
141
|
*/
|
|
142
142
|
deleteSecret(ref: string): Promise<BaseApiObject>;
|
|
143
143
|
}
|
package/dist/node/Secrets.js
CHANGED
|
@@ -13,11 +13,11 @@ const secrets_pb_1 = require("./generated/node/secrets_pb");
|
|
|
13
13
|
* const SDK = require("@fonoster/sdk");
|
|
14
14
|
*
|
|
15
15
|
* async function main(request) {
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* const API_KEY = "your-api-key";
|
|
17
|
+
* const ACCESS_KEY_ID = "00000000-0000-0000-0000-000000000000";
|
|
18
18
|
*
|
|
19
|
-
*
|
|
20
|
-
* const client = SDK.Client({ accessKeyId });
|
|
19
|
+
* try {
|
|
20
|
+
* const client = SDK.Client({ accessKeyId: ACCESS_KEY_ID });
|
|
21
21
|
* await client.loginWithApiKey(apiKey);
|
|
22
22
|
*
|
|
23
23
|
* const secrets = new SDK.Secrets(client);
|
|
@@ -56,17 +56,17 @@ class Secrets {
|
|
|
56
56
|
* @param {string} request.secret - The secret of the Secret
|
|
57
57
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the created Secret
|
|
58
58
|
* @example
|
|
59
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
59
60
|
*
|
|
60
61
|
* const request = {
|
|
61
|
-
*
|
|
62
|
-
*
|
|
62
|
+
* name: "FRIENDLY_NAME",
|
|
63
|
+
* secret: "mysecret"
|
|
63
64
|
* };
|
|
64
65
|
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* .catch(console.error); // an error occurred
|
|
66
|
+
* secrets
|
|
67
|
+
* .createSecret(request)
|
|
68
|
+
* .then(console.log) // successful response
|
|
69
|
+
* .catch(console.error); // an error occurred
|
|
70
70
|
*/
|
|
71
71
|
async createSecret(request) {
|
|
72
72
|
const client = this.client.getSecretsClient();
|
|
@@ -83,14 +83,14 @@ class Secrets {
|
|
|
83
83
|
* @param {string} ref - The reference of the Secret to retrieve
|
|
84
84
|
* @return {Promise<Acl>} - The response object that contains the Secret
|
|
85
85
|
* @example
|
|
86
|
-
*
|
|
87
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
88
|
-
*
|
|
89
86
|
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
90
87
|
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
88
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
89
|
+
*
|
|
90
|
+
* secrets
|
|
91
|
+
* .getSecret(ref)
|
|
92
|
+
* .then(console.log) // successful response
|
|
93
|
+
* .catch(console.error); // an error occurred
|
|
94
94
|
*/
|
|
95
95
|
async getSecret(ref) {
|
|
96
96
|
const client = this.client.getSecretsClient();
|
|
@@ -110,17 +110,17 @@ class Secrets {
|
|
|
110
110
|
* @param {string} request.secret - The secret of the Secret
|
|
111
111
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the updated Secret
|
|
112
112
|
* @example
|
|
113
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
113
114
|
*
|
|
114
115
|
* const request = {
|
|
115
|
-
*
|
|
116
|
-
*
|
|
116
|
+
* ref: "00000000-0000-0000-0000-000000000000",
|
|
117
|
+
* secret: "mysecret"
|
|
117
118
|
* };
|
|
118
119
|
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* .catch(console.error); // an error occurred
|
|
120
|
+
* secrets
|
|
121
|
+
* .updateSecret(request)
|
|
122
|
+
* .then(console.log) // successful response
|
|
123
|
+
* .catch(console.error); // an error occurred
|
|
124
124
|
*/
|
|
125
125
|
async updateSecret(request) {
|
|
126
126
|
const client = this.client.getSecretsClient();
|
|
@@ -139,17 +139,17 @@ class Secrets {
|
|
|
139
139
|
* @param {string} request.pageToken - The token to retrieve the next page of Secrets
|
|
140
140
|
* @return {Promise<ListSecretsResponse>} - The response object that contains the list of Secrets
|
|
141
141
|
* @example
|
|
142
|
+
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
142
143
|
*
|
|
143
144
|
* const request = {
|
|
144
|
-
*
|
|
145
|
-
*
|
|
145
|
+
* pageSize: 10,
|
|
146
|
+
* pageToken: "00000000-0000-0000-0000-000000000000"
|
|
146
147
|
* };
|
|
147
148
|
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* .catch(console.error); // an error occurred
|
|
149
|
+
* secrets
|
|
150
|
+
* .listSecrets(request)
|
|
151
|
+
* .then(console.log) // successful response
|
|
152
|
+
* .catch(console.error); // an error occurred
|
|
153
153
|
*/
|
|
154
154
|
async listSecrets(request) {
|
|
155
155
|
const client = this.client.getSecretsClient();
|
|
@@ -168,14 +168,14 @@ class Secrets {
|
|
|
168
168
|
* @param {string} ref - The reference of the Secret to delete
|
|
169
169
|
* @return {Promise<BaseApiObject>} - The response object that contains the reference to the deleted Secret
|
|
170
170
|
* @example
|
|
171
|
-
*
|
|
172
|
-
* const ref = "00000000-0000-0000-0000-000000000000"
|
|
173
|
-
*
|
|
174
171
|
* const secrets = new SDK.Secrets(client); // Existing client object
|
|
175
172
|
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
173
|
+
* const ref = "00000000-0000-0000-0000-000000000000";
|
|
174
|
+
*
|
|
175
|
+
* secrets
|
|
176
|
+
* .deleteSecret(ref)
|
|
177
|
+
* .then(console.log) // successful response
|
|
178
|
+
* .catch(console.error); // an error occurred
|
|
179
179
|
*/
|
|
180
180
|
async deleteSecret(ref) {
|
|
181
181
|
const applicationsClient = this.client.getSecretsClient();
|