@pipedream/snipe_it 0.0.1 → 0.2.0

package/actions/create-hardware/create-hardware.mjs

@@ -0,0 +1,233 @@
+import app from "../../snipe_it.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "snipe_it-create-hardware",
+  name: "Create Hardware Asset",
+  description: "Creates a new hardware asset in Snipe-IT. [See the documentation](https://snipe-it.readme.io/reference/hardware-create)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    modelId: {
+      propDefinition: [
+        app,
+        "modelId",
+      ],
+    },
+    statusId: {
+      propDefinition: [
+        app,
+        "statusId",
+      ],
+    },
+    assetTag: {
+      propDefinition: [
+        app,
+        "assetTag",
+      ],
+    },
+    name: {
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    image: {
+      propDefinition: [
+        app,
+        "image",
+      ],
+    },
+    serial: {
+      propDefinition: [
+        app,
+        "serial",
+      ],
+    },
+    purchaseDate: {
+      propDefinition: [
+        app,
+        "purchaseDate",
+      ],
+    },
+    purchaseCost: {
+      propDefinition: [
+        app,
+        "purchaseCost",
+      ],
+    },
+    orderNumber: {
+      propDefinition: [
+        app,
+        "orderNumber",
+      ],
+    },
+    notes: {
+      propDefinition: [
+        app,
+        "notes",
+      ],
+    },
+    archived: {
+      propDefinition: [
+        app,
+        "archived",
+      ],
+    },
+    warrantyMonths: {
+      propDefinition: [
+        app,
+        "warrantyMonths",
+      ],
+    },
+    depreciate: {
+      propDefinition: [
+        app,
+        "depreciate",
+      ],
+    },
+    supplierId: {
+      propDefinition: [
+        app,
+        "supplierId",
+      ],
+    },
+    requestable: {
+      propDefinition: [
+        app,
+        "requestable",
+      ],
+    },
+    rtdLocationId: {
+      label: "RTD Location",
+      description: "Select the default location for this asset",
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    lastAuditDate: {
+      propDefinition: [
+        app,
+        "lastAuditDate",
+      ],
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    byod: {
+      propDefinition: [
+        app,
+        "byod",
+      ],
+    },
+    customFields: {
+      propDefinition: [
+        app,
+        "customFields",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      modelId,
+      statusId,
+      assetTag,
+      name,
+      image,
+      serial,
+      purchaseDate,
+      purchaseCost,
+      orderNumber,
+      notes,
+      archived,
+      warrantyMonths,
+      depreciate,
+      supplierId,
+      requestable,
+      rtdLocationId,
+      lastAuditDate,
+      locationId,
+      byod,
+      customFields,
+    } = this;
+
+    const parsedCustomFields = utils.parseJson(customFields);
+
+    const response = await app.createHardware({
+      $,
+      data: {
+        model_id: modelId,
+        status_id: statusId,
+        ...(name && {
+          name,
+        }),
+        ...(assetTag && {
+          asset_tag: assetTag,
+        }),
+        ...(image && {
+          image,
+        }),
+        ...(serial && {
+          serial,
+        }),
+        ...(purchaseDate && {
+          purchase_date: purchaseDate,
+        }),
+        ...(purchaseCost && {
+          purchase_cost: purchaseCost,
+        }),
+        ...(orderNumber && {
+          order_number: orderNumber,
+        }),
+        ...(notes && {
+          notes,
+        }),
+        ...(archived !== undefined && {
+          archived,
+        }),
+        ...(warrantyMonths && {
+          warranty_months: warrantyMonths,
+        }),
+        ...(depreciate !== undefined && {
+          depreciate,
+        }),
+        ...(supplierId && {
+          supplier_id: supplierId,
+        }),
+        ...(requestable !== undefined && {
+          requestable,
+        }),
+        ...(rtdLocationId && {
+          rtd_location_id: rtdLocationId,
+        }),
+        ...(lastAuditDate && {
+          last_audit_date: lastAuditDate,
+        }),
+        ...(locationId && {
+          location_id: locationId,
+        }),
+        ...(byod !== undefined && {
+          byod,
+        }),
+        ...(typeof(parsedCustomFields) === "object"
+          ? parsedCustomFields
+          : {}
+        ),
+      },
+    });
+
+    $.export("$summary", `Successfully created hardware asset with ID \`${response.payload.id}\``);
+    return response;
+  },
+};

package/actions/create-user/create-user.mjs

@@ -0,0 +1,216 @@
+import app from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-create-user",
+  name: "Create User",
+  description: "Creates a new user in Snipe-IT with profile information required for asset or license assignments. [See the documentation](https://snipe-it.readme.io/reference/users-2)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    firstName: {
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+    },
+    username: {
+      propDefinition: [
+        app,
+        "username",
+      ],
+    },
+    password: {
+      propDefinition: [
+        app,
+        "password",
+      ],
+    },
+    passwordConfirmation: {
+      propDefinition: [
+        app,
+        "passwordConfirmation",
+      ],
+    },
+    lastName: {
+      propDefinition: [
+        app,
+        "lastName",
+      ],
+    },
+    email: {
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    activated: {
+      propDefinition: [
+        app,
+        "activated",
+      ],
+    },
+    phone: {
+      propDefinition: [
+        app,
+        "phone",
+      ],
+    },
+    jobtitle: {
+      propDefinition: [
+        app,
+        "jobtitle",
+      ],
+    },
+    managerId: {
+      propDefinition: [
+        app,
+        "managerId",
+      ],
+    },
+    employeeNum: {
+      propDefinition: [
+        app,
+        "employeeNum",
+      ],
+    },
+    notes: {
+      description: "Notes about the user",
+      propDefinition: [
+        app,
+        "notes",
+      ],
+    },
+    companyId: {
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    twoFactorEnrolled: {
+      propDefinition: [
+        app,
+        "twoFactorEnrolled",
+      ],
+    },
+    twoFactorOptIn: {
+      propDefinition: [
+        app,
+        "twoFactorOptIn",
+      ],
+    },
+    departmentId: {
+      propDefinition: [
+        app,
+        "departmentId",
+      ],
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    remote: {
+      propDefinition: [
+        app,
+        "remote",
+      ],
+    },
+    groups: {
+      propDefinition: [
+        app,
+        "groupIds",
+      ],
+    },
+    autoAssignLicenses: {
+      propDefinition: [
+        app,
+        "autoAssignLicenses",
+      ],
+    },
+    vip: {
+      propDefinition: [
+        app,
+        "vip",
+      ],
+    },
+    startDate: {
+      propDefinition: [
+        app,
+        "startDate",
+      ],
+    },
+    endDate: {
+      propDefinition: [
+        app,
+        "endDate",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      firstName,
+      username,
+      password,
+      passwordConfirmation,
+      lastName,
+      email,
+      activated,
+      phone,
+      jobtitle,
+      managerId,
+      employeeNum,
+      notes,
+      companyId,
+      twoFactorEnrolled,
+      twoFactorOptIn,
+      departmentId,
+      locationId,
+      remote,
+      groups,
+      autoAssignLicenses,
+      vip,
+      startDate,
+      endDate,
+    } = this;
+
+    const response = await app.createUser({
+      $,
+      data: {
+        first_name: firstName,
+        username,
+        password,
+        password_confirmation: passwordConfirmation,
+        last_name: lastName,
+        email,
+        activated,
+        phone,
+        jobtitle,
+        manager_id: managerId,
+        employee_num: employeeNum,
+        notes,
+        company_id: companyId,
+        two_factor_enrolled: twoFactorEnrolled,
+        two_factor_optin: twoFactorOptIn,
+        department_id: departmentId,
+        location_id: locationId,
+        remote,
+        groups,
+        autoassign_licenses: autoAssignLicenses,
+        vip,
+        start_date: startDate,
+        end_date: endDate,
+      },
+    });
+
+    $.export("$summary", `Successfully created user with ID \`${response.payload.id}\``);
+    return response;
+  },
+};

package/actions/get-hardware/get-hardware.mjs

@@ -0,0 +1,32 @@
+import app from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-get-hardware",
+  name: "Get Hardware Asset",
+  description: "Retrieves details of a specific hardware asset by ID. [See the documentation](https://snipe-it.readme.io/reference/hardware-by-id)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    hardwareId: {
+      propDefinition: [
+        app,
+        "hardwareId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getHardware({
+      $,
+      hardwareId: this.hardwareId,
+    });
+
+    $.export("$summary", `Successfully retrieved hardware asset details with ID \`${response.id}\``);
+    return response;
+  },
+};

