From 5d0f92a095f72d0e71aa3dfcf0753485037d6bf1 Mon Sep 17 00:00:00 2001 From: Mihails Date: Mon, 9 Dec 2024 11:41:23 +0100 Subject: [PATCH 01/24] Add JS samples for Actor object --- apify-api/openapi/code_samples/javascript/act_delete.js | 5 +++++ apify-api/openapi/code_samples/javascript/act_get.js | 7 +++++++ apify-api/openapi/code_samples/javascript/act_put.js | 9 +++++++++ apify-api/openapi/code_samples/javascript/acts_post.js | 2 +- 4 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 apify-api/openapi/code_samples/javascript/act_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/act_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_put.js diff --git a/apify-api/openapi/code_samples/javascript/act_delete.js b/apify-api/openapi/code_samples/javascript/act_delete.js new file mode 100644 index 0000000000..c11bfa9216 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_delete.js @@ -0,0 +1,5 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify/my-sample-actor').delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_get.js b/apify-api/openapi/code_samples/javascript/act_get.js new file mode 100644 index 0000000000..78e59a2475 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_get.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const actor = await apifyClient.actor('apify/my-sample-actor').get(); + +console.log(actor); diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/act_put.js new file mode 100644 index 0000000000..c2e202cf4e --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_put.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const actor = await apifyClient.actor('apify/my-sample-actor').update({ + title: 'New title', +}); + +console.log(actor); diff --git a/apify-api/openapi/code_samples/javascript/acts_post.js b/apify-api/openapi/code_samples/javascript/acts_post.js index a2fd96905d..bfc5c08d8b 100644 --- a/apify-api/openapi/code_samples/javascript/acts_post.js +++ b/apify-api/openapi/code_samples/javascript/acts_post.js @@ -1,6 +1,6 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -const myActor = await apifyClient.actors().create({ name: 'my-actor' }); +const myActor = await apifyClient.actors().create({ name: 'my-sample-actor' }); console.log(myActor); From 03117304a2c678d97b9741e359b82d6cffc56307 Mon Sep 17 00:00:00 2001 From: Mihails Date: Mon, 9 Dec 2024 13:15:17 +0100 Subject: [PATCH 02/24] feat: update var name --- apify-api/openapi/code_samples/javascript/act_put.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/act_put.js index c2e202cf4e..c3622e20e9 100644 --- a/apify-api/openapi/code_samples/javascript/act_put.js +++ b/apify-api/openapi/code_samples/javascript/act_put.js @@ -2,8 +2,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); // Replace apify/my-sample-actor with your Actor's ID or technical name -const actor = await apifyClient.actor('apify/my-sample-actor').update({ +const updatedActor = await apifyClient.actor('apify/my-sample-actor').update({ title: 'New title', }); -console.log(actor); +console.log(updatedActor); From b71a5623d6c7c6ef2fb27242f3b3587642f100b6 Mon Sep 17 00:00:00 2001 From: Mihails Date: Mon, 9 Dec 2024 13:17:38 +0100 Subject: [PATCH 03/24] feat: add code samples for the Actor versions --- .../code_samples/javascript/act_version_delete.js | 7 +++++++ .../code_samples/javascript/act_version_get.js | 9 +++++++++ .../code_samples/javascript/act_version_put.js | 11 +++++++++++ .../code_samples/javascript/act_versions_get.js | 9 +++++++++ .../code_samples/javascript/act_versions_post.js | 13 +++++++++++++ 5 files changed, 49 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/act_version_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_put.js create mode 100644 apify-api/openapi/code_samples/javascript/act_versions_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_versions_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_delete.js b/apify-api/openapi/code_samples/javascript/act_version_delete.js new file mode 100644 index 0000000000..af804295a6 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_delete.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_get.js b/apify-api/openapi/code_samples/javascript/act_version_get.js new file mode 100644 index 0000000000..2ec4faf5d8 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const version = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .get(); + +console.log(version); diff --git a/apify-api/openapi/code_samples/javascript/act_version_put.js b/apify-api/openapi/code_samples/javascript/act_version_put.js new file mode 100644 index 0000000000..dc6288d8ef --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_put.js @@ -0,0 +1,11 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const updatedVersion = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .update({ + gitRepoUrl: 'https://github.com/my-github-account/new-actor-repo', + }); + +console.log(updatedVersion); diff --git a/apify-api/openapi/code_samples/javascript/act_versions_get.js b/apify-api/openapi/code_samples/javascript/act_versions_get.js new file mode 100644 index 0000000000..93a59c90f1 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_versions_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify/my-sample-actor') + .versions() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/act_versions_post.js b/apify-api/openapi/code_samples/javascript/act_versions_post.js new file mode 100644 index 0000000000..3c1dd17a39 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_versions_post.js @@ -0,0 +1,13 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const version = await apifyClient.actor('apify/my-sample-actor') + .versions() + .create({ + versionNumber: '0.1', + sourceType: 'GIT_REPO', + gitRepoUrl: 'https://github.com/my-github-account/actor-repo', + }); + +console.log(version); From 8caa325744c24fa9b7766ad9fea8ccd2c83d6738 Mon Sep 17 00:00:00 2001 From: Mihails Date: Mon, 9 Dec 2024 17:45:44 +0100 Subject: [PATCH 04/24] feat: add env vars code samples --- .../javascript/act_version_envVar_delete.js | 8 ++++++++ .../javascript/act_version_envVar_get.js | 10 ++++++++++ .../javascript/act_version_envVar_put.js | 13 +++++++++++++ .../javascript/act_version_envVars_get.js | 10 ++++++++++ .../javascript/act_version_envVars_post.js | 14 ++++++++++++++ 5 files changed, 55 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_envVar_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_envVar_put.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_envVars_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_version_envVars_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js new file mode 100644 index 0000000000..f41697b5d4 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .envVar('MY_SAMPLE_ENV_VAR') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js new file mode 100644 index 0000000000..39a764c086 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const envVar = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .envVar('MY_SAMPLE_ENV_VAR') + .get(); + +console.log(envVar); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js new file mode 100644 index 0000000000..f8b5935756 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js @@ -0,0 +1,13 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const updatedEnvVar = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .envVar('MY_SAMPLE_ENV_VAR') + .update({ + name: 'MY_SAMPLE_ENV_VAR', + value: '54321', + }); + +console.log(updatedEnvVar); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js new file mode 100644 index 0000000000..4607809607 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .envVars() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js new file mode 100644 index 0000000000..49ae022cea --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js @@ -0,0 +1,14 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify/my-sample-actor with your Actor's ID or technical name +const envVar = await apifyClient.actor('apify/my-sample-actor') + .version('0.1') + .envVars() + .create({ + name: 'MY_SAMPLE_ENV_VAR', + value: '12345', + isSecret: true, + }); + +console.log(envVar); From a7a97acc6b79ec6051137641057f71d6b6a920cb Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 09:51:41 +0100 Subject: [PATCH 05/24] rename env var --- .../code_samples/javascript/act_version_envVar_delete.js | 2 +- .../openapi/code_samples/javascript/act_version_envVar_get.js | 2 +- .../openapi/code_samples/javascript/act_version_envVar_put.js | 4 ++-- .../code_samples/javascript/act_version_envVars_post.js | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js index f41697b5d4..9a09f53a26 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js @@ -4,5 +4,5 @@ const apifyClient = new ApifyClient({ token: 'my-token' }); // Replace apify/my-sample-actor with your Actor's ID or technical name await apifyClient.actor('apify/my-sample-actor') .version('0.1') - .envVar('MY_SAMPLE_ENV_VAR') + .envVar('MY_ENV_VAR') .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js index 39a764c086..0bcf2b6d45 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js @@ -4,7 +4,7 @@ const apifyClient = new ApifyClient({ token: 'my-token' }); // Replace apify/my-sample-actor with your Actor's ID or technical name const envVar = await apifyClient.actor('apify/my-sample-actor') .version('0.1') - .envVar('MY_SAMPLE_ENV_VAR') + .envVar('MY_ENV_VAR') .get(); console.log(envVar); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js index f8b5935756..e4af83f1b0 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js @@ -4,9 +4,9 @@ const apifyClient = new ApifyClient({ token: 'my-token' }); // Replace apify/my-sample-actor with your Actor's ID or technical name const updatedEnvVar = await apifyClient.actor('apify/my-sample-actor') .version('0.1') - .envVar('MY_SAMPLE_ENV_VAR') + .envVar('MY_ENV_VAR') .update({ - name: 'MY_SAMPLE_ENV_VAR', + name: 'MY_ENV_VAR', value: '54321', }); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js index 49ae022cea..53618e9ba3 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js @@ -6,7 +6,7 @@ const envVar = await apifyClient.actor('apify/my-sample-actor') .version('0.1') .envVars() .create({ - name: 'MY_SAMPLE_ENV_VAR', + name: 'MY_ENV_VAR', value: '12345', isSecret: true, }); From 2c3a6542cf7bb2fc58e0b1209eb3eb40890a146c Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 10:03:23 +0100 Subject: [PATCH 06/24] feat: add webhooks code samples --- .../openapi/code_samples/javascript/act_webhooks_get.js | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/act_webhooks_get.js diff --git a/apify-api/openapi/code_samples/javascript/act_webhooks_get.js b/apify-api/openapi/code_samples/javascript/act_webhooks_get.js new file mode 100644 index 0000000000..eff2629320 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_webhooks_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify~my-sample-actor') + .webhooks() + .list(); + +console.log(items); From 02320655c792bee08b49a363fd75aba62ab323c0 Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 10:03:47 +0100 Subject: [PATCH 07/24] fix: change / to ~ in actor tech name in samples --- apify-api/openapi/code_samples/javascript/act_delete.js | 4 ++-- apify-api/openapi/code_samples/javascript/act_get.js | 4 ++-- apify-api/openapi/code_samples/javascript/act_put.js | 4 ++-- .../openapi/code_samples/javascript/act_version_delete.js | 4 ++-- .../code_samples/javascript/act_version_envVar_delete.js | 4 ++-- .../openapi/code_samples/javascript/act_version_envVar_get.js | 4 ++-- .../openapi/code_samples/javascript/act_version_envVar_put.js | 4 ++-- .../code_samples/javascript/act_version_envVars_get.js | 4 ++-- .../code_samples/javascript/act_version_envVars_post.js | 4 ++-- apify-api/openapi/code_samples/javascript/act_version_get.js | 4 ++-- apify-api/openapi/code_samples/javascript/act_version_put.js | 4 ++-- apify-api/openapi/code_samples/javascript/act_versions_get.js | 4 ++-- .../openapi/code_samples/javascript/act_versions_post.js | 4 ++-- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_delete.js b/apify-api/openapi/code_samples/javascript/act_delete.js index c11bfa9216..6f408d216b 100644 --- a/apify-api/openapi/code_samples/javascript/act_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_delete.js @@ -1,5 +1,5 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor').delete(); +// Replace apify~my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify~my-sample-actor').delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_get.js b/apify-api/openapi/code_samples/javascript/act_get.js index 78e59a2475..8f5b49168d 100644 --- a/apify-api/openapi/code_samples/javascript/act_get.js +++ b/apify-api/openapi/code_samples/javascript/act_get.js @@ -1,7 +1,7 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const actor = await apifyClient.actor('apify/my-sample-actor').get(); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const actor = await apifyClient.actor('apify~my-sample-actor').get(); console.log(actor); diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/act_put.js index c3622e20e9..043f1ea498 100644 --- a/apify-api/openapi/code_samples/javascript/act_put.js +++ b/apify-api/openapi/code_samples/javascript/act_put.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedActor = await apifyClient.actor('apify/my-sample-actor').update({ +// Replace apify~my-sample-actor with your Actor's ID or technical name +const updatedActor = await apifyClient.actor('apify~my-sample-actor').update({ title: 'New title', }); diff --git a/apify-api/openapi/code_samples/javascript/act_version_delete.js b/apify-api/openapi/code_samples/javascript/act_version_delete.js index af804295a6..b0e27a22ff 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_version_delete.js @@ -1,7 +1,7 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify~my-sample-actor') .version('0.1') .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js index 9a09f53a26..b07ce3f127 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +await apifyClient.actor('apify~my-sample-actor') .version('0.1') .envVar('MY_ENV_VAR') .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js index 0bcf2b6d45..d6e36c0cc0 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const envVar = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const envVar = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .envVar('MY_ENV_VAR') .get(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js index e4af83f1b0..a13c73f408 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedEnvVar = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const updatedEnvVar = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .envVar('MY_ENV_VAR') .update({ diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js index 4607809607..72ce9d676a 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .envVars() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js index 53618e9ba3..ecd5a8ffe1 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const envVar = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const envVar = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .envVars() .create({ diff --git a/apify-api/openapi/code_samples/javascript/act_version_get.js b/apify-api/openapi/code_samples/javascript/act_version_get.js index 2ec4faf5d8..b96a647ecc 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_get.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const version = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const version = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .get(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_put.js b/apify-api/openapi/code_samples/javascript/act_version_put.js index dc6288d8ef..55ef33ee4d 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_put.js +++ b/apify-api/openapi/code_samples/javascript/act_version_put.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedVersion = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const updatedVersion = await apifyClient.actor('apify~my-sample-actor') .version('0.1') .update({ gitRepoUrl: 'https://github.com/my-github-account/new-actor-repo', diff --git a/apify-api/openapi/code_samples/javascript/act_versions_get.js b/apify-api/openapi/code_samples/javascript/act_versions_get.js index 93a59c90f1..673e512a87 100644 --- a/apify-api/openapi/code_samples/javascript/act_versions_get.js +++ b/apify-api/openapi/code_samples/javascript/act_versions_get.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify~my-sample-actor') .versions() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_versions_post.js b/apify-api/openapi/code_samples/javascript/act_versions_post.js index 3c1dd17a39..65fa457290 100644 --- a/apify-api/openapi/code_samples/javascript/act_versions_post.js +++ b/apify-api/openapi/code_samples/javascript/act_versions_post.js @@ -1,8 +1,8 @@ import { ApifyClient } from 'apify-client'; const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const version = await apifyClient.actor('apify/my-sample-actor') +// Replace apify~my-sample-actor with your Actor's ID or technical name +const version = await apifyClient.actor('apify~my-sample-actor') .versions() .create({ versionNumber: '0.1', From 88f6c7c3895453cf1108f85721b30a2bcb8ded5d Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 11:36:17 +0100 Subject: [PATCH 08/24] feat: add the builds and runs samples --- .../openapi/code_samples/javascript/act_builds_get.js | 9 +++++++++ .../openapi/code_samples/javascript/act_builds_post.js | 7 +++++++ .../openapi/code_samples/javascript/act_runs_get.js | 9 +++++++++ .../openapi/code_samples/javascript/act_runs_last_get.js | 7 +++++++ .../openapi/code_samples/javascript/act_runs_post.js | 8 ++++++++ 5 files changed, 40 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/act_builds_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_builds_post.js create mode 100644 apify-api/openapi/code_samples/javascript/act_runs_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_runs_last_get.js create mode 100644 apify-api/openapi/code_samples/javascript/act_runs_post.js diff --git a/apify-api/openapi/code_samples/javascript/act_builds_get.js b/apify-api/openapi/code_samples/javascript/act_builds_get.js new file mode 100644 index 0000000000..b7162c4ed2 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_builds_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify~my-sample-actor') + .builds() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/act_builds_post.js b/apify-api/openapi/code_samples/javascript/act_builds_post.js new file mode 100644 index 0000000000..dd495653af --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_builds_post.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const build = await apifyClient.actor('apify~my-sample-actor').build('0.0'); + +console.log(build); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_get.js b/apify-api/openapi/code_samples/javascript/act_runs_get.js new file mode 100644 index 0000000000..677faf3737 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_runs_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const { items } = await apifyClient.actor('apify~my-sample-actor') + .runs() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_last_get.js b/apify-api/openapi/code_samples/javascript/act_runs_last_get.js new file mode 100644 index 0000000000..723b91caf9 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_runs_last_get.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const lastRun = await apifyClient.actor('apify~my-sample-actor').lastRun(); + +console.log(lastRun); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js new file mode 100644 index 0000000000..e94d5f8f97 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/act_runs_post.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-actor with your Actor's ID or technical name +const run = await apifyClient.actor('apify~my-sample-actor') + .start(/** Your Actor's input */); + +console.log(run); From 1c68faa9ac2cfc26f033b1cf5b993d013e33ff76 Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 14:16:56 +0100 Subject: [PATCH 09/24] feat: add code samples for tasks --- .../code_samples/javascript/actorTask_delete.js | 5 +++++ .../code_samples/javascript/actorTask_get.js | 7 +++++++ .../code_samples/javascript/actorTask_put.js | 9 +++++++++ .../code_samples/javascript/actorTasks_get.js | 6 ++++++ .../code_samples/javascript/actorTasks_post.js | 13 +++++++++++++ 5 files changed, 40 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_put.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTasks_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTasks_post.js diff --git a/apify-api/openapi/code_samples/javascript/actorTask_delete.js b/apify-api/openapi/code_samples/javascript/actorTask_delete.js new file mode 100644 index 0000000000..5e3d4c753f --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_delete.js @@ -0,0 +1,5 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +await apifyClient.task('apify~my-sample-task').delete(); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_get.js b/apify-api/openapi/code_samples/javascript/actorTask_get.js new file mode 100644 index 0000000000..cec1b3b8d5 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_get.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const task = await apifyClient.task('apify~my-sample-task').get(); + +console.log(task); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_put.js b/apify-api/openapi/code_samples/javascript/actorTask_put.js new file mode 100644 index 0000000000..1c598046d0 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_put.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const task = await apifyClient.task('apify~my-sample-task').update({ + title: 'New title', +}); + +console.log(task); diff --git a/apify-api/openapi/code_samples/javascript/actorTasks_get.js b/apify-api/openapi/code_samples/javascript/actorTasks_get.js new file mode 100644 index 0000000000..2d4638f8d1 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTasks_get.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const { items } = await apifyClient.tasks().list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/actorTasks_post.js b/apify-api/openapi/code_samples/javascript/actorTasks_post.js new file mode 100644 index 0000000000..8a76915dfd --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTasks_post.js @@ -0,0 +1,13 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const { items } = await apifyClient.tasks().create({ + /** + * Replace apify~my-sample-actor with the ID or technical name + * of the Actor this task will be based on + */ + actId: 'apify~my-sample-actor', + name: 'my-sample-task', +}); + +console.log(items); From d78401d4838a909925f53dc8bb6b84d2eb1eba0a Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 14:53:40 +0100 Subject: [PATCH 10/24] feat: add more tasks samples --- .../code_samples/javascript/actorTask_input_get.js | 7 +++++++ .../code_samples/javascript/actorTask_input_put.js | 10 ++++++++++ .../code_samples/javascript/actorTask_runs_get.js | 9 +++++++++ .../code_samples/javascript/actorTask_runs_post.js | 7 +++++++ .../code_samples/javascript/actorTask_webhooks_get.js | 9 +++++++++ 5 files changed, 42 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_input_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_input_put.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_runs_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_runs_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_get.js b/apify-api/openapi/code_samples/javascript/actorTask_input_get.js new file mode 100644 index 0000000000..416d8bf378 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_get.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const input = await apifyClient.task('apify~my-sample-task').getInput(); + +console.log(input); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js new file mode 100644 index 0000000000..549e68ff2c --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const updatedInput = await apifyClient.task('apify~my-sample-task') + .updateInput({ + // Your input here + }); + +console.log(updatedInput); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js b/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js new file mode 100644 index 0000000000..bb932e8317 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const { items } = await apifyClient.task('apify~my-sample-task') + .runs() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js b/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js new file mode 100644 index 0000000000..eacb9c0c85 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const run = await apifyClient.task('apify~my-sample-task').start(); + +console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js b/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js new file mode 100644 index 0000000000..73e4546df9 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +// Replace apify~my-sample-task with your task's ID or technical name +const { items } = await apifyClient.task('apify~my-sample-task') + .webhooks() + .list(); + +console.log(items); From a4d07789e63a895d290526a6150179fb4ebfcb38 Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 16:02:33 +0100 Subject: [PATCH 11/24] feat: add code samples for Actor runs --- .../openapi/code_samples/javascript/actorRun_abort_post.js | 6 ++++++ .../openapi/code_samples/javascript/actorRun_delete.js | 6 ++++++ apify-api/openapi/code_samples/javascript/actorRun_get.js | 6 ++++++ .../code_samples/javascript/actorRun_metamorph_post.js | 7 +++++++ .../code_samples/javascript/actorRun_reboot_post.js | 6 ++++++ .../code_samples/javascript/actorRun_resurrect_post.js | 6 ++++++ apify-api/openapi/code_samples/javascript/actorRuns_get.js | 6 ++++++ apify-api/plugins/decorators/code-samples-decorator.js | 6 +++++- 8 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_abort_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorRuns_get.js diff --git a/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js b/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js new file mode 100644 index 0000000000..3f193a9422 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const run = await apifyClient.run('my-run-ID').abort(); + +console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_delete.js b/apify-api/openapi/code_samples/javascript/actorRun_delete.js new file mode 100644 index 0000000000..457402bf70 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_delete.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const run = await apifyClient.run('my-run-ID').delete(); + +console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_get.js b/apify-api/openapi/code_samples/javascript/actorRun_get.js new file mode 100644 index 0000000000..13b482aa78 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_get.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const run = await apifyClient.run('my-run-ID').get(); + +console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js b/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js new file mode 100644 index 0000000000..d28926e93e --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js @@ -0,0 +1,7 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const metamorphedRun = await apifyClient.run('my-run-ID') + .metamorph('target-actor-ID'); + +console.log(metamorphedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js b/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js new file mode 100644 index 0000000000..4b20ceea33 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const rebootedRun = await apifyClient.run('my-run-ID').reboot(); + +console.log(rebootedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js b/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js new file mode 100644 index 0000000000..a7957be446 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const run = await apifyClient.run('my-run-ID').resurrect(); + +console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorRuns_get.js b/apify-api/openapi/code_samples/javascript/actorRuns_get.js new file mode 100644 index 0000000000..9f61c2067b --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRuns_get.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const { items } = await apifyClient.runs().list(); + +console.log(items); diff --git a/apify-api/plugins/decorators/code-samples-decorator.js b/apify-api/plugins/decorators/code-samples-decorator.js index a951460980..6b839d0785 100644 --- a/apify-api/plugins/decorators/code-samples-decorator.js +++ b/apify-api/plugins/decorators/code-samples-decorator.js @@ -24,8 +24,12 @@ function CodeSamplesDecorator(target) { const codeSamples = []; + // For some reason, the operationId for resurrect run is PostResurrectRun, + // so we change it here to keep the file names consistent + const operationId = target.operationId === 'PostResurrectRun' ? 'actorRun_resurrect_post' : target.operationId; + for (const { lang, label } of LANGUAGES) { - const codeSamplePath = path.join(__dirname, `../../openapi/code_samples/${lang.toLowerCase()}/${target.operationId}.js`); + const codeSamplePath = path.join(__dirname, `../../openapi/code_samples/${lang.toLowerCase()}/${operationId}.js`); if (!existsSync(codeSamplePath)) { // Just use this console log in development to see which operations are missing a code sample. From cc563ffae605c396a7c615335644470547da6538 Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 16:09:19 +0100 Subject: [PATCH 12/24] add update run sample --- .../openapi/code_samples/javascript/actorRun_put.js | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/actorRun_put.js diff --git a/apify-api/openapi/code_samples/javascript/actorRun_put.js b/apify-api/openapi/code_samples/javascript/actorRun_put.js new file mode 100644 index 0000000000..e879cb8ad9 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorRun_put.js @@ -0,0 +1,9 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const updatedRun = await apifyClient.run('my-run-ID') + .update({ + statusMessage: 'My status message', + }); + +console.log(updatedRun); From 00fb2baa18dc4525328413f5781cc838ba5bc2aa Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 10 Dec 2024 16:31:18 +0100 Subject: [PATCH 13/24] feat: add code samples for builds --- .../code_samples/javascript/actorBuild_abort_post.js | 6 ++++++ .../openapi/code_samples/javascript/actorBuild_delete.js | 4 ++++ .../openapi/code_samples/javascript/actorBuild_get.js | 6 ++++++ .../openapi/code_samples/javascript/actorBuild_log_get.js | 8 ++++++++ .../openapi/code_samples/javascript/actorBuilds_get.js | 6 ++++++ 5 files changed, 30 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js create mode 100644 apify-api/openapi/code_samples/javascript/actorBuild_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/actorBuild_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorBuild_log_get.js create mode 100644 apify-api/openapi/code_samples/javascript/actorBuilds_get.js diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js b/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js new file mode 100644 index 0000000000..ea5a34b6ce --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const abortedBuild = await apifyClient.build('my-build-ID').abort(); + +console.log(abortedBuild); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_delete.js b/apify-api/openapi/code_samples/javascript/actorBuild_delete.js new file mode 100644 index 0000000000..918b5e3442 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorBuild_delete.js @@ -0,0 +1,4 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +await apifyClient.build('my-build-ID').delete(); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_get.js b/apify-api/openapi/code_samples/javascript/actorBuild_get.js new file mode 100644 index 0000000000..b01c677751 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorBuild_get.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const build = await apifyClient.build('my-build-ID').get(); + +console.log(build); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js b/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js new file mode 100644 index 0000000000..4ac2ec1cf7 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const buildLog = await apifyClient.build('my-build-ID') + .log() + .get(); + +console.log(buildLog); diff --git a/apify-api/openapi/code_samples/javascript/actorBuilds_get.js b/apify-api/openapi/code_samples/javascript/actorBuilds_get.js new file mode 100644 index 0000000000..43ed251b38 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/actorBuilds_get.js @@ -0,0 +1,6 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ token: 'my-token' }); +const { items } = await apifyClient.builds().list(); + +console.log(items); From 0e803adbffb2530ea64ff1929a40662657269b4f Mon Sep 17 00:00:00 2001 From: Mihails Date: Wed, 11 Dec 2024 16:11:53 +0100 Subject: [PATCH 14/24] fix: better IDs and minimize side scroll --- .../openapi/code_samples/javascript/act_delete.js | 7 ++++--- apify-api/openapi/code_samples/javascript/act_get.js | 9 ++++++--- apify-api/openapi/code_samples/javascript/act_put.js | 11 +++++++---- apify-api/openapi/code_samples/javascript/acts_get.js | 8 ++++++-- .../openapi/code_samples/javascript/acts_post.js | 10 ++++++++-- 5 files changed, 31 insertions(+), 14 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_delete.js b/apify-api/openapi/code_samples/javascript/act_delete.js index c11bfa9216..67d1628182 100644 --- a/apify-api/openapi/code_samples/javascript/act_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_delete.js @@ -1,5 +1,6 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor').delete(); +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient.actor('').delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_get.js b/apify-api/openapi/code_samples/javascript/act_get.js index 78e59a2475..c2fa2db3c8 100644 --- a/apify-api/openapi/code_samples/javascript/act_get.js +++ b/apify-api/openapi/code_samples/javascript/act_get.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const actor = await apifyClient.actor('apify/my-sample-actor').get(); +const apifyClient = new ApifyClient({ + token: '', +}); +const actor = await apifyClient + .actor('') + .get(); console.log(actor); diff --git a/apify-api/openapi/code_samples/javascript/act_put.js b/apify-api/openapi/code_samples/javascript/act_put.js index c3622e20e9..e5f45bba5d 100644 --- a/apify-api/openapi/code_samples/javascript/act_put.js +++ b/apify-api/openapi/code_samples/javascript/act_put.js @@ -1,9 +1,12 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedActor = await apifyClient.actor('apify/my-sample-actor').update({ - title: 'New title', +const apifyClient = new ApifyClient({ + token: '', }); +const updatedActor = await apifyClient + .actor('') + .update({ + title: 'New title', + }); console.log(updatedActor); diff --git a/apify-api/openapi/code_samples/javascript/acts_get.js b/apify-api/openapi/code_samples/javascript/acts_get.js index ef13872c19..a8616422b8 100644 --- a/apify-api/openapi/code_samples/javascript/acts_get.js +++ b/apify-api/openapi/code_samples/javascript/acts_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const { items } = await apifyClient.actors().list(); +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actors() + .list(); console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/acts_post.js b/apify-api/openapi/code_samples/javascript/acts_post.js index bfc5c08d8b..878650fc5f 100644 --- a/apify-api/openapi/code_samples/javascript/acts_post.js +++ b/apify-api/openapi/code_samples/javascript/acts_post.js @@ -1,6 +1,12 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const myActor = await apifyClient.actors().create({ name: 'my-sample-actor' }); +const apifyClient = new ApifyClient({ + token: '', +}); +const myActor = await apifyClient + .actors() + .create({ + name: '', + }); console.log(myActor); From 766838e89a14f80b351d357d90847b00df0c86eb Mon Sep 17 00:00:00 2001 From: Mihails Date: Wed, 11 Dec 2024 16:49:09 +0100 Subject: [PATCH 15/24] fix: better IDs and make code narrower --- .../code_samples/javascript/act_version_delete.js | 8 +++++--- .../javascript/act_version_envVar_delete.js | 8 +++++--- .../code_samples/javascript/act_version_envVar_get.js | 8 +++++--- .../code_samples/javascript/act_version_envVar_put.js | 10 ++++++---- .../code_samples/javascript/act_version_envVars_get.js | 8 +++++--- .../javascript/act_version_envVars_post.js | 10 ++++++---- .../openapi/code_samples/javascript/act_version_get.js | 8 +++++--- .../openapi/code_samples/javascript/act_version_put.js | 10 ++++++---- .../code_samples/javascript/act_versions_get.js | 8 +++++--- .../code_samples/javascript/act_versions_post.js | 10 ++++++---- 10 files changed, 54 insertions(+), 34 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_version_delete.js b/apify-api/openapi/code_samples/javascript/act_version_delete.js index af804295a6..576d6daeab 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_version_delete.js @@ -1,7 +1,9 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .actor('') .version('0.1') .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js index 9a09f53a26..92d57d9e4e 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_delete.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .actor('') .version('0.1') .envVar('MY_ENV_VAR') .delete(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js index 0bcf2b6d45..7a200fb7ea 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const envVar = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const envVar = await apifyClient + .actor('') .version('0.1') .envVar('MY_ENV_VAR') .get(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js index e4af83f1b0..18318129ec 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVar_put.js @@ -1,13 +1,15 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedEnvVar = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedEnvVar = await apifyClient + .actor('') .version('0.1') .envVar('MY_ENV_VAR') .update({ name: 'MY_ENV_VAR', - value: '54321', + value: 'my-new-value', }); console.log(updatedEnvVar); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js index 4607809607..896c14b054 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actor('') .version('0.1') .envVars() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js index 53618e9ba3..6eace8ced7 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js +++ b/apify-api/openapi/code_samples/javascript/act_version_envVars_post.js @@ -1,13 +1,15 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const envVar = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const envVar = await apifyClient + .actor('') .version('0.1') .envVars() .create({ name: 'MY_ENV_VAR', - value: '12345', + value: 'my-new-value', isSecret: true, }); diff --git a/apify-api/openapi/code_samples/javascript/act_version_get.js b/apify-api/openapi/code_samples/javascript/act_version_get.js index 2ec4faf5d8..d3dc8770b0 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_get.js +++ b/apify-api/openapi/code_samples/javascript/act_version_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const version = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const version = await apifyClient + .actor('') .version('0.1') .get(); diff --git a/apify-api/openapi/code_samples/javascript/act_version_put.js b/apify-api/openapi/code_samples/javascript/act_version_put.js index dc6288d8ef..51c213aad8 100644 --- a/apify-api/openapi/code_samples/javascript/act_version_put.js +++ b/apify-api/openapi/code_samples/javascript/act_version_put.js @@ -1,11 +1,13 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const updatedVersion = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedVersion = await apifyClient + .actor('') .version('0.1') .update({ - gitRepoUrl: 'https://github.com/my-github-account/new-actor-repo', + buildTag: 'latest', }); console.log(updatedVersion); diff --git a/apify-api/openapi/code_samples/javascript/act_versions_get.js b/apify-api/openapi/code_samples/javascript/act_versions_get.js index 93a59c90f1..d2399a533a 100644 --- a/apify-api/openapi/code_samples/javascript/act_versions_get.js +++ b/apify-api/openapi/code_samples/javascript/act_versions_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actor('') .versions() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_versions_post.js b/apify-api/openapi/code_samples/javascript/act_versions_post.js index 3c1dd17a39..e525a391b9 100644 --- a/apify-api/openapi/code_samples/javascript/act_versions_post.js +++ b/apify-api/openapi/code_samples/javascript/act_versions_post.js @@ -1,13 +1,15 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify/my-sample-actor with your Actor's ID or technical name -const version = await apifyClient.actor('apify/my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const version = await apifyClient + .actor('') .versions() .create({ versionNumber: '0.1', sourceType: 'GIT_REPO', - gitRepoUrl: 'https://github.com/my-github-account/actor-repo', + gitRepoUrl: 'https://github.com/my/repo', }); console.log(version); From e441c41e9cabf267bb8a4e50e79065924d5c246f Mon Sep 17 00:00:00 2001 From: Mihails Date: Wed, 11 Dec 2024 18:00:47 +0100 Subject: [PATCH 16/24] fix: better IDs and avoid side scroll --- .../openapi/code_samples/javascript/act_builds_get.js | 8 +++++--- .../openapi/code_samples/javascript/act_builds_post.js | 9 ++++++--- .../openapi/code_samples/javascript/act_runs_get.js | 8 +++++--- .../code_samples/javascript/act_runs_last_get.js | 9 ++++++--- .../openapi/code_samples/javascript/act_runs_post.js | 10 ++++++---- .../code_samples/javascript/act_webhooks_get.js | 8 +++++--- 6 files changed, 33 insertions(+), 19 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_builds_get.js b/apify-api/openapi/code_samples/javascript/act_builds_get.js index b7162c4ed2..e70e1bf294 100644 --- a/apify-api/openapi/code_samples/javascript/act_builds_get.js +++ b/apify-api/openapi/code_samples/javascript/act_builds_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify~my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actor('') .builds() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_builds_post.js b/apify-api/openapi/code_samples/javascript/act_builds_post.js index dd495653af..d57d8f6cb6 100644 --- a/apify-api/openapi/code_samples/javascript/act_builds_post.js +++ b/apify-api/openapi/code_samples/javascript/act_builds_post.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const build = await apifyClient.actor('apify~my-sample-actor').build('0.0'); +const apifyClient = new ApifyClient({ + token: '', +}); +const build = await apifyClient + .actor('') + .build('0.0'); console.log(build); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_get.js b/apify-api/openapi/code_samples/javascript/act_runs_get.js index 677faf3737..62303fe5d2 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_get.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify~my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actor('') .runs() .list(); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_last_get.js b/apify-api/openapi/code_samples/javascript/act_runs_last_get.js index 723b91caf9..3963ab2896 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_last_get.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_last_get.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const lastRun = await apifyClient.actor('apify~my-sample-actor').lastRun(); +const apifyClient = new ApifyClient({ + token: '', +}); +const lastRun = await apifyClient + .actor('') + .lastRun(); console.log(lastRun); diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js index e94d5f8f97..c8f706eac2 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_post.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_post.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const run = await apifyClient.actor('apify~my-sample-actor') - .start(/** Your Actor's input */); +const apifyClient = new ApifyClient({ + token: '', +}); +const run = await apifyClient + .actor('') + .start({ /** */ }); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/act_webhooks_get.js b/apify-api/openapi/code_samples/javascript/act_webhooks_get.js index eff2629320..c78d5f63fe 100644 --- a/apify-api/openapi/code_samples/javascript/act_webhooks_get.js +++ b/apify-api/openapi/code_samples/javascript/act_webhooks_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-actor with your Actor's ID or technical name -const { items } = await apifyClient.actor('apify~my-sample-actor') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .actor('') .webhooks() .list(); From d57d035b485f6c21eb0469f691d1f9356e89676d Mon Sep 17 00:00:00 2001 From: Mihails Date: Wed, 11 Dec 2024 18:47:59 +0100 Subject: [PATCH 17/24] fix: better IDs and narrower examples --- .../code_samples/javascript/actorTask_delete.js | 7 ++++--- .../code_samples/javascript/actorTask_get.js | 9 ++++++--- .../javascript/actorTask_input_get.js | 9 ++++++--- .../javascript/actorTask_input_put.js | 12 ++++++------ .../code_samples/javascript/actorTask_put.js | 13 ++++++++----- .../javascript/actorTask_runs_get.js | 8 +++++--- .../javascript/actorTask_runs_post.js | 9 ++++++--- .../javascript/actorTask_webhooks_get.js | 8 +++++--- .../code_samples/javascript/actorTasks_get.js | 8 ++++++-- .../code_samples/javascript/actorTasks_post.js | 16 ++++++++-------- 10 files changed, 60 insertions(+), 39 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/actorTask_delete.js b/apify-api/openapi/code_samples/javascript/actorTask_delete.js index 5e3d4c753f..18009bf77c 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_delete.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_delete.js @@ -1,5 +1,6 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -await apifyClient.task('apify~my-sample-task').delete(); +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient.task('').delete(); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_get.js b/apify-api/openapi/code_samples/javascript/actorTask_get.js index cec1b3b8d5..5baa06b21f 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_get.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_get.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const task = await apifyClient.task('apify~my-sample-task').get(); +const apifyClient = new ApifyClient({ + token: '', +}); +const task = await apifyClient + .task('') + .get(); console.log(task); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_get.js b/apify-api/openapi/code_samples/javascript/actorTask_input_get.js index 416d8bf378..967a7e0e8e 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_input_get.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_get.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const input = await apifyClient.task('apify~my-sample-task').getInput(); +const apifyClient = new ApifyClient({ + token: '', +}); +const input = await apifyClient + .task('') + .getInput(); console.log(input); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js index 549e68ff2c..5246c046c8 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js @@ -1,10 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const updatedInput = await apifyClient.task('apify~my-sample-task') - .updateInput({ - // Your input here - }); +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedInput = await apifyClient + .task('') + .updateInput({ /** NEW INPUT */ }); console.log(updatedInput); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_put.js b/apify-api/openapi/code_samples/javascript/actorTask_put.js index 1c598046d0..202c2ad298 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_put.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_put.js @@ -1,9 +1,12 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const task = await apifyClient.task('apify~my-sample-task').update({ - title: 'New title', +const apifyClient = new ApifyClient({ + token: '', }); +const updatedTask = await apifyClient + .task('') + .update({ + title: 'New title', + }); -console.log(task); +console.log(updatedTask); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js b/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js index bb932e8317..fc510b1103 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_runs_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const { items } = await apifyClient.task('apify~my-sample-task') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .task('') .runs() .list(); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js b/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js index eacb9c0c85..9a5a86ce52 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_runs_post.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const run = await apifyClient.task('apify~my-sample-task').start(); +const apifyClient = new ApifyClient({ + token: '', +}); +const run = await apifyClient + .task('') + .start(); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js b/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js index 73e4546df9..5947c72414 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_webhooks_get.js @@ -1,8 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -// Replace apify~my-sample-task with your task's ID or technical name -const { items } = await apifyClient.task('apify~my-sample-task') +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .task('') .webhooks() .list(); diff --git a/apify-api/openapi/code_samples/javascript/actorTasks_get.js b/apify-api/openapi/code_samples/javascript/actorTasks_get.js index 2d4638f8d1..4ea9bb278f 100644 --- a/apify-api/openapi/code_samples/javascript/actorTasks_get.js +++ b/apify-api/openapi/code_samples/javascript/actorTasks_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const { items } = await apifyClient.tasks().list(); +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .tasks() + .list(); console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/actorTasks_post.js b/apify-api/openapi/code_samples/javascript/actorTasks_post.js index 8a76915dfd..2beae4e41a 100644 --- a/apify-api/openapi/code_samples/javascript/actorTasks_post.js +++ b/apify-api/openapi/code_samples/javascript/actorTasks_post.js @@ -1,13 +1,13 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const { items } = await apifyClient.tasks().create({ - /** - * Replace apify~my-sample-actor with the ID or technical name - * of the Actor this task will be based on - */ - actId: 'apify~my-sample-actor', - name: 'my-sample-task', +const apifyClient = new ApifyClient({ + token: '', }); +const { items } = await apifyClient + .tasks() + .create({ + actId: '', + name: '', + }); console.log(items); From 8b119361a523d93947417f3f16645569f75f6a56 Mon Sep 17 00:00:00 2001 From: Mihails Date: Wed, 11 Dec 2024 19:02:21 +0100 Subject: [PATCH 18/24] fix: better IDs and narrower code --- .../code_samples/javascript/actorBuild_abort_post.js | 8 ++++++-- .../code_samples/javascript/actorBuild_delete.js | 6 ++++-- .../openapi/code_samples/javascript/actorBuild_get.js | 8 ++++++-- .../code_samples/javascript/actorBuild_log_get.js | 7 +++++-- .../openapi/code_samples/javascript/actorBuilds_get.js | 8 ++++++-- .../code_samples/javascript/actorRun_abort_post.js | 10 +++++++--- .../openapi/code_samples/javascript/actorRun_delete.js | 8 ++++---- .../openapi/code_samples/javascript/actorRun_get.js | 8 ++++++-- .../code_samples/javascript/actorRun_metamorph_post.js | 9 ++++++--- .../openapi/code_samples/javascript/actorRun_put.js | 9 ++++++--- .../code_samples/javascript/actorRun_reboot_post.js | 8 ++++++-- .../code_samples/javascript/actorRun_resurrect_post.js | 10 +++++++--- .../openapi/code_samples/javascript/actorRuns_get.js | 8 ++++++-- 13 files changed, 75 insertions(+), 32 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js b/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js index ea5a34b6ce..9bc2a962da 100644 --- a/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js +++ b/apify-api/openapi/code_samples/javascript/actorBuild_abort_post.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const abortedBuild = await apifyClient.build('my-build-ID').abort(); +const apifyClient = new ApifyClient({ + token: '', +}); +const abortedBuild = await apifyClient + .build('') + .abort(); console.log(abortedBuild); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_delete.js b/apify-api/openapi/code_samples/javascript/actorBuild_delete.js index 918b5e3442..d5dba0bbf0 100644 --- a/apify-api/openapi/code_samples/javascript/actorBuild_delete.js +++ b/apify-api/openapi/code_samples/javascript/actorBuild_delete.js @@ -1,4 +1,6 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -await apifyClient.build('my-build-ID').delete(); +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient.build('').delete(); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_get.js b/apify-api/openapi/code_samples/javascript/actorBuild_get.js index b01c677751..e5d92e3638 100644 --- a/apify-api/openapi/code_samples/javascript/actorBuild_get.js +++ b/apify-api/openapi/code_samples/javascript/actorBuild_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const build = await apifyClient.build('my-build-ID').get(); +const apifyClient = new ApifyClient({ + token: '', +}); +const build = await apifyClient + .build('') + .get(); console.log(build); diff --git a/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js b/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js index 4ac2ec1cf7..8e71959ab7 100644 --- a/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js +++ b/apify-api/openapi/code_samples/javascript/actorBuild_log_get.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const buildLog = await apifyClient.build('my-build-ID') +const apifyClient = new ApifyClient({ + token: '', +}); +const buildLog = await apifyClient + .build('') .log() .get(); diff --git a/apify-api/openapi/code_samples/javascript/actorBuilds_get.js b/apify-api/openapi/code_samples/javascript/actorBuilds_get.js index 43ed251b38..52ed3e4e29 100644 --- a/apify-api/openapi/code_samples/javascript/actorBuilds_get.js +++ b/apify-api/openapi/code_samples/javascript/actorBuilds_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const { items } = await apifyClient.builds().list(); +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .builds() + .list(); console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js b/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js index 3f193a9422..1af7ebcea5 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_abort_post.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const run = await apifyClient.run('my-run-ID').abort(); +const apifyClient = new ApifyClient({ + token: '', +}); +const abortedRun = await apifyClient + .run('') + .abort(); -console.log(run); +console.log(abortedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_delete.js b/apify-api/openapi/code_samples/javascript/actorRun_delete.js index 457402bf70..96f1c596bd 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_delete.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_delete.js @@ -1,6 +1,6 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const run = await apifyClient.run('my-run-ID').delete(); - -console.log(run); +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient.run('').delete(); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_get.js b/apify-api/openapi/code_samples/javascript/actorRun_get.js index 13b482aa78..a521d49cab 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_get.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const run = await apifyClient.run('my-run-ID').get(); +const apifyClient = new ApifyClient({ + token: '', +}); +const run = await apifyClient + .run('') + .get(); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js b/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js index d28926e93e..7cc0bc3b2b 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_metamorph_post.js @@ -1,7 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const metamorphedRun = await apifyClient.run('my-run-ID') - .metamorph('target-actor-ID'); +const apifyClient = new ApifyClient({ + token: '', +}); +const metamorphedRun = await apifyClient + .run('') + .metamorph(''); console.log(metamorphedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_put.js b/apify-api/openapi/code_samples/javascript/actorRun_put.js index e879cb8ad9..9aef10b168 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_put.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_put.js @@ -1,9 +1,12 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const updatedRun = await apifyClient.run('my-run-ID') +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedRun = await apifyClient + .run('') .update({ - statusMessage: 'My status message', + statusMessage: 'Actor has finished', }); console.log(updatedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js b/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js index 4b20ceea33..5e837a87be 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_reboot_post.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const rebootedRun = await apifyClient.run('my-run-ID').reboot(); +const apifyClient = new ApifyClient({ + token: '', +}); +const rebootedRun = await apifyClient + .run('') + .reboot(); console.log(rebootedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js b/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js index a7957be446..975a94b6ce 100644 --- a/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js +++ b/apify-api/openapi/code_samples/javascript/actorRun_resurrect_post.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const run = await apifyClient.run('my-run-ID').resurrect(); +const apifyClient = new ApifyClient({ + token: '', +}); +const resurrectedRun = await apifyClient + .run('') + .resurrect(); -console.log(run); +console.log(resurrectedRun); diff --git a/apify-api/openapi/code_samples/javascript/actorRuns_get.js b/apify-api/openapi/code_samples/javascript/actorRuns_get.js index 9f61c2067b..9d58c9387d 100644 --- a/apify-api/openapi/code_samples/javascript/actorRuns_get.js +++ b/apify-api/openapi/code_samples/javascript/actorRuns_get.js @@ -1,6 +1,10 @@ import { ApifyClient } from 'apify-client'; -const apifyClient = new ApifyClient({ token: 'my-token' }); -const { items } = await apifyClient.runs().list(); +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .runs() + .list(); console.log(items); From 0588349dd5654a40658817b4c996fb63a487565b Mon Sep 17 00:00:00 2001 From: Mihails Date: Thu, 12 Dec 2024 18:24:55 +0100 Subject: [PATCH 19/24] feat: add code samples for storages --- .../code_samples/javascript/dataset_delete.js | 8 +++++++ .../code_samples/javascript/dataset_get.js | 10 +++++++++ .../javascript/dataset_items_get.js | 10 +++++++++ .../javascript/dataset_items_post.js | 11 ++++++++++ .../code_samples/javascript/dataset_put.js | 12 +++++++++++ .../code_samples/javascript/datasets_get.js | 10 +++++++++ .../code_samples/javascript/datasets_post.js | 10 +++++++++ .../javascript/keyValueStore_delete.js | 8 +++++++ .../javascript/keyValueStore_get.js | 10 +++++++++ .../javascript/keyValueStore_keys_get.js | 10 +++++++++ .../javascript/keyValueStore_put.js | 12 +++++++++++ .../javascript/keyValueStore_record_delete.js | 8 +++++++ .../javascript/keyValueStore_record_get.js | 10 +++++++++ .../javascript/keyValueStore_record_put.js | 11 ++++++++++ .../javascript/keyValueStores_get.js | 10 +++++++++ .../javascript/keyValueStores_post.js | 10 +++++++++ .../javascript/requestQueue_delete.js | 8 +++++++ .../javascript/requestQueue_get.js | 10 +++++++++ .../javascript/requestQueue_head_get.js | 10 +++++++++ .../javascript/requestQueue_head_lock_post.js | 12 +++++++++++ .../javascript/requestQueue_put.js | 12 +++++++++++ .../javascript/requestQueue_request_delete.js | 8 +++++++ .../javascript/requestQueue_request_get.js | 10 +++++++++ .../requestQueue_request_lock_delete.js | 8 +++++++ .../requestQueue_request_lock_put.js | 15 +++++++++++++ .../javascript/requestQueue_request_put.js | 13 ++++++++++++ .../requestQueue_requests_batch_delete.js | 13 ++++++++++++ .../requestQueue_requests_batch_post.js | 21 +++++++++++++++++++ .../javascript/requestQueue_requests_get.js | 10 +++++++++ .../javascript/requestQueue_requests_post.js | 14 +++++++++++++ .../javascript/requestQueues_get.js | 10 +++++++++ .../javascript/requestQueues_post.js | 10 +++++++++ 32 files changed, 344 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/dataset_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/dataset_get.js create mode 100644 apify-api/openapi/code_samples/javascript/dataset_items_get.js create mode 100644 apify-api/openapi/code_samples/javascript/dataset_items_post.js create mode 100644 apify-api/openapi/code_samples/javascript/dataset_put.js create mode 100644 apify-api/openapi/code_samples/javascript/datasets_get.js create mode 100644 apify-api/openapi/code_samples/javascript/datasets_post.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_get.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_keys_get.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_put.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_record_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_record_get.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStore_record_put.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStores_get.js create mode 100644 apify-api/openapi/code_samples/javascript/keyValueStores_post.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_get.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_head_get.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_head_lock_post.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_put.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_request_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_request_get.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_request_lock_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_request_lock_put.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_request_put.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_post.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_requests_get.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueue_requests_post.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueues_get.js create mode 100644 apify-api/openapi/code_samples/javascript/requestQueues_post.js diff --git a/apify-api/openapi/code_samples/javascript/dataset_delete.js b/apify-api/openapi/code_samples/javascript/dataset_delete.js new file mode 100644 index 0000000000..359ddacf74 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/dataset_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .dataset('') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/dataset_get.js b/apify-api/openapi/code_samples/javascript/dataset_get.js new file mode 100644 index 0000000000..b64a28d8dc --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/dataset_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const dataset = await apifyClient + .dataset('') + .get(); + +console.log(dataset); diff --git a/apify-api/openapi/code_samples/javascript/dataset_items_get.js b/apify-api/openapi/code_samples/javascript/dataset_items_get.js new file mode 100644 index 0000000000..795926fe14 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/dataset_items_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .dataset('') + .listItems(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/dataset_items_post.js b/apify-api/openapi/code_samples/javascript/dataset_items_post.js new file mode 100644 index 0000000000..8c2a09d551 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/dataset_items_post.js @@ -0,0 +1,11 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .dataset('') + .pushItems([ + { foo: 'bar' }, + { fizz: 'buzz' }, + ]); diff --git a/apify-api/openapi/code_samples/javascript/dataset_put.js b/apify-api/openapi/code_samples/javascript/dataset_put.js new file mode 100644 index 0000000000..35c3a9ab7a --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/dataset_put.js @@ -0,0 +1,12 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedDataset = await apifyClient + .dataset('') + .update({ + title: 'New title', + }); + +console.log(updatedDataset); diff --git a/apify-api/openapi/code_samples/javascript/datasets_get.js b/apify-api/openapi/code_samples/javascript/datasets_get.js new file mode 100644 index 0000000000..000841d40f --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/datasets_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .datasets() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/datasets_post.js b/apify-api/openapi/code_samples/javascript/datasets_post.js new file mode 100644 index 0000000000..c1610a0d48 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/datasets_post.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const dataset = await apifyClient + .datasets() + .getOrCreate(''); + +console.log(dataset); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_delete.js b/apify-api/openapi/code_samples/javascript/keyValueStore_delete.js new file mode 100644 index 0000000000..65e7da57a6 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .keyValueStore('') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_get.js b/apify-api/openapi/code_samples/javascript/keyValueStore_get.js new file mode 100644 index 0000000000..6ac4443f15 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const store = await apifyClient + .keyValueStore('') + .get(); + +console.log(store); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_keys_get.js b/apify-api/openapi/code_samples/javascript/keyValueStore_keys_get.js new file mode 100644 index 0000000000..4cec302be3 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_keys_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .keyValueStore('') + .listKeys(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_put.js b/apify-api/openapi/code_samples/javascript/keyValueStore_put.js new file mode 100644 index 0000000000..a092e8b6ad --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_put.js @@ -0,0 +1,12 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedStore = await apifyClient + .keyValueStore('') + .update({ + title: 'New title', + }); + +console.log(updatedStore); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_record_delete.js b/apify-api/openapi/code_samples/javascript/keyValueStore_record_delete.js new file mode 100644 index 0000000000..05ca706d82 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_record_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .keyValueStore('') + .deleteRecord(''); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_record_get.js b/apify-api/openapi/code_samples/javascript/keyValueStore_record_get.js new file mode 100644 index 0000000000..d5a4aefb62 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_record_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const record = await apifyClient + .keyValueStore('') + .getRecord(''); + +console.log(record); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStore_record_put.js b/apify-api/openapi/code_samples/javascript/keyValueStore_record_put.js new file mode 100644 index 0000000000..dd6230cfdf --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStore_record_put.js @@ -0,0 +1,11 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .keyValueStore('') + .setRecord({ + key: '', + value: 'my value', + }); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStores_get.js b/apify-api/openapi/code_samples/javascript/keyValueStores_get.js new file mode 100644 index 0000000000..31d0f95d51 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStores_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .keyValueStores() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/keyValueStores_post.js b/apify-api/openapi/code_samples/javascript/keyValueStores_post.js new file mode 100644 index 0000000000..56da936388 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/keyValueStores_post.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const store = await apifyClient + .keyValueStores() + .getOrCreate(''); + +console.log(store); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_delete.js b/apify-api/openapi/code_samples/javascript/requestQueue_delete.js new file mode 100644 index 0000000000..1c12403f4e --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .requestQueue('') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_get.js b/apify-api/openapi/code_samples/javascript/requestQueue_get.js new file mode 100644 index 0000000000..2f7a4c5c35 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const queue = await apifyClient + .requestQueue('') + .get(); + +console.log(queue); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_head_get.js b/apify-api/openapi/code_samples/javascript/requestQueue_head_get.js new file mode 100644 index 0000000000..61afd5af66 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_head_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const head = await apifyClient + .requestQueue('') + .listHead(); + +console.log(head); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_head_lock_post.js b/apify-api/openapi/code_samples/javascript/requestQueue_head_lock_post.js new file mode 100644 index 0000000000..47fc8da253 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_head_lock_post.js @@ -0,0 +1,12 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .listAndLockHead({ + lockSecs: 300, + }); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_put.js b/apify-api/openapi/code_samples/javascript/requestQueue_put.js new file mode 100644 index 0000000000..f7f6dc4759 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_put.js @@ -0,0 +1,12 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedQueue = await apifyClient + .requestQueue('') + .update({ + title: 'New title', + }); + +console.log(updatedQueue); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_delete.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_delete.js new file mode 100644 index 0000000000..5c79dfee32 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .requestQueue('') + .deleteRequest(''); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_get.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_get.js new file mode 100644 index 0000000000..f197e88017 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const request = await apifyClient + .requestQueue('') + .getRequest(''); + +console.log(request); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_delete.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_delete.js new file mode 100644 index 0000000000..45aec1a440 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .requestQueue('') + .deleteRequestLock(''); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_put.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_put.js new file mode 100644 index 0000000000..1aba3f131b --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_lock_put.js @@ -0,0 +1,15 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .prolongRequestLock( + '', + { + lockSecs: 3600, + }, + ); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js new file mode 100644 index 0000000000..4856645387 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js @@ -0,0 +1,13 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .updateRequest({ + id: '', + url: 'http://example.com', + }); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_delete.js b/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_delete.js new file mode 100644 index 0000000000..08ebdecb15 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_delete.js @@ -0,0 +1,13 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .batchDeleteRequests([ + { uniqueKey: 'http://example.com' }, + { uniqueKey: 'http://example.com/2' }, + ]); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_post.js b/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_post.js new file mode 100644 index 0000000000..297e234802 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_requests_batch_post.js @@ -0,0 +1,21 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .batchAddRequests([ + { + uniqueKey: 'http://example.com', + url: 'http://example.com', + method: 'GET', + }, + { + uniqueKey: 'http://example.com/2', + url: 'http://example.com/2', + method: 'GET', + }, + ]); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_requests_get.js b/apify-api/openapi/code_samples/javascript/requestQueue_requests_get.js new file mode 100644 index 0000000000..806336ef72 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_requests_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .requestQueue('') + .listRequests(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_requests_post.js b/apify-api/openapi/code_samples/javascript/requestQueue_requests_post.js new file mode 100644 index 0000000000..02cc073684 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueue_requests_post.js @@ -0,0 +1,14 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .requestQueue('') + .addRequest({ + 'uniqueKey': 'http://example.com', + 'url': 'http://example.com', + 'method': 'GET', + }); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/requestQueues_get.js b/apify-api/openapi/code_samples/javascript/requestQueues_get.js new file mode 100644 index 0000000000..f2f6ddfcb2 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueues_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .requestQueues() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/requestQueues_post.js b/apify-api/openapi/code_samples/javascript/requestQueues_post.js new file mode 100644 index 0000000000..74dd736589 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/requestQueues_post.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const queue = await apifyClient + .requestQueues() + .getOrCreate(''); + +console.log(queue); From 5ed4efa09df468332af07e3738ec87199af6870e Mon Sep 17 00:00:00 2001 From: Mihails Date: Thu, 12 Dec 2024 18:59:51 +0100 Subject: [PATCH 20/24] feat: add code samples for webhooks --- .../javascript/webhookDispatch_get.js | 10 ++++++++++ .../javascript/webhookDispatches_get.js | 10 ++++++++++ .../code_samples/javascript/webhook_delete.js | 8 ++++++++ .../javascript/webhook_dispatches_get.js | 11 +++++++++++ .../code_samples/javascript/webhook_get.js | 10 ++++++++++ .../code_samples/javascript/webhook_put.js | 12 ++++++++++++ .../code_samples/javascript/webhook_test_post.js | 10 ++++++++++ .../code_samples/javascript/webhooks_get.js | 10 ++++++++++ .../code_samples/javascript/webhooks_post.js | 16 ++++++++++++++++ 9 files changed, 97 insertions(+) create mode 100644 apify-api/openapi/code_samples/javascript/webhookDispatch_get.js create mode 100644 apify-api/openapi/code_samples/javascript/webhookDispatches_get.js create mode 100644 apify-api/openapi/code_samples/javascript/webhook_delete.js create mode 100644 apify-api/openapi/code_samples/javascript/webhook_dispatches_get.js create mode 100644 apify-api/openapi/code_samples/javascript/webhook_get.js create mode 100644 apify-api/openapi/code_samples/javascript/webhook_put.js create mode 100644 apify-api/openapi/code_samples/javascript/webhook_test_post.js create mode 100644 apify-api/openapi/code_samples/javascript/webhooks_get.js create mode 100644 apify-api/openapi/code_samples/javascript/webhooks_post.js diff --git a/apify-api/openapi/code_samples/javascript/webhookDispatch_get.js b/apify-api/openapi/code_samples/javascript/webhookDispatch_get.js new file mode 100644 index 0000000000..e09873dd9c --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhookDispatch_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const dispatch = await apifyClient + .webhookDispatch('') + .get(); + +console.log(dispatch); diff --git a/apify-api/openapi/code_samples/javascript/webhookDispatches_get.js b/apify-api/openapi/code_samples/javascript/webhookDispatches_get.js new file mode 100644 index 0000000000..b7b03ace00 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhookDispatches_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .webhookDispatches() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/webhook_delete.js b/apify-api/openapi/code_samples/javascript/webhook_delete.js new file mode 100644 index 0000000000..d37ec999a0 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhook_delete.js @@ -0,0 +1,8 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +await apifyClient + .webhook('') + .delete(); diff --git a/apify-api/openapi/code_samples/javascript/webhook_dispatches_get.js b/apify-api/openapi/code_samples/javascript/webhook_dispatches_get.js new file mode 100644 index 0000000000..a8f925a18f --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhook_dispatches_get.js @@ -0,0 +1,11 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .webhook('') + .dispatches() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/webhook_get.js b/apify-api/openapi/code_samples/javascript/webhook_get.js new file mode 100644 index 0000000000..e143b8567e --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhook_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const webhook = await apifyClient + .webhook('') + .get(); + +console.log(webhook); diff --git a/apify-api/openapi/code_samples/javascript/webhook_put.js b/apify-api/openapi/code_samples/javascript/webhook_put.js new file mode 100644 index 0000000000..ebe131497f --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhook_put.js @@ -0,0 +1,12 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const updatedWebhook = await apifyClient + .webhook('') + .update({ + eventTypes: ['ACTOR.RUN.FAILED'], + }); + +console.log(updatedWebhook); diff --git a/apify-api/openapi/code_samples/javascript/webhook_test_post.js b/apify-api/openapi/code_samples/javascript/webhook_test_post.js new file mode 100644 index 0000000000..524ac5a93d --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhook_test_post.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const result = await apifyClient + .webhook('') + .test(); + +console.log(result); diff --git a/apify-api/openapi/code_samples/javascript/webhooks_get.js b/apify-api/openapi/code_samples/javascript/webhooks_get.js new file mode 100644 index 0000000000..2ea019de4e --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhooks_get.js @@ -0,0 +1,10 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const { items } = await apifyClient + .webhooks() + .list(); + +console.log(items); diff --git a/apify-api/openapi/code_samples/javascript/webhooks_post.js b/apify-api/openapi/code_samples/javascript/webhooks_post.js new file mode 100644 index 0000000000..b9e486fad5 --- /dev/null +++ b/apify-api/openapi/code_samples/javascript/webhooks_post.js @@ -0,0 +1,16 @@ +import { ApifyClient } from 'apify-client'; + +const apifyClient = new ApifyClient({ + token: '', +}); +const webhook = await apifyClient + .webhooks() + .create({ + eventTypes: ['ACTOR.RUN.SUCCEEDED'], + condition: { + actorId: '', + }, + requestUrl: 'http://example.com/', + }); + +console.log(webhook); From 98e30d555f5a5b630ecb98d63809e7a46e7ad0d2 Mon Sep 17 00:00:00 2001 From: Mihails Date: Fri, 13 Dec 2024 10:36:18 +0100 Subject: [PATCH 21/24] fix examples --- apify-api/openapi/code_samples/javascript/act_runs_post.js | 2 +- .../openapi/code_samples/javascript/actorTask_input_put.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js index c8f706eac2..b5c3975f7c 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_post.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_post.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const run = await apifyClient .actor('') - .start({ /** */ }); + .start({ 'foo': 'bar' }); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js index 5246c046c8..44dd5ca075 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const updatedInput = await apifyClient .task('') - .updateInput({ /** NEW INPUT */ }); + .updateInput({ 'foo': 'baz' }); console.log(updatedInput); From 5088bfcbe4ab27ca13c900ff71ec0f53417ddc8d Mon Sep 17 00:00:00 2001 From: Mihails Date: Fri, 13 Dec 2024 11:20:52 +0100 Subject: [PATCH 22/24] fix quote marks --- apify-api/openapi/code_samples/javascript/act_runs_post.js | 2 +- .../openapi/code_samples/javascript/actorTask_input_put.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js index b5c3975f7c..316deb6ba2 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_post.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_post.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const run = await apifyClient .actor('') - .start({ 'foo': 'bar' }); + .start({ foo: 'bar' }); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js index 44dd5ca075..df39954598 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const updatedInput = await apifyClient .task('') - .updateInput({ 'foo': 'baz' }); + .updateInput({ foo: 'baz' }); console.log(updatedInput); From f077f7c350925e2f70dc5bc4c4366430c2a28b2a Mon Sep 17 00:00:00 2001 From: Mihails Date: Fri, 13 Dec 2024 14:39:32 +0100 Subject: [PATCH 23/24] fix quote marks --- apify-api/openapi/code_samples/javascript/act_runs_post.js | 2 +- .../openapi/code_samples/javascript/actorTask_input_put.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apify-api/openapi/code_samples/javascript/act_runs_post.js b/apify-api/openapi/code_samples/javascript/act_runs_post.js index b5c3975f7c..316deb6ba2 100644 --- a/apify-api/openapi/code_samples/javascript/act_runs_post.js +++ b/apify-api/openapi/code_samples/javascript/act_runs_post.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const run = await apifyClient .actor('') - .start({ 'foo': 'bar' }); + .start({ foo: 'bar' }); console.log(run); diff --git a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js index 44dd5ca075..df39954598 100644 --- a/apify-api/openapi/code_samples/javascript/actorTask_input_put.js +++ b/apify-api/openapi/code_samples/javascript/actorTask_input_put.js @@ -5,6 +5,6 @@ const apifyClient = new ApifyClient({ }); const updatedInput = await apifyClient .task('') - .updateInput({ 'foo': 'baz' }); + .updateInput({ foo: 'baz' }); console.log(updatedInput); From 8d83e2f8bf2e5daebe8f94f049c88e16823d43cc Mon Sep 17 00:00:00 2001 From: Mihails Date: Tue, 17 Dec 2024 10:40:01 +0100 Subject: [PATCH 24/24] fix the missing uniqueKey --- .../openapi/code_samples/javascript/requestQueue_request_put.js | 1 + 1 file changed, 1 insertion(+) diff --git a/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js b/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js index 4856645387..62b3e86fa2 100644 --- a/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js +++ b/apify-api/openapi/code_samples/javascript/requestQueue_request_put.js @@ -7,6 +7,7 @@ const result = await apifyClient .requestQueue('') .updateRequest({ id: '', + uniqueKey: 'http://example.com', url: 'http://example.com', });