apify-client 2.24.1-beta.6 → 2.25.0

package/dist/resource_clients/task.d.ts

@@ -45,6 +45,30 @@ export declare class TaskClient extends ResourceClient {
      * @see https://docs.apify.com/api/v2/actor-task-put
      */
     update(newFields: TaskUpdateData): Promise<Task>;
+    /**
+     * Publishes the task on its public landing page, by setting `isPublic` through
+     * {@apilink TaskClient.update}.
+     *
+     * The task's Actor must be public and the task must have its public display configuration
+     * (`publicConfig`) set up first. Requires write permission to both the task and its Actor.
+     * Publishing an already published task does nothing.
+     *
+     * @returns The task object.
+     * @see https://docs.apify.com/api/v2/actor-task-put
+     */
+    publish(): Promise<Task>;
+    /**
+     * Unpublishes the task from its public landing page, by setting `isPublic` through
+     * {@apilink TaskClient.update}.
+     *
+     * The public display configuration (`publicConfig`) is preserved, so the task can be
+     * published again without re-entering it. Requires write permission to both the task and its
+     * Actor. Unpublishing a task that is not published does nothing.
+     *
+     * @returns The task object.
+     * @see https://docs.apify.com/api/v2/actor-task-put
+     */
+    unpublish(): Promise<Task>;
     /**
      * Deletes the Task.
      *
@@ -146,6 +170,28 @@ export interface Task {
     options?: TaskOptions;
     input?: Dictionary | Dictionary[];
     actorStandby?: Partial<ActorStandby>;
+    /**
+     * Whether the task is published on its public landing page. Derived from
+     * `publicConfig.publishedAt` — set it on update to publish or unpublish the task.
+     */
+    isPublic?: boolean;
+    publicConfig?: TaskPublicConfig | null;
+}
+/**
+ * Public-facing display configuration of a task's public landing page.
+ *
+ * The task is published when `publishedAt` is set and unpublished when it is `null`. The
+ * `publishedAt` field is read-only - use {@apilink TaskClient.publish} and
+ * {@apilink TaskClient.unpublish} to change the publication state.
+ */
+export interface TaskPublicConfig {
+    publishedAt: Date | null;
+    seoTitle?: string | null;
+    seoDescription?: string | null;
+    categorization?: string | null;
+    inputSchemaFields?: string[] | null;
+    datasetName?: string | null;
+    datasetView?: string | null;
 }
 /**
  * Statistics about Actor task usage.
@@ -165,7 +211,9 @@ export interface TaskOptions {
 /**
  * Fields that can be updated when modifying a Task.
  */
-export type TaskUpdateData = Partial<Pick<Task, 'name' | 'title' | 'description' | 'options' | 'input' | 'actorStandby'>>;
+export type TaskUpdateData = Partial<Pick<Task, 'name' | 'title' | 'description' | 'options' | 'input' | 'actorStandby' | 'isPublic'>> & {
+    publicConfig?: Omit<TaskPublicConfig, 'publishedAt'>;
+};
 /**
  * Options for filtering the last run of a Task.
  */

package/dist/resource_clients/task.js

@@ -59,6 +59,34 @@ class TaskClient extends resource_client_1.ResourceClient {
         (0, ow_1.default)(newFields, ow_1.default.object);
         return this._update(newFields);
     }
+    /**
+     * Publishes the task on its public landing page, by setting `isPublic` through
+     * {@apilink TaskClient.update}.
+     *
+     * The task's Actor must be public and the task must have its public display configuration
+     * (`publicConfig`) set up first. Requires write permission to both the task and its Actor.
+     * Publishing an already published task does nothing.
+     *
+     * @returns The task object.
+     * @see https://docs.apify.com/api/v2/actor-task-put
+     */
+    async publish() {
+        return this.update({ isPublic: true });
+    }
+    /**
+     * Unpublishes the task from its public landing page, by setting `isPublic` through
+     * {@apilink TaskClient.update}.
+     *
+     * The public display configuration (`publicConfig`) is preserved, so the task can be
+     * published again without re-entering it. Requires write permission to both the task and its
+     * Actor. Unpublishing a task that is not published does nothing.
+     *
+     * @returns The task object.
+     * @see https://docs.apify.com/api/v2/actor-task-put
+     */
+    async unpublish() {
+        return this.update({ isPublic: false });
+    }
     /**
      * Deletes the Task.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "2.24.1-beta.6",
+  "version": "2.25.0",
   "description": "Apify API client for JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",