Add create-draft-credential, create-group, issue-existing-draft-credential, send-credential actions for Certifier

Author: mariczne

components/certifier/actions/create-draft-credential/create-draft-credential.mjs

@@ -0,0 +1,107 @@
+import certifier from "../../certifier.app.mjs";
+
+export default {
+  name: "Create Draft Credential",
+  version: "0.0.1",
+  key: "certifier-create-draft-credential",
+  description:
+    "Create a draft credential. [See the documentation](https://developers.certifier.io/reference/create-a-credential)",
+  props: {
+    certifier,
+    groupId: {
+      propDefinition: [
+        certifier,
+        "groupId",
+      ],
+      // reloadProps is used so that customAttributes can be loaded
+      // However, note that in the Certifier app custom attributes
+      // are defined on a workspace level, not group
+      reloadProps: true,
+    },
+    recipientName: {
+      propDefinition: [
+        certifier,
+        "recipientName",
+      ],
+    },
+    recipientEmail: {
+      propDefinition: [
+        certifier,
+        "recipientEmail",
+      ],
+    },
+    issueDate: {
+      propDefinition: [
+        certifier,
+        "issueDate",
+      ],
+    },
+    expiryDate: {
+      propDefinition: [
+        certifier,
+        "expiryDate",
+      ],
+    },
+  },
+  async additionalProps() {
+    const attributes = await this.certifier.searchAttributes();
+    return attributes
+      .filter((attribute) => !attribute.isDefault)
+      .reduce(
+        (acc, attribute) => ({
+          ...acc,
+          [attribute.tag]: {
+            type: "string",
+            label: `Custom Attribute: ${attribute.name}`,
+            optional: true,
+          },
+        }),
+        {},
+      );
+  },
+  type: "action",
+  methods: {},
+  async run({ $ }) {
+    const {
+      certifier,
+      groupId,
+      recipientName,
+      recipientEmail,
+      issueDate,
+      expiryDate,
+    } = this;
+
+    const customAttributes = Object.fromEntries(
+      Object.entries(this).filter(([
+        key,
+      ]) => key.startsWith("custom.")),
+    );
+
+    const response = await certifier.createCredential({
+      $,
+      data: {
+        groupId: groupId,
+        recipient: {
+          email: recipientEmail,
+          name: recipientName,
+        },
+        customAttributes,
+        ...(issueDate && {
+          issueDate,
+        }),
+        ...(expiryDate && {
+          expiryDate,
+        }),
+      },
+    });
+
+    console.log(`Successfully created credential with ID \`${response.id}\`.`);
+
+    $.export(
+      "$summary",
+      `Successfully created credential for ${response.recipient.name}`,
+    );
+
+    return response;
+  },
+};

components/certifier/actions/create-group/create-group.mjs

@@ -0,0 +1,71 @@
+import certifier from "../../certifier.app.mjs";
+
+export default {
+  name: "Create Group",
+  version: "0.0.1",
+  key: "certifier-create-group",
+  description:
+    "Create a group. [See the documentation](https://developers.certifier.io/reference/create-a-group)",
+  props: {
+    certifier,
+    name: {
+      propDefinition: [
+        certifier,
+        "groupName",
+      ],
+    },
+    certificateDesignId: {
+      propDefinition: [
+        certifier,
+        "certificateDesignId",
+      ],
+    },
+    badgeDesignId: {
+      propDefinition: [
+        certifier,
+        "badgeDesignId",
+      ],
+    },
+    learningEventUrl: {
+      propDefinition: [
+        certifier,
+        "learningEventUrl",
+      ],
+    },
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
+    alert: {
+      type: "alert",
+      alertType: "warning",
+      content:
+        "At least one of `Certificate Design` and `Badge Design` fields is required.",
+    },
+  },
+  type: "action",
+  methods: {},
+  async run({ $ }) {
+    const {
+      certifier,
+      name,
+      certificateDesignId,
+      badgeDesignId,
+      learningEventUrl,
+    } = this;
+
+    const response = await certifier.createGroup({
+      $,
+      data: {
+        name,
+        certificateDesignId,
+        badgeDesignId,
+        learningEventUrl,
+      },
+    });
+
+    $.export(
+      "$summary",
+      `Successfully created group ${response.name}`,
+    );
+
+    return response;
+  },
+};

components/certifier/actions/issue-existing-draft-credential/issue-existing-draft-credential.mjs

