mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 00:24:07 -08:00
549 lines
17 KiB
TypeScript
549 lines
17 KiB
TypeScript
import { IExecuteFunctions } from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
NodeApiError,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import { couponFields, couponOperations } from './CouponDescription';
|
|
|
|
import { paddleApiRequest, paddleApiRequestAllItems, validateJSON } from './GenericFunctions';
|
|
|
|
import { paymentFields, paymentOperations } from './PaymentDescription';
|
|
|
|
import { planFields, planOperations } from './PlanDescription';
|
|
|
|
import { productFields, productOperations } from './ProductDescription';
|
|
|
|
import { userFields, userOperations } from './UserDescription';
|
|
|
|
// import {
|
|
// orderOperations,
|
|
// orderFields,
|
|
// } from './OrderDescription';
|
|
|
|
import moment from 'moment';
|
|
|
|
export class Paddle implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'Paddle',
|
|
name: 'paddle',
|
|
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
|
|
icon: 'file:paddle.png',
|
|
group: ['output'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume Paddle API',
|
|
defaults: {
|
|
name: 'Paddle',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'paddleApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Coupon',
|
|
value: 'coupon',
|
|
},
|
|
{
|
|
name: 'Payment',
|
|
value: 'payment',
|
|
},
|
|
{
|
|
name: 'Plan',
|
|
value: 'plan',
|
|
},
|
|
{
|
|
name: 'Product',
|
|
value: 'product',
|
|
},
|
|
// {
|
|
// name: 'Order',
|
|
// value: 'order',
|
|
// },
|
|
{
|
|
name: 'User',
|
|
value: 'user',
|
|
},
|
|
],
|
|
default: 'coupon',
|
|
},
|
|
// COUPON
|
|
...couponOperations,
|
|
...couponFields,
|
|
// PAYMENT
|
|
...paymentOperations,
|
|
...paymentFields,
|
|
// PLAN
|
|
...planOperations,
|
|
...planFields,
|
|
// PRODUCT
|
|
...productOperations,
|
|
...productFields,
|
|
// ORDER
|
|
// ...orderOperations,
|
|
// ...orderFields,
|
|
// USER
|
|
...userOperations,
|
|
...userFields,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
/* -------------------------------------------------------------------------- */
|
|
/* PAYMENT */
|
|
/* -------------------------------------------------------------------------- */
|
|
|
|
// Get all payment so they can be selected in payment rescheduling
|
|
async getPayments(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const endpoint = '/2.0/subscription/payments';
|
|
const paymentResponse = await paddleApiRequest.call(this, endpoint, 'POST', {});
|
|
|
|
// Alert user if there's no payments present to be loaded into payments property
|
|
if (paymentResponse.response === undefined || paymentResponse.response.length === 0) {
|
|
throw new NodeApiError(this.getNode(), paymentResponse, {
|
|
message: 'No payments on account.',
|
|
});
|
|
}
|
|
|
|
for (const payment of paymentResponse.response) {
|
|
const id = payment.id;
|
|
returnData.push({
|
|
name: id,
|
|
value: id,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
|
|
/* -------------------------------------------------------------------------- */
|
|
/* PRODUCTS */
|
|
/* -------------------------------------------------------------------------- */
|
|
|
|
// Get all Products so they can be selected in coupon creation when assigning products
|
|
async getProducts(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const endpoint = '/2.0/product/get_products';
|
|
const products = await paddleApiRequest.call(this, endpoint, 'POST', {});
|
|
|
|
// Alert user if there's no products present to be loaded into payments property
|
|
if (products.length === 0) {
|
|
throw new NodeOperationError(this.getNode(), 'No products on account.');
|
|
}
|
|
|
|
for (const product of products) {
|
|
const name = product.name;
|
|
const id = product.id;
|
|
returnData.push({
|
|
name,
|
|
value: id,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: INodeExecutionData[] = [];
|
|
const length = items.length;
|
|
let responseData;
|
|
const body: IDataObject = {};
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
if (resource === 'coupon') {
|
|
if (operation === 'create') {
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter(
|
|
'additionalFieldsJson',
|
|
i,
|
|
) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
} else {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
'Additional fields must be a valid JSON',
|
|
{ itemIndex: i },
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
const discountType = this.getNodeParameter('discountType', i) as string;
|
|
const couponType = this.getNodeParameter('couponType', i) as string;
|
|
const discountAmount = this.getNodeParameter('discountAmount', i) as number;
|
|
|
|
if (couponType === 'product') {
|
|
body.product_ids = this.getNodeParameter('productIds', i) as string;
|
|
}
|
|
|
|
if (discountType === 'flat') {
|
|
body.currency = this.getNodeParameter('currency', i) as string;
|
|
}
|
|
|
|
body.coupon_type = couponType;
|
|
body.discount_type = discountType;
|
|
body.discount_amount = discountAmount;
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
if (additionalFields.allowedUses) {
|
|
body.allowed_uses = additionalFields.allowedUses as number;
|
|
}
|
|
if (additionalFields.couponCode) {
|
|
body.coupon_code = additionalFields.couponCode as string;
|
|
}
|
|
if (additionalFields.couponPrefix) {
|
|
body.coupon_prefix = additionalFields.couponPrefix as string;
|
|
}
|
|
if (additionalFields.expires) {
|
|
body.expires = moment(additionalFields.expires as Date).format(
|
|
'YYYY-MM-DD',
|
|
) as string;
|
|
}
|
|
if (additionalFields.group) {
|
|
body.group = additionalFields.group as string;
|
|
}
|
|
if (additionalFields.recurring) {
|
|
body.recurring = 1;
|
|
} else {
|
|
body.recurring = 0;
|
|
}
|
|
if (additionalFields.numberOfCoupons) {
|
|
body.num_coupons = additionalFields.numberOfCoupons as number;
|
|
}
|
|
if (additionalFields.description) {
|
|
body.description = additionalFields.description as string;
|
|
}
|
|
|
|
const endpoint = '/2.1/product/create_coupon';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
responseData = responseData.response.coupon_codes.map((coupon: string) => ({
|
|
coupon,
|
|
}));
|
|
}
|
|
}
|
|
|
|
if (operation === 'getAll') {
|
|
const productId = this.getNodeParameter('productId', i) as string;
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
const endpoint = '/2.0/product/list_coupons';
|
|
|
|
body.product_id = productId as string;
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
|
|
if (returnAll) {
|
|
responseData = responseData.response;
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i) as number;
|
|
responseData = responseData.response.splice(0, limit);
|
|
}
|
|
}
|
|
|
|
if (operation === 'update') {
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter(
|
|
'additionalFieldsJson',
|
|
i,
|
|
) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
} else {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
'Additional fields must be a valid JSON',
|
|
{ itemIndex: i },
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
const updateBy = this.getNodeParameter('updateBy', i) as string;
|
|
|
|
if (updateBy === 'group') {
|
|
body.group = this.getNodeParameter('group', i) as string;
|
|
} else {
|
|
body.coupon_code = this.getNodeParameter('couponCode', i) as string;
|
|
}
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
if (additionalFields.allowedUses) {
|
|
body.allowed_uses = additionalFields.allowedUses as number;
|
|
}
|
|
if (additionalFields.currency) {
|
|
body.currency = additionalFields.currency as string;
|
|
}
|
|
if (additionalFields.newCouponCode) {
|
|
body.new_coupon_code = additionalFields.newCouponCode as string;
|
|
}
|
|
if (additionalFields.expires) {
|
|
body.expires = moment(additionalFields.expires as Date).format(
|
|
'YYYY-MM-DD',
|
|
) as string;
|
|
}
|
|
if (additionalFields.newGroup) {
|
|
body.new_group = additionalFields.newGroup as string;
|
|
}
|
|
if (additionalFields.recurring === true) {
|
|
body.recurring = 1;
|
|
} else if (additionalFields.recurring === false) {
|
|
body.recurring = 0;
|
|
}
|
|
if (additionalFields.productIds) {
|
|
body.product_ids = additionalFields.productIds as number;
|
|
}
|
|
if (additionalFields.discountAmount) {
|
|
body.discount_amount = additionalFields.discountAmount as number;
|
|
}
|
|
if (additionalFields.discount) {
|
|
//@ts-ignore
|
|
if (additionalFields.discount.discountProperties.discountType === 'percentage') {
|
|
// @ts-ignore
|
|
body.discount_amount = additionalFields.discount.discountProperties
|
|
.discountAmount as number;
|
|
} else {
|
|
//@ts-ignore
|
|
body.currency = additionalFields.discount.discountProperties.currency as string;
|
|
//@ts-ignore
|
|
body.discount_amount = additionalFields.discount.discountProperties
|
|
.discountAmount as number;
|
|
}
|
|
}
|
|
}
|
|
|
|
const endpoint = '/2.1/product/update_coupon';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
responseData = responseData.response;
|
|
}
|
|
}
|
|
if (resource === 'payment') {
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter(
|
|
'additionalFieldsJson',
|
|
i,
|
|
) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
} else {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
'Additional fields must be a valid JSON',
|
|
{ itemIndex: i },
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
if (additionalFields.subscriptionId) {
|
|
body.subscription_id = additionalFields.subscriptionId as number;
|
|
}
|
|
if (additionalFields.plan) {
|
|
body.plan = additionalFields.plan as string;
|
|
}
|
|
if (additionalFields.state) {
|
|
body.state = additionalFields.state as string;
|
|
}
|
|
if (additionalFields.isPaid) {
|
|
body.is_paid = 1;
|
|
} else {
|
|
body.is_paid = 0;
|
|
}
|
|
if (additionalFields.from) {
|
|
body.from = moment(additionalFields.from as Date).format('YYYY-MM-DD') as string;
|
|
}
|
|
if (additionalFields.to) {
|
|
body.to = moment(additionalFields.to as Date).format('YYYY-MM-DD') as string;
|
|
}
|
|
if (additionalFields.isOneOffCharge) {
|
|
body.is_one_off_charge = additionalFields.isOneOffCharge as boolean;
|
|
}
|
|
}
|
|
const endpoint = '/2.0/subscription/payments';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
|
|
if (returnAll) {
|
|
responseData = responseData.response;
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i) as number;
|
|
responseData = responseData.response.splice(0, limit);
|
|
}
|
|
}
|
|
if (operation === 'reschedule') {
|
|
const paymentId = this.getNodeParameter('paymentId', i) as number;
|
|
const date = this.getNodeParameter('date', i) as Date;
|
|
|
|
body.payment_id = paymentId;
|
|
body.date = body.to = moment(date as Date).format('YYYY-MM-DD') as string;
|
|
|
|
const endpoint = '/2.0/subscription/payments_reschedule';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
}
|
|
}
|
|
if (resource === 'plan') {
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
const endpoint = '/2.0/subscription/plans';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
|
|
if (returnAll) {
|
|
responseData = responseData.response;
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i) as number;
|
|
responseData = responseData.response.splice(0, limit);
|
|
}
|
|
}
|
|
if (operation === 'get') {
|
|
const planId = this.getNodeParameter('planId', i) as string;
|
|
|
|
body.plan = planId;
|
|
|
|
const endpoint = '/2.0/subscription/plans';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
responseData = responseData.response;
|
|
}
|
|
}
|
|
if (resource === 'product') {
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
const endpoint = '/2.0/product/get_products';
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
|
|
if (returnAll) {
|
|
responseData = responseData.response.products;
|
|
} else {
|
|
const limit = this.getNodeParameter('limit', i) as number;
|
|
responseData = responseData.response.products.splice(0, limit);
|
|
}
|
|
}
|
|
}
|
|
if (resource === 'order') {
|
|
if (operation === 'get') {
|
|
const endpoint = '/1.0/order';
|
|
const checkoutId = this.getNodeParameter('checkoutId', i) as string;
|
|
|
|
body.checkout_id = checkoutId;
|
|
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'GET', body);
|
|
}
|
|
}
|
|
if (resource === 'user') {
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
|
|
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
|
|
|
|
if (jsonParameters) {
|
|
const additionalFieldsJson = this.getNodeParameter(
|
|
'additionalFieldsJson',
|
|
i,
|
|
) as string;
|
|
|
|
if (additionalFieldsJson !== '') {
|
|
if (validateJSON(additionalFieldsJson) !== undefined) {
|
|
Object.assign(body, JSON.parse(additionalFieldsJson));
|
|
} else {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
'Additional fields must be a valid JSON',
|
|
{ itemIndex: i },
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
if (additionalFields.state) {
|
|
body.state = additionalFields.state as string;
|
|
}
|
|
if (additionalFields.planId) {
|
|
body.plan_id = additionalFields.planId as string;
|
|
}
|
|
if (additionalFields.subscriptionId) {
|
|
body.subscription_id = additionalFields.subscriptionId as string;
|
|
}
|
|
}
|
|
|
|
const endpoint = '/2.0/subscription/users';
|
|
|
|
if (returnAll) {
|
|
responseData = await paddleApiRequestAllItems.call(
|
|
this,
|
|
'response',
|
|
endpoint,
|
|
'POST',
|
|
body,
|
|
);
|
|
} else {
|
|
body.results_per_page = this.getNodeParameter('limit', i) as number;
|
|
responseData = await paddleApiRequest.call(this, endpoint, 'POST', body);
|
|
responseData = responseData.response;
|
|
}
|
|
}
|
|
}
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionErrorData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionErrorData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
|
|
returnData.push(...executionData);
|
|
}
|
|
return this.prepareOutputData(returnData);
|
|
}
|
|
}
|