n8n/packages/nodes-base/nodes/Copper/descriptions/OpportunityDescription.ts

290 lines
5.2 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const opportunityOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
displayOptions: {
show: {
resource: [
'opportunity',
],
},
},
options: [
{
name: 'Create',
value: 'create',
action: 'Create an opportunity',
},
{
name: 'Delete',
value: 'delete',
action: 'Delete an opportunity',
},
{
name: 'Get',
value: 'get',
action: 'Get an opportunity',
},
{
name: 'Get All',
value: 'getAll',
action: 'Get all opportunities',
},
{
name: 'Update',
value: 'update',
action: 'Update an opportunity',
},
],
default: 'create',
},
];
export const opportunityFields: INodeProperties[] = [
// ----------------------------------------
// opportunity: create
// ----------------------------------------
{
displayName: 'Name',
name: 'name',
description: 'Name of the opportunity to create',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Customer Source ID',
name: 'customerSourceId',
type: 'string',
default: '',
description: 'ID of the customer source that generated this opportunity',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Primary Contact ID',
name: 'primaryContactId',
type: 'string',
default: '',
description: 'ID of the primary company associated with this opportunity',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'create',
],
},
},
},
// ----------------------------------------
// opportunity: delete
// ----------------------------------------
{
displayName: 'Opportunity ID',
name: 'opportunityId',
description: 'ID of the opportunity to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// opportunity: get
// ----------------------------------------
{
displayName: 'Opportunity ID',
name: 'opportunityId',
description: 'ID of the opportunity to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// opportunity: 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: [
'opportunity',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
{
displayName: 'Filters',
name: 'filterFields',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Company IDs',
name: 'company_ids',
type: 'string',
default: '',
description: 'Comma-separated IDs of the primary companies to filter by',
},
{
displayName: 'Customer Source IDs',
name: 'customer_source_ids',
type: 'string',
default: '',
description: 'Comma-separated IDs of the customer sources to filter by',
},
],
},
// ----------------------------------------
// opportunity: update
// ----------------------------------------
{
displayName: 'Opportunity ID',
name: 'opportunityId',
description: 'ID of the opportunity to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'opportunity',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Customer Source ID',
name: 'customer_source_id',
type: 'string',
default: '',
description: 'ID of the primary company associated with this opportunity',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name to set for the opportunity',
},
{
displayName: 'Primary Contact ID',
name: 'primary_contact_id',
type: 'string',
default: '',
description: 'ID of the customer source that generated this opportunity',
},
],
},
];