n8n/packages/nodes-base/nodes/WhatsApp/MediaDescription.ts

185 lines
3.6 KiB
TypeScript
Raw Normal View History

import type { INodeProperties } from 'n8n-workflow';
feat(WhatsApp Business node): WhatsApp node (#3659) * feat: base structure for whatsapp node with credentials * feat: messages operation * feat: create generic api call with credentials and test first operation * fix: add missing template params * fix: language code for template * feat: media type and start of template components * fix: remove provider name from media type * lintfix * fix: format * feat: media operations w/o upload media type * :recycle: Convert WhatsApp Business node to declarative style * :bug: form data not being sent with boundary in header * :sparkles: add media operations to WhatsApp * :sparkles: add credentials test to WhatsApp credentials * :recycle: move preview url to optional collection in whatsapp message * :recycle: renamed media operations in whatsapp node * :refactor: move media file name to optional fields in whatsapp node * :sparkles: add upload from n8n for whatsapp node message resource * :fire: remove other template component types in whatsapp node * :speech_bubble: add specialised text for media types in WhatsApp node * :zap: Load dinamically phone number and template name * :zap: Add action property to all operations * :fire: Remove unnecessary imports * :zap: Use getBinaryDataBuffer helper * :zap: Add components property * :sparkles: send components for whatsapp templates and template language * :label: fix WhatsApp node message function types * :label: fix any in whatsapp message functions * :fire: remove unused import * :zap: Improvements * :zap: Add send location * :zap: Add send contact * :zap: Small improvement * :recycle: changes for review * :bug: fix presend error * :recycle: change lat/long to numbers with proper clamping * fix: bad merge * refactor: changes for review * update package-lock.json * update package.-lock.json * update Co-authored-by: cxgarcia <schlaubitzcristobal@gmail.com> Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
2022-09-29 17:17:46 -07:00
import { setupUpload } from './MediaFunctions';
export const mediaFields: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
noDataExpression: true,
type: 'options',
placeholder: '',
options: [
{
name: 'Upload',
value: 'mediaUpload',
action: 'Upload media',
},
{
name: 'Download',
value: 'mediaUrlGet',
action: 'Download media',
},
{
name: 'Delete',
value: 'mediaDelete',
action: 'Delete media',
},
],
default: 'mediaUpload',
displayOptions: {
show: {
resource: ['media'],
},
},
// eslint-disable-next-line n8n-nodes-base/node-param-description-weak
description: 'The operation to perform on the media',
},
];
export const mediaTypeFields: INodeProperties[] = [
// ----------------------------------
// operation: mediaUpload
// ----------------------------------
{
displayName: 'Sender Phone Number (or ID)',
name: 'phoneNumberId',
type: 'options',
typeOptions: {
loadOptions: {
routing: {
request: {
url: '={{$credentials.businessAccountId}}/phone_numbers',
method: 'GET',
},
output: {
postReceive: [
{
type: 'rootProperty',
properties: {
property: 'data',
},
},
{
type: 'setKeyValue',
properties: {
name: '={{$responseItem.display_phone_number}} - {{$responseItem.verified_name}}',
value: '={{$responseItem.id}}',
},
},
{
type: 'sort',
properties: {
key: 'name',
},
},
],
},
},
},
},
default: '',
placeholder: '',
routing: {
request: {
method: 'POST',
url: '={{$value}}/media',
},
},
displayOptions: {
show: {
operation: ['mediaUpload'],
resource: ['media'],
},
},
required: true,
description: "The ID of the business account's phone number to store the media",
},
{
displayName: 'Property Name',
name: 'mediaPropertyName',
type: 'string',
default: 'data',
displayOptions: {
show: {
operation: ['mediaUpload'],
resource: ['media'],
},
},
required: true,
description: 'Name of the binary property which contains the data for the file to be uploaded',
routing: {
send: {
preSend: [setupUpload],
},
},
},
// ----------------------------------
// type: mediaUrlGet
// ----------------------------------
{
displayName: 'Media ID',
name: 'mediaGetId',
type: 'string',
default: '',
displayOptions: {
show: {
operation: ['mediaUrlGet'],
resource: ['media'],
},
},
routing: {
request: {
method: 'GET',
url: '=/{{$value}}',
},
},
required: true,
description: 'The ID of the media',
},
// ----------------------------------
// type: mediaUrlGet
// ----------------------------------
{
displayName: 'Media ID',
name: 'mediaDeleteId',
type: 'string',
default: '',
displayOptions: {
show: {
operation: ['mediaDelete'],
resource: ['media'],
},
},
routing: {
request: {
method: 'DELETE',
url: '=/{{$value}}',
},
},
required: true,
description: 'The ID of the media',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['media'],
operation: ['mediaUpload'],
},
},
options: [
{
displayName: 'Filename',
name: 'mediaFileName',
type: 'string',
default: '',
description: 'The name to use for the file',
},
],
},
];