cloudflare
Version:
The official TypeScript library for the Cloudflare API
143 lines • 6.13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Credentials = exports.BaseCredentials = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../core/resource.js");
const pagination_1 = require("../../../core/pagination.js");
const path_1 = require("../../../internal/utils/path.js");
var BaseCredentials = /* @__PURE__ */ (() => {
class BaseCredentials extends resource_1.APIResource {
/**
* Creates a new credential within a credential set.
*
* @example
* ```ts
* const credential =
* await client.vulnerabilityScanner.credentialSets.credentials.create(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* location: 'header',
* location_name: 'Authorization',
* name: 'Admin API key',
* value: 'Bearer EXAMPLE_TOKEN',
* },
* );
* ```
*/
create(credentialSetID, params, options) {
const { account_id, ...body } = params;
return this._client.post((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credentialSetID}/credentials`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Replaces a credential. All fields must be provided.
*
* @example
* ```ts
* const credential =
* await client.vulnerabilityScanner.credentialSets.credentials.update(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* credential_set_id:
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* location: 'header',
* location_name: 'Authorization',
* name: 'Admin API key',
* value: 'Bearer EXAMPLE_TOKEN',
* },
* );
* ```
*/
update(credentialID, params, options) {
const { account_id, credential_set_id, ...body } = params;
return this._client.put((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credential_set_id}/credentials/${credentialID}`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Returns all credentials within a credential set.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const credentialListResponse of client.vulnerabilityScanner.credentialSets.credentials.list(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(credentialSetID, params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credentialSetID}/credentials`, (pagination_1.V4PagePaginationArray), { query, ...options });
}
/**
* Deletes a credential.
*
* @example
* ```ts
* const credential =
* await client.vulnerabilityScanner.credentialSets.credentials.delete(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* credential_set_id:
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* },
* );
* ```
*/
delete(credentialID, params, options) {
const { account_id, credential_set_id } = params;
return this._client.delete((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credential_set_id}/credentials/${credentialID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Updates a credential with only the provided fields; omitted fields remain
* unchanged.
*
* @example
* ```ts
* const response =
* await client.vulnerabilityScanner.credentialSets.credentials.edit(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* credential_set_id:
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* },
* );
* ```
*/
edit(credentialID, params, options) {
const { account_id, credential_set_id, ...body } = params;
return this._client.patch((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credential_set_id}/credentials/${credentialID}`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Returns a single credential by ID.
*
* @example
* ```ts
* const credential =
* await client.vulnerabilityScanner.credentialSets.credentials.get(
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* credential_set_id:
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
* },
* );
* ```
*/
get(credentialID, params, options) {
const { account_id, credential_set_id } = params;
return this._client.get((0, path_1.path) `/accounts/${account_id}/vuln_scanner/credential_sets/${credential_set_id}/credentials/${credentialID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseCredentials._key = Object.freeze(['vulnerabilityScanner', 'credentialSets', 'credentials']);
return BaseCredentials;
})();
exports.BaseCredentials = BaseCredentials;
class Credentials extends BaseCredentials {
}
exports.Credentials = Credentials;
//# sourceMappingURL=credentials.js.map