@pipedream/sendcloud/actions/validate-return/validate-return.mjs

Pipedream Sendcloud Components

import app from "../../sendcloud.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "sendcloud-validate-return",
  name: "Validate Return",
  description: "Validate a return. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/returns/operations/create-a-return-validate)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    fromAddress: {
      label: "From Address",
      propDefinition: [
        app,
        "addressSetup",
      ],
    },
    toAddress: {
      label: "To Address",
      propDefinition: [
        app,
        "addressSetup",
      ],
    },
    shipWith: {
      propDefinition: [
        app,
        "shipWith",
      ],
    },
    dimensionsLength: {
      propDefinition: [
        app,
        "dimensionsLength",
      ],
    },
    dimensionsWidth: {
      propDefinition: [
        app,
        "dimensionsWidth",
      ],
    },
    dimensionsHeight: {
      propDefinition: [
        app,
        "dimensionsHeight",
      ],
    },
    dimensionsUnit: {
      propDefinition: [
        app,
        "dimensionsUnit",
      ],
    },
    weightValue: {
      propDefinition: [
        app,
        "weightValue",
      ],
    },
    weightUnit: {
      propDefinition: [
        app,
        "weightUnit",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      fromAddress,
      toAddress,
      shipWith,
      dimensionsLength,
      dimensionsWidth,
      dimensionsHeight,
      dimensionsUnit,
      weightValue,
      weightUnit,
    } = this;

    const response = await app.validateReturn({
      $,
      data: {
        from_address: utils.parseJson(fromAddress),
        to_address: utils.parseJson(toAddress),
        ship_with: utils.parseJson(shipWith),
        ...(dimensionsLength
          && dimensionsWidth
          && dimensionsHeight
          && dimensionsUnit
          ? {
            dimensions: {
              length: dimensionsLength,
              width: dimensionsWidth,
              height: dimensionsHeight,
              unit: dimensionsUnit,
            },
          }
          : undefined
        ),
        ...(weightValue && weightUnit
          ? {
            weight: {
              value: weightValue,
              unit: weightUnit,
            },
          }
          : undefined
        ),
      },
    });

    $.export("$summary", "Successfully validated return payload");

    return response;
  },
};