[ACTION] booking experts - filters

Author: jcortes

components/booking_experts/actions/list-bookings/list-bookings.mjs

@@ -4,7 +4,7 @@ export default {
   key: "booking_experts-list-bookings",
   name: "List Bookings",
   description: "Returns a list of bookings for an administration. [See the documentation](https://developers.bookingexperts.com/reference/administration-bookings-index)",
-  version: "0.0.4",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
@@ -39,15 +39,28 @@ export default {
       ],
       description: "Filter by channel",
     },
-    reservationId: {
+    reservationIds: {
+      type: "string[]",
+      label: "Reservation IDs",
+      description: "Filter by reservation IDs",
       propDefinition: [
         bookingExperts,
         "reservationId",
         (c) => ({
           administrationId: c.administrationId,
         }),
       ],
-      description: "Filter by reservation",
+    },
+    createdAt: {
+      type: "string",
+      label: "Created At",
+      description: "Filter by created at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
+      optional: true,
+    },
+    updatedAt: {
+      type: "string",
+      label: "Updated At",
+      description: "Filter by updated at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
       optional: true,
     },
     page: {
@@ -62,19 +75,103 @@ export default {
         "perPage",
       ],
     },
+    filterId: {
+      optional: true,
+      propDefinition: [
+        bookingExperts,
+        "bookingId",
+        ({ administrationId }) => ({
+          administrationId,
+        }),
+      ],
+    },
+    customerIds: {
+      type: "string[]",
+      label: "Customer IDs",
+      description: "Filter by customer IDs",
+      propDefinition: [
+        bookingExperts,
+        "customerId",
+        ({ administrationId }) => ({
+          administrationId,
+        }),
+      ],
+    },
+    bookingNr: {
+      label: "Booking Number",
+      description: "Filter by booking number",
+      optional: true,
+      propDefinition: [
+        bookingExperts,
+        "bookingId",
+        ({ administrationId }) => ({
+          administrationId,
+          mapper: ({ attributes: { booking_nr: value } }) => value,
+        }),
+      ],
+    },
+    confirmedAt: {
+      type: "string",
+      label: "Confirmed At",
+      description: "Filter by confirmed at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
+      optional: true,
+    },
+    fieldsBooking: {
+      type: "string[]",
+      label: "Fields Booking",
+      description: "Fields to return for the booking",
+      optional: true,
+    },
+    referenceNr: {
+      type: "string",
+      label: "Reference Number",
+      description: "Filter by reference number",
+      optional: true,
+    },
+  },
+  methods: {
+    commaSeparatedList(value) {
+      return Array.isArray(value) && value?.length > 0
+        ? value.join(",")
+        : value;
+    },
   },
   async run({ $ }) {
+    const {
+      commaSeparatedList,
+      administrationId,
+      ownerId,
+      administrationChannelId,
+      reservationIds,
+      createdAt,
+      updatedAt,
+      page,
+      perPage,
+      filterId,
+      customerIds,
+      bookingNr,
+      confirmedAt,
+      fieldsBooking,
+      referenceNr,
+    } = this;
+
     const { data } = await this.bookingExperts.listBookings({
       $,
-      administrationId: this.administrationId,
+      administrationId,
       params: {
-        "filter[owner]": this.ownerId,
-        "filter[channel]": this.listAdministrationChannels,
-        "filter[reservations]": this.reservationId,
-        "filter[created_at]": this.createdAt,
-        "filter[updated_at]": this.updatedAt,
-        "page[number]": this.page,
-        "page[size]": this.perPage,
+        "filter[owner]": ownerId,
+        "filter[channel]": administrationChannelId,
+        "filter[created_at]": createdAt,
+        "filter[updated_at]": updatedAt,
+        "page[number]": page,
+        "page[size]": perPage,
+        "filter[ID]": filterId,
+        "filter[reservations]": commaSeparatedList(reservationIds),
+        "filter[customer]": commaSeparatedList(customerIds),
+        "filter[booking_nr]": bookingNr,
+        "filter[confirmed_at]": confirmedAt,
+        "fields[booking]": commaSeparatedList(fieldsBooking),
+        "filter[reference_nr]": referenceNr,
       },
     });
     $.export("$summary", `Found ${data.length} bookings`);

components/booking_experts/booking_experts.app.mjs

@@ -72,19 +72,23 @@ export default {
       description: "The ID of a booking",
       async options({
         page, administrationId,
+        mapper = ({
+          id, attributes,
+        }) => ({
+          label: attributes.booking_nr,
+          value: id,
+        }),
       }) {
+        if (!administrationId) {
+          return [];
+        }
         const { data } = await this.listBookings({
           administrationId,
           params: {
             "page[number]": page + 1,
           },
         });
-        return data?.map(({
-          id, attributes,
-        }) => ({
-          label: attributes.booking_nr,
-          value: id,
-        })) || [];
+        return data?.map(mapper) || [];
       },
     },
     channelId: {
@@ -256,6 +260,35 @@ export default {
       max: 100,
       optional: true,
     },
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "The ID of a customer",
+      optional: true,
+      async options({
+        page, administrationId,
+      }) {
+        if (!administrationId) {
+          return [];
+        }
+        const { data } = await this.listCustomers({
+          administrationId,
+          params: {
+            "page[number]": page + 1,
+          },
+        });
+        return data?.map(({
+          id, attributes,
+        }) => ({
+          // if first_name and last_name are not empty, show them, otherwise show the email
+          label: [
+            attributes.first_name,
+            attributes.last_name,
+          ].filter(Boolean).join(" ") || attributes.email || id,
+          value: id,
+        })) || [];
+      },
+    },
   },
   methods: {
     _baseUrl() {
@@ -443,5 +476,13 @@ export default {
         ...opts,
       });
     },
+    listCustomers({
+      administrationId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/administrations/${administrationId}/customers`,
+        ...opts,
+      });
+    },
   },
 };

components/booking_experts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/booking_experts",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Pipedream Booking Experts Components",
   "main": "booking_experts.app.mjs",
   "keywords": [