@pipedream/tableau 0.2.0 → 0.3.0

package/actions/create-project/create-project.mjs

@@ -4,7 +4,12 @@ export default {
   key: "tableau-create-project",
   name: "Create Project",
   description: "Creates a project on the specified site. You can also create project hierarchies by creating a project under the specified parent project on the site. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#create_project)",
-  version: "0.0.2",
+  version: "0.0.4",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     app,

package/actions/download-pdf/download-pdf.mjs

@@ -6,7 +6,12 @@ export default {
   key: "tableau-download-pdf",
   name: "Download PDF",
   description: "Downloads images of the sheets of a workbook as a PDF file. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#download_workbook_pdf)",
-  version: "0.0.1",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     app,

package/actions/list-sites/list-sites.mjs

@@ -0,0 +1,71 @@
+import tableau from "../../tableau.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "tableau-list-sites",
+  name: "List Sites",
+  description: "Returns a list of the sites on the server that the caller of this method has access to. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm#query_sites)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    tableau,
+    info: {
+      type: "alert",
+      alertType: "info",
+      content: "Listing all sites requires Server Administrator Permissions. If you don't have these permissions, the action will return the site from the current session.",
+    },
+    pageSize: {
+      type: "integer",
+      label: "Page Size",
+      description: "The number of sites to return per page. The default is 100. Maximum is 1000. Only used for calls with Server Administrator Permissions.",
+      optional: true,
+      default: 100,
+      min: 1,
+      max: 1000,
+    },
+    pageNumber: {
+      type: "integer",
+      label: "Page Number",
+      description: "The page number to return. The default is 1. Only used for calls with Server Administrator Permissions.",
+      optional: true,
+      default: 1,
+      min: 1,
+    },
+  },
+  async run({ $ }) {
+    let response;
+    try {
+      response = await this.tableau.listSites({
+        $,
+        params: {
+          pageSize: this.pageSize,
+          pageNumber: this.pageNumber,
+        },
+      });
+    } catch (error) {
+      if (error?.message?.includes("Invalid page number")) {
+        throw new ConfigurationError("Page number invalid.");
+      }
+      // User lacks permission to list sites. Return the site from the current session.
+      const { session: { site } } = await this.tableau.getCurrentSession({
+        $,
+      });
+      response = {
+        sites: {
+          site: [
+            site,
+          ],
+        },
+      };
+    }
+    $.export("$summary", `Successfully listed ${response.sites.site.length} site${response.sites.site.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/list-workbooks/list-workbooks.mjs

@@ -0,0 +1,85 @@
+import tableau from "../../tableau.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "tableau-list-workbooks",
+  name: "List Workbooks",
+  description: "Returns a list of the workbooks on the specified site. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#query_workbooks_for_site)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    tableau,
+    siteId: {
+      description: "The ID of the site to list workbooks for. Can use the **List Sites** action to get a list of sites.",
+      propDefinition: [
+        tableau,
+        "siteId",
+      ],
+    },
+    filter: {
+      type: "string",
+      label: "Filter",
+      description: "An expression that lets you specify a subset of workbooks to return. You can filter on predefined fields such as name, tags, and createdAt. You can include multiple filter expressions. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm).",
+      optional: true,
+    },
+    sort: {
+      type: "string",
+      label: "Sort",
+      description: "An expression that lets you specify the order in which workbook information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm).",
+      optional: true,
+    },
+    field: {
+      type: "string",
+      label: "Field",
+      description: "An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as _all_ or _default_, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see [Using Fields in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_fields.htm).",
+      optional: true,
+    },
+    pageSize: {
+      type: "integer",
+      label: "Page Size",
+      description: "The number of workbooks to return per page. The default is 100. Maximum is 1000.",
+      optional: true,
+      default: 100,
+      min: 1,
+      max: 1000,
+    },
+    pageNumber: {
+      type: "integer",
+      label: "Page Number",
+      description: "The page number to return. The default is 1.",
+      optional: true,
+      default: 1,
+      min: 1,
+    },
+  },
+  async run({ $ }) {
+    let response;
+    try {
+      response = await this.tableau.listWorkbooks({
+        $,
+        siteId: this.siteId,
+        params: {
+          filter: this.filter,
+          sort: this.sort,
+          field: this.field,
+          pageSize: this.pageSize,
+          pageNumber: this.pageNumber,
+        },
+      });
+    } catch (error) {
+      if (error?.message?.includes("Invalid page number")) {
+        throw new ConfigurationError("Page number invalid.");
+      }
+    }
+    const count = response.workbooks?.workbook?.length ?? 0;
+    $.export("$summary", `Successfully listed ${count} workbook${count === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/query-projects/query-projects.mjs

@@ -5,7 +5,12 @@ export default {
   key: "tableau-query-projects",
   name: "Query Projects",
   description: "Returns a list of projects on the specified site. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm)",
-  version: "0.0.2",
+  version: "0.0.4",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     app,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/tableau",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Pipedream Tableau Components",
   "main": "tableau.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.6.0"
+    "@pipedream/platform": "^1.6.8"
   }
 }

package/sources/label-created-instant/label-created-instant.mjs

@@ -6,7 +6,7 @@ export default {
   key: "tableau-label-created-instant",
   name: "New Label Created (Instant)",
   description: "Emit new event when a label is created in Tableau. [See the documentation](https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "source",
   dedupe: "unique",
   methods: {

package/sources/workbook-created-instant/workbook-created-instant.mjs

@@ -6,7 +6,7 @@ export default {
   key: "tableau-workbook-created-instant",
   name: "New Workbook Created (Instant)",
   description: "Emit new event each time a new workbook is created in Tableau. [See the documentation](https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "source",
   dedupe: "unique",
   methods: {

package/tableau.app.mjs

@@ -129,6 +129,12 @@ export default {
         ...args,
       });
     },
+    listSites(args = {}) {
+      return this._makeRequest({
+        path: "/sites",
+        ...args,
+      });
+    },
     downloadWorkbookPdf({
       siteId, workbookId, ...args
     }) {