package/actions/get-license/get-license.mjs

@@ -0,0 +1,37 @@
+import app from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-get-license",
+  name: "Get License",
+  description: "Retrieves license details including seat count, expiration, and current usage metrics. Note: The response returns 'product_key' but uses 'serial' field for POST/PUT/PATCH requests. [See the documentation](https://snipe-it.readme.io/reference/licensesid)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    licenseId: {
+      propDefinition: [
+        app,
+        "licenseId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      licenseId,
+    } = this;
+
+    const response = await app.getLicense({
+      $,
+      licenseId,
+    });
+
+    $.export("$summary", `Successfully retrieved license with ID \`${response.id}\``);
+    return response;
+  },
+};

package/actions/get-user-assets/get-user-assets.mjs

@@ -0,0 +1,37 @@
+import app from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-get-user-assets",
+  name: "Get User Assets",
+  description: "Retrieves all assets currently assigned to a specific user. Useful for audits and inventory reviews. [See the documentation](https://snipe-it.readme.io/reference/usersidassets)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      userId,
+    } = this;
+
+    const response = await app.getUserAssets({
+      $,
+      userId,
+    });
+
+    $.export("$summary", `Successfully retrieved \`${response.rows.length}\` assets for user ID \`${userId}\``);
+    return response;
+  },
+};

package/actions/list-company-id-options/list-company-id-options.mjs

@@ -0,0 +1,33 @@
+import snipe_it from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-list-company-id-options",
+  name: "List Company Options",
+  description: "Retrieves available options for the Company field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    snipe_it,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await snipe_it.propDefinitions.companyId.options.call(this.snipe_it, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-department-id-options/list-department-id-options.mjs

@@ -0,0 +1,33 @@
+import snipe_it from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-list-department-id-options",
+  name: "List Department Options",
+  description: "Retrieves available options for the Department field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    snipe_it,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await snipe_it.propDefinitions.departmentId.options.call(this.snipe_it, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-group-ids-options/list-group-ids-options.mjs

@@ -0,0 +1,33 @@
+import snipe_it from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-list-group-ids-options",
+  name: "List Groups Options",
+  description: "Retrieves available options for the Groups field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    snipe_it,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await snipe_it.propDefinitions.groupIds.options.call(this.snipe_it, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-hardware-id-options/list-hardware-id-options.mjs

@@ -0,0 +1,33 @@
+import snipe_it from "../../snipe_it.app.mjs";
+
+export default {
+  key: "snipe_it-list-hardware-id-options",
+  name: "List Hardware Asset Options",
+  description: "Retrieves available options for the Hardware Asset field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    snipe_it,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await snipe_it.propDefinitions.hardwareId.options.call(this.snipe_it, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};