@@ -0,0 +1,37 @@
+import certifier from "../../certifier.app.mjs";
+
+export default {
+  name: "Issue Existing Draft Credential",
+  version: "0.0.1",
+  key: "certifier-issue-existing-draft-credential",
+  description:
+    "Issue an existing draft credential. [See the documentation](https://developers.certifier.io/reference/issue-a-credential)",
+  props: {
+    certifier,
+    credentialId: {
+      propDefinition: [
+        certifier,
+        "credentialId",
+      ],
+    },
+  },
+  type: "action",
+  methods: {},
+  async run({ $ }) {
+    const {
+      certifier, credentialId,
+    } = this;
+
+    const response = await certifier.issueCredential(credentialId, {
+      $,
+    });
+    console.log(`Successfully issued credential with ID \`${response.id}\`.`);
+
+    $.export(
+      "$summary",
+      `Successfully issued credential for ${response.recipient.name}`,
+    );
+
+    return response;
+  },
+};

components/certifier/actions/send-credential/send-credential.mjs

@@ -0,0 +1,40 @@
+import certifier from "../../certifier.app.mjs";
+
+export default {
+  name: "Send Credential",
+  version: "0.0.1",
+  key: "certifier-send-credential",
+  description:
+    "Send an existing credential. [See the documentation](https://developers.certifier.io/reference/send-a-credential)",
+  props: {
+    certifier,
+    credentialId: {
+      propDefinition: [
+        certifier,
+        "credentialId",
+      ],
+    },
+  },
+  type: "action",
+  methods: {},
+  async run({ $ }) {
+    const {
+      certifier, credentialId,
+    } = this;
+
+    const response = await certifier.sendCredential(credentialId, {
+      $,
+      data: {
+        deliveryMethod: "email",
+      },
+    });
+    console.log(`Successfully sent credential with ID \`${response.id}\`.`);
+
+    $.export(
+      "$summary",
+      `Successfully sent credential for ${response.recipient.name}`,
+    );
+
+    return response;
+  },
+};

components/certifier/certifier.app.mjs

@@ -36,6 +36,12 @@ export default {
         ...args,
       });
     },
+    searchDesigns(args = {}) {
+      return this.callApi({
+        path: "/designs",
+        ...args,
+      });
+    },
     createCredential(args = {}) {
       return this.callApi({
         method: "POST",
@@ -57,6 +63,13 @@ export default {
         ...args,
       });
     },
+    createGroup(args = {}) {
+      return this.callApi({
+        method: "POST",
+        path: "/groups",
+        ...args,
+      });
+    },
   },
   propDefinitions: {
     groupId: {
@@ -121,5 +134,82 @@ export default {
         "The date (in `YYYY-MM-DD` format) of your credential's expiration. If not provided, expiry date from the group settings will be used (by default this field is empty).",
       optional: true,
     },
+    groupName: {
+      type: "string",
+      label: "Group Name",
+      description:
+        "The group's name that is used as [group.name] attribute later on.",
+    },
+    certificateDesignId: {
+      type: "string",
+      label: "Certificate Design",
+      description: "The unique certificate design's name.",
+      optional: true,
+      async options({ prevContext } = {}) {
+        const response = await this.searchDesigns({
+          params: {
+            cursor: prevContext.cursor,
+          },
+        });
+        const designs = response.data;
+        const cursor = response.pagination.next;
+
+        return {
+          options: designs
+            .filter((design) => design.type === "certificate")
+            .map(({
+              id, name,
+            }) => ({
+              label: name,
+              value: id,
+            })),
+          context: {
+            cursor,
+          },
+        };
+      },
+    },
+    badgeDesignId: {
+      type: "string",
+      label: "Badge Design",
+      description: "The unique badge design's name.",
+      optional: true,
+      async options({ prevContext } = {}) {
+        const response = await this.searchDesigns({
+          params: {
+            cursor: prevContext.cursor,
+          },
+        });
+        const designs = response.data;
+        const cursor = response.pagination.next;
+
+        return {
+          options: designs
+            .filter((design) => design.type === "badge")
+            .map(({
+              id, name,
+            }) => ({
+              label: name,
+              value: id,
+            })),
+          context: {
+            cursor,
+          },
+        };
+      },
+    },
+    learningEventUrl: {
+      type: "string",
+      label: "Learning Event URL",
+      description:
+        "The learning event's URL that is shown in the digital wallet.",
+      optional: true,
+    },
+    credentialId: {
+      type: "string",
+      label: "Credential ID",
+      description:
+        "The credential's unique ID.",
+    },
   },
 };