n8n/packages/nodes-base/nodes/Stripe/descriptions/CouponDescription.ts

214 lines
3.5 KiB
TypeScript
Raw Normal View History

:sparkles: Add Stripe regular node (#1470) * :tada: Register node * :art: Add SVG icon * :zap: Add preliminary node stub * :zap: Add resource description stubs * :art: Fix SVG size and position * :zap: Implement charge operations * :zap: Implement customer operations * :art: Apply cosmetic changes * :zap: Fix customer address fields * :zap: Add stub and fields for invoice * :zap: Add invoice item stubs * :zap: Implement source operations * :zap: Reduce scope per feedback * :zap: Add continueOnFail functionality * :art: Prettify error thrown * :fire: Remove unused resource * :zap: Replace source in card with token * :hammer: Remove logging * :wrench: Fix shipping address in charge:create * :wrench: Load update fields for charge:update * :zap: Implement token:create to ease testing * :zap: Simplify card token fields * :zap: Update description parameters * :wrench: Fix field adjusters * :zap: Remove unused source options * :wrench: Fix shipping fields adjuster * :fire: Remove PNG icon * :fire: Remove logging * :hammer: Reorder address fields * :bug: Fix shipping field in charge:update * :lipstick: Apply cosmetic change * :zap: Small improvements * :zap: Fix lintings in main file * :zap: Lint all descriptions * :zap: Add target="_blank" attribute * :zap: Fix various lintings for charge * :zap: Fix lintings for coupon * :zap: Fix lintings for customer * :zap: Fix lintings for source * :zap: Fix lintings for token * :zap: Reorder address fields * :zap: Fix casing in credentials * :hammer: Place recipient name above address in shipping * :zap: Remove references to string in descriptions * :zap: Apply minor renamings * :fire: Remove logging * :hammer: Simplify error handling * :zap: Fix indentation * :zap: Move cardFields to root level for Token creation Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-07-10 04:15:14 -07:00
import {
INodeProperties,
} from 'n8n-workflow';
export const couponOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'create',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
description: 'Create a coupon',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all coupons',
},
],
displayOptions: {
show: {
resource: [
'coupon',
],
},
},
},
] as INodeProperties[];
export const couponFields = [
// ----------------------------------
// coupon: create
// ----------------------------------
{
displayName: 'Apply',
name: 'duration',
type: 'options',
required: true,
default: 'once',
description: 'How long the discount will be in effect',
options: [
{
name: 'Forever',
value: 'forever',
},
{
name: 'Once',
value: 'once',
},
],
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Discount Type',
name: 'type',
type: 'options',
required: true,
default: 'percent',
description: 'Whether the coupon discount is a percentage or a fixed amount',
options: [
{
name: 'Fixed Amount (in Cents)',
value: 'fixedAmount',
},
{
name: 'Percent',
value: 'percent',
},
],
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Amount Off',
name: 'amountOff',
type: 'number',
required: true,
default: 0,
description: 'Amount in cents to subtract from an invoice total, e.g. enter <code>100</code> for $1.00',
typeOptions: {
minValue: 0,
maxValue: 99999999,
},
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'create',
],
type: [
'fixedAmount',
],
},
},
},
{
displayName: 'Currency',
name: 'currency',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getCurrencies',
},
required: true,
default: '',
description: 'Three-letter ISO currency code, e.g. <code>USD</code> or <code>EUR</code>. It must be a <a target="_blank" href="https://stripe.com/docs/currencies">Stripe-supported currency</a>',
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'create',
],
type: [
'fixedAmount',
],
},
},
},
{
displayName: 'Percent Off',
name: 'percentOff',
type: 'number',
required: true,
default: 1,
description: 'Percentage to apply with the coupon',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'create',
],
type: [
'percent',
],
},
},
},
// ----------------------------------
// coupon: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'How many results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'coupon',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
] as INodeProperties[];