cloudflare
Version:
The official TypeScript library for the Cloudflare API
217 lines • 8.61 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { CloudflareError } from "../../../core/error.mjs";
import { V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseServiceTokens = /* @__PURE__ */ (() => {
class BaseServiceTokens extends APIResource {
/**
* Generates a new service token. **Note:** This is the only time you can get the
* Client Secret. If you lose the Client Secret, you will have to rotate the Client
* Secret or create a new service token.
*
* @example
* ```ts
* const serviceToken =
* await client.zeroTrust.access.serviceTokens.create({
* name: 'CI/CD token',
* account_id: 'account_id',
* });
* ```
*/
create(params, options) {
const { account_id, zone_id, ...body } = params;
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.post(path `/${accountOrZone}/${accountOrZoneId}/access/service_tokens`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Updates a configured service token.
*
* @example
* ```ts
* const serviceToken =
* await client.zeroTrust.access.serviceTokens.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: 'account_id' },
* );
* ```
*/
update(serviceTokenID, params, options) {
const { account_id, zone_id, ...body } = params;
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.put(path `/${accountOrZone}/${accountOrZoneId}/access/service_tokens/${serviceTokenID}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Lists all service tokens.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const serviceToken of client.zeroTrust.access.serviceTokens.list(
* { account_id: 'account_id' },
* )) {
* // ...
* }
* ```
*/
list(params = {}, options) {
const { account_id, zone_id, ...query } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.getAPIList(path `/${accountOrZone}/${accountOrZoneId}/access/service_tokens`, (V4PagePaginationArray), { query, ...options });
}
/**
* Deletes a service token.
*
* @example
* ```ts
* const serviceToken =
* await client.zeroTrust.access.serviceTokens.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: 'account_id' },
* );
* ```
*/
delete(serviceTokenID, params = {}, options) {
const { account_id, zone_id } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.delete(path `/${accountOrZone}/${accountOrZoneId}/access/service_tokens/${serviceTokenID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Fetches a single service token.
*
* @example
* ```ts
* const serviceToken =
* await client.zeroTrust.access.serviceTokens.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: 'account_id' },
* );
* ```
*/
get(serviceTokenID, params = {}, options) {
const { account_id, zone_id } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.get(path `/${accountOrZone}/${accountOrZoneId}/access/service_tokens/${serviceTokenID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Refreshes the expiration of a service token.
*
* @example
* ```ts
* const serviceToken =
* await client.zeroTrust.access.serviceTokens.refresh(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
refresh(serviceTokenID, params, options) {
const { account_id } = params;
return this._client.post(path `/accounts/${account_id}/access/service_tokens/${serviceTokenID}/refresh`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Generates a new Client Secret for a service token and revokes the old one.
*
* @example
* ```ts
* const response =
* await client.zeroTrust.access.serviceTokens.rotate(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
rotate(serviceTokenID, params, options) {
const { account_id, ...body } = params;
return this._client.post(path `/accounts/${account_id}/access/service_tokens/${serviceTokenID}/rotate`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
}
BaseServiceTokens._key = Object.freeze([
'zeroTrust',
'access',
'serviceTokens',
]);
return BaseServiceTokens;
})();
export class ServiceTokens extends BaseServiceTokens {
}
//# sourceMappingURL=service-tokens.mjs.map