cloudflare
Version:
The official TypeScript library for the Cloudflare API
138 lines • 5.85 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseCredentials = /* @__PURE__ */ (() => {
class BaseCredentials extends 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(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(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(path `/accounts/${account_id}/vuln_scanner/credential_sets/${credentialSetID}/credentials`, (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(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(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(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;
})();
export class Credentials extends BaseCredentials {
}
//# sourceMappingURL=credentials.mjs.map