cloudflare/resources/cloudforce-one/threat-signals/articles/articles.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Articles = exports.BaseArticles = void 0;
const tslib_1 = require("../../../../internal/tslib.js");
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../../core/resource.js");
const ContentAPI = tslib_1.__importStar(require("./content.js"));
const content_1 = require("./content.js");
const SkillOutputsAPI = tslib_1.__importStar(require("./skill-outputs.js"));
const skill_outputs_1 = require("./skill-outputs.js");
const TagsAPI = tslib_1.__importStar(require("./tags.js"));
const tags_1 = require("./tags.js");
const path_1 = require("../../../../internal/utils/path.js");
var BaseArticles = /* @__PURE__ */ (() => {
    class BaseArticles extends resource_1.APIResource {
        /**
         * Lists articles from the account's Threat Signals feeds.
         *
         * @example
         * ```ts
         * const articles =
         *   await client.cloudforceOne.threatSignals.articles.list({
         *     account_id: 'account_id',
         *   });
         * ```
         */
        list(params, options) {
            const { account_id, ...query } = params;
            return this._client.get((0, path_1.path) `/accounts/${account_id}/cloudforce-one/v2/threat-signals/articles`, {
                query,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Marks up to 50 Threat Signals articles as read or unread.
         *
         * @example
         * ```ts
         * const response =
         *   await client.cloudforceOne.threatSignals.articles.bulkEdit(
         *     {
         *       account_id: 'account_id',
         *       article_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
         *       read: true,
         *     },
         *   );
         * ```
         */
        bulkEdit(params, options) {
            const { account_id, ...body } = params;
            return this._client.patch((0, path_1.path) `/accounts/${account_id}/cloudforce-one/v2/threat-signals/articles`, {
                body,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Marks a Threat Signals article as read or unread.
         *
         * @example
         * ```ts
         * const response =
         *   await client.cloudforceOne.threatSignals.articles.edit(
         *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
         *     { account_id: 'account_id', read: true },
         *   );
         * ```
         */
        edit(articleID, params, options) {
            const { account_id, ...body } = params;
            return this._client.patch((0, path_1.path) `/accounts/${account_id}/cloudforce-one/v2/threat-signals/articles/${articleID}`, { body, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves a Threat Signals article with its summary, tags and indicator status.
         *
         * @example
         * ```ts
         * const article =
         *   await client.cloudforceOne.threatSignals.articles.get(
         *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
         *     { account_id: 'account_id' },
         *   );
         * ```
         */
        get(articleID, params, options) {
            const { account_id } = params;
            return this._client.get((0, path_1.path) `/accounts/${account_id}/cloudforce-one/v2/threat-signals/articles/${articleID}`, options)._thenUnwrap((obj) => obj.result);
        }
    }
    BaseArticles._key = Object.freeze([
        'cloudforceOne',
        'threatSignals',
        'articles',
    ]);
    return BaseArticles;
})();
exports.BaseArticles = BaseArticles;
var Articles = /* @__PURE__ */ (() => {
    class Articles extends BaseArticles {
        constructor() {
            super(...arguments);
            this.content = new ContentAPI.Content(this._client);
            this.tags = new TagsAPI.Tags(this._client);
            this.skillOutputs = new SkillOutputsAPI.SkillOutputs(this._client);
        }
    }
    Articles.Content = content_1.Content;
    Articles.BaseContent = content_1.BaseContent;
    Articles.Tags = tags_1.Tags;
    Articles.BaseTags = tags_1.BaseTags;
    Articles.SkillOutputs = skill_outputs_1.SkillOutputs;
    Articles.BaseSkillOutputs = skill_outputs_1.BaseSkillOutputs;
    return Articles;
})();
exports.Articles = Articles;
//# sourceMappingURL=articles.js.map