n8n/packages/nodes-base/nodes/QuickBooks/descriptions/Estimate/EstimateDescription.ts
Iván Ovejero 88dea330b9
refactor: Apply more eslint-plugin-n8n-nodes-base rules (#3534)
*  Update `lintfix` script

*  Run baseline `lintfix`

* 🔥 Remove unneeded exceptions (#3538)

* 🔥 Remove exceptions for `node-param-default-wrong-for-simplify`

* 🔥 Remove exceptions for `node-param-placeholder-miscased-id`

*  Update version

* 👕 Apply `node-param-placeholder-missing` (#3542)

* 👕 Apply `filesystem-wrong-cred-filename` (#3543)

* 👕 Apply `node-param-description-missing-from-dynamic-options` (#3545)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-class-description-empty-string` (#3546)

* 👕 Apply `node-class-description-icon-not-svg` (#3548)

* 👕 Apply `filesystem-wrong-node-filename` (#3549)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Expand lintings to credentials (#3550)

* 👕 Apply `node-param-multi-options-type-unsorted-items` (#3552)

*  fix

*  Minor fixes

Co-authored-by: Michael Kret <michael.k@radency.com>

* 👕 Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541)

*  Add new lint rule, node-param-description-wrong-for-dynamic-multi-options

*  Fix with updated linting rules

*  Minor fixes

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-description-boolean-without-whether` (#3553)

*  fix

* Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537)

* 👕 Add exceptions

* 👕 Add exception

* ✏️ Alphabetize rules

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00

438 lines
8 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
import {
estimateAdditionalFieldsOptions,
} from './EstimateAdditionalFieldsOptions';
export const estimateOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'get',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Send',
value: 'send',
},
{
name: 'Update',
value: 'update',
},
],
displayOptions: {
show: {
resource: [
'estimate',
],
},
},
},
];
export const estimateFields: INodeProperties[] = [
// ----------------------------------
// estimate: create
// ----------------------------------
{
displayName: 'For Customer Name or ID',
name: 'CustomerRef',
type: 'options',
required: true,
description: 'The ID of the customer who the estimate is for. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.',
default: [],
typeOptions: {
loadOptionsMethod: 'getCustomers',
},
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Line',
name: 'Line',
type: 'collection',
placeholder: 'Add Line Item Property',
description: 'Individual line item of a transaction',
typeOptions: {
multipleValues: true,
},
default: {},
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Amount',
name: 'Amount',
description: 'Monetary amount of the line item',
type: 'number',
default: 0,
},
{
displayName: 'Description',
name: 'Description',
description: 'Textual description of the line item',
type: 'string',
default: '',
typeOptions: {
alwaysOpenEditWindow: true,
},
},
{
displayName: 'Detail Type',
name: 'DetailType',
type: 'options',
default: 'SalesItemLineDetail',
options: [
{
name: 'Sales Item Line Detail',
value: 'SalesItemLineDetail',
},
],
},
{
displayName: 'Item Name or ID',
name: 'itemId',
type: 'options',
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
default: [],
typeOptions: {
loadOptionsMethod: 'getItems',
},
},
{
displayName: 'Position',
name: 'LineNum',
description: 'Position of the line item relative to others',
type: 'number',
default: 1,
},
{
displayName: 'Tax Code Ref Name or ID',
name: 'TaxCodeRef',
type: 'options',
description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>',
default: [],
typeOptions: {
loadOptionsMethod: 'getTaxCodeRefs',
},
},
],
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'create',
],
},
},
options: estimateAdditionalFieldsOptions,
},
// ----------------------------------
// estimate: delete
// ----------------------------------
{
displayName: 'Estimate ID',
name: 'estimateId',
type: 'string',
required: true,
default: '',
description: 'The ID of the estimate to delete',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------
// estimate: get
// ----------------------------------
{
displayName: 'Estimate ID',
name: 'estimateId',
type: 'string',
required: true,
default: '',
description: 'The ID of the estimate to retrieve',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Download',
name: 'download',
type: 'boolean',
required: true,
default: false,
description: 'Whether to download the estimate as a PDF file',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Binary Property',
name: 'binaryProperty',
type: 'string',
required: true,
default: 'data',
description: 'Name of the binary property to which to write to',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'get',
],
download: [
true,
],
},
},
},
{
displayName: 'File Name',
name: 'fileName',
type: 'string',
required: true,
default: '',
placeholder: 'data.pdf',
description: 'Name of the file that will be downloaded',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'get',
],
download: [
true,
],
},
},
},
// ----------------------------------
// estimate: 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: [
'estimate',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Query',
name: 'query',
type: 'string',
default: '',
placeholder: 'WHERE Metadata.LastUpdatedTime > \'2021-01-01\'',
description: 'The condition for selecting estimates. See the <a href="https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries">guide</a> for supported syntax.',
typeOptions: {
alwaysOpenEditWindow: true,
},
},
],
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'getAll',
],
},
},
},
// ----------------------------------
// estimate: send
// ----------------------------------
{
displayName: 'Estimate ID',
name: 'estimateId',
type: 'string',
required: true,
default: '',
description: 'The ID of the estimate to send',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'send',
],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
required: true,
default: '',
description: 'The email of the recipient of the estimate',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'send',
],
},
},
},
// ----------------------------------
// estimate: update
// ----------------------------------
{
displayName: 'Estimate ID',
name: 'estimateId',
type: 'string',
required: true,
default: '',
description: 'The ID of the estimate to update',
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
required: true,
displayOptions: {
show: {
resource: [
'estimate',
],
operation: [
'update',
],
},
},
// filter out fields that cannot be updated
options: estimateAdditionalFieldsOptions.filter(property => property.name !== 'TotalAmt' && property.name !== 'TotalTax'),
},
];