pipedream/components/paykickstart/actions/create-purchase/create-purchase.mjs at 4c7aefc03effefba5c483d11e2c31ebc8df1a379 · PipedreamHQ/pipedream · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
import app from "../../paykickstart.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "paykickstart-create-purchase",
  name: "Create Purchase",
  description: "Creates a new purchase transaction. [See the documentation](https://docs.paykickstart.com/)",
  version: "0.0.1",
  type: "action",
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  props: {
    app,
    product: {
      propDefinition: [
        app,
        "campaignId",
      ],
    },
    plan: {
      propDefinition: [
        app,
        "productId",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Buyer's first name",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Buyer's last name",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Buyer's email address",
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The quantity of the product being purchased. NOTE: The charge amount will be calculated by multiplying the price and quantity fields before adding tax, shipping etc. If the product's is `0` then don't set this field.",
      optional: true,
    },
    price: {
      type: "integer",
      label: "Price",
      description: "Override the product's price amount for this purchase. If this field is not set, the price from the product's settings is used.",
      optional: true,
    },
    isRecurring: {
      type: "boolean",
      label: "Is Recurring",
      description: "Enable a subscription-based product purchase. This field is not required unless you are setting up the purchase to be a subscription (see fields below).",
      optional: true,
    },
    recurringFreq: {
      type: "integer",
      label: "Recurring Frequency",
      description: "The number of **Recurring Frequency Type** units. If `2` and a **Recurring Frequency Type** is `months`, means the subscription will charge every 2 months. This field is required when **Is Recurring** is set.",
      optional: true,
    },
    recurringFreqType: {
      type: "string",
      label: "Recurring Frequency Type",
      description: "The recurring period for the recurring payment. This field is required when **Is Recurring** is set.",
      options: constants.FREQUENCY_TYPES,
      optional: true,
    },
    cycles: {
      type: "string",
      label: "Cycles",
      description: "The number of payments for your subscription. Set as null for an infinite subscription. This field is required when **Is Recurring** is set.",
      optional: true,
    },
    hasTrial: {
      type: "boolean",
      label: "Has Trial",
      description: "Enable trial period for the purchase. Please note this is only currently possible for recurring subscription products. This field is not required unless you which to create a trial period for your product.",
      optional: true,
    },
    trialAmount: {
      type: "string",
      label: "Trial Amount",
      description: "The initial amount to charge for the trial. Amount may be set to `0` for free trial. This field is not required unless you have **Has Trial** enabled.",
      optional: true,
    },
    trialDays: {
      type: "integer",
      label: "Trial Days",
      description: "The number of days before the subscription transactions begin. For example, if you want to set a 14 day free trial, make sure the product is set to recurring in its settings or via the API, then set **Trial Amoun** to `0` and **Trial Days** to `14`. This field is not required unless you have **Has Trial** enabled.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      product,
      plan,
      firstName,
      lastName,
      email,
      price,
      quantity,
      isRecurring,
      recurringFreq,
      recurringFreqType,
      cycles,
      hasTrial,
      trialAmount,
      trialDays,
    } = this;

    const response = await app.createPurchase({
      $,
      data: {
        product,
        plan,
        first_name: firstName,
        last_name: lastName,
        email,
        price,
        quantity,
        is_recurring: isRecurring,
        recurring_freq: recurringFreq,
        recurring_freq_type: recurringFreqType,
        cycles,
        has_trial: hasTrial,
        trial_amount: trialAmount,
        trial_days: trialDays,
      },
    });

    $.export("$summary", "Successfully created purchase");
    return response;
  },